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, 1282a1b02bcSTejun Heo WORKER_ID_LEN = 10 + WQ_NAME_LEN, /* "kworker/R-" + WQ_NAME_LEN */ 129c8e55f36STejun Heo }; 130c8e55f36STejun Heo 1311da177e4SLinus Torvalds /* 1324cb1ef64STejun Heo * We don't want to trap softirq for too long. See MAX_SOFTIRQ_TIME and 1334cb1ef64STejun Heo * MAX_SOFTIRQ_RESTART in kernel/softirq.c. These are macros because 1344cb1ef64STejun Heo * msecs_to_jiffies() can't be an initializer. 1354cb1ef64STejun Heo */ 1364cb1ef64STejun Heo #define BH_WORKER_JIFFIES msecs_to_jiffies(2) 1374cb1ef64STejun Heo #define BH_WORKER_RESTARTS 10 1384cb1ef64STejun Heo 1394cb1ef64STejun Heo /* 1404690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1414690c4abSTejun Heo * 142e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 143e41e704bSTejun Heo * everyone else. 1444690c4abSTejun Heo * 145e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 146e22bee78STejun Heo * only be modified and accessed from the local cpu. 147e22bee78STejun Heo * 148d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1494690c4abSTejun Heo * 1505797b1c1STejun Heo * LN: pool->lock and wq_node_nr_active->lock protected for writes. Either for 1515797b1c1STejun Heo * reads. 1525797b1c1STejun Heo * 153bdf8b9bfSTejun Heo * K: Only modified by worker while holding pool->lock. Can be safely read by 154bdf8b9bfSTejun Heo * self, while holding pool->lock or from IRQ context if %current is the 155bdf8b9bfSTejun Heo * kworker. 156bdf8b9bfSTejun Heo * 157bdf8b9bfSTejun Heo * S: Only modified by worker self. 158bdf8b9bfSTejun Heo * 1591258fae7STejun Heo * A: wq_pool_attach_mutex protected. 160822d8405STejun Heo * 16168e13a67SLai Jiangshan * PL: wq_pool_mutex protected. 16276af4d93STejun Heo * 16324acfb71SThomas Gleixner * PR: wq_pool_mutex protected for writes. RCU protected for reads. 1645bcab335STejun Heo * 1655b95e1afSLai Jiangshan * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads. 1665b95e1afSLai Jiangshan * 1675b95e1afSLai Jiangshan * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or 16824acfb71SThomas Gleixner * RCU for reads. 1695b95e1afSLai Jiangshan * 1703c25a55dSLai Jiangshan * WQ: wq->mutex protected. 1713c25a55dSLai Jiangshan * 17224acfb71SThomas Gleixner * WR: wq->mutex protected for writes. RCU protected for reads. 1732e109a28STejun Heo * 174a045a272STejun Heo * WO: wq->mutex protected for writes. Updated with WRITE_ONCE() and can be read 175a045a272STejun Heo * with READ_ONCE() without locking. 176a045a272STejun Heo * 1772e109a28STejun Heo * MD: wq_mayday_lock protected. 178cd2440d6SPetr Mladek * 179cd2440d6SPetr Mladek * WD: Used internally by the watchdog. 1804690c4abSTejun Heo */ 1814690c4abSTejun Heo 1822eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 183c34056a3STejun Heo 184bd7bdd43STejun Heo struct worker_pool { 185a9b8a985SSebastian Andrzej Siewior raw_spinlock_t lock; /* the pool lock */ 186d84ff051STejun Heo int cpu; /* I: the associated cpu */ 187f3f90ad4STejun Heo int node; /* I: the associated node ID */ 1889daf9e67STejun Heo int id; /* I: pool ID */ 189bc8b50c2STejun Heo unsigned int flags; /* L: flags */ 190bd7bdd43STejun Heo 19182607adcSTejun Heo unsigned long watchdog_ts; /* L: watchdog timestamp */ 192cd2440d6SPetr Mladek bool cpu_stall; /* WD: stalled cpu bound pool */ 19382607adcSTejun Heo 194bc35f7efSLai Jiangshan /* 195bc35f7efSLai Jiangshan * The counter is incremented in a process context on the associated CPU 196bc35f7efSLai Jiangshan * w/ preemption disabled, and decremented or reset in the same context 197bc35f7efSLai Jiangshan * but w/ pool->lock held. The readers grab pool->lock and are 198bc35f7efSLai Jiangshan * guaranteed to see if the counter reached zero. 199bc35f7efSLai Jiangshan */ 200bc35f7efSLai Jiangshan int nr_running; 20184f91c62SLai Jiangshan 202bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 203ea1abd61SLai Jiangshan 2045826cc8fSLai Jiangshan int nr_workers; /* L: total number of workers */ 2055826cc8fSLai Jiangshan int nr_idle; /* L: currently idle workers */ 206bd7bdd43STejun Heo 2072c1f1a91SLai Jiangshan struct list_head idle_list; /* L: list of idle workers */ 208bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 2093f959aa3SValentin Schneider struct work_struct idle_cull_work; /* L: worker idle cleanup */ 2103f959aa3SValentin Schneider 211bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 212bd7bdd43STejun Heo 213c5aa87bbSTejun Heo /* a workers is either on busy_hash or idle_list, or the manager */ 214c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 215c9e7cf27STejun Heo /* L: hash of busy workers */ 216c9e7cf27STejun Heo 2172607d7a6STejun Heo struct worker *manager; /* L: purely informational */ 21892f9c5c4SLai Jiangshan struct list_head workers; /* A: attached workers */ 219e19e397aSTejun Heo 2207cda9aaeSLai Jiangshan struct ida worker_ida; /* worker IDs for task name */ 221e19e397aSTejun Heo 2227a4e344cSTejun Heo struct workqueue_attrs *attrs; /* I: worker attributes */ 22368e13a67SLai Jiangshan struct hlist_node hash_node; /* PL: unbound_pool_hash node */ 22468e13a67SLai Jiangshan int refcnt; /* PL: refcnt for unbound pools */ 2257a4e344cSTejun Heo 226e19e397aSTejun Heo /* 22724acfb71SThomas Gleixner * Destruction of pool is RCU protected to allow dereferences 22829c91e99STejun Heo * from get_work_pool(). 22929c91e99STejun Heo */ 23029c91e99STejun Heo struct rcu_head rcu; 23184f91c62SLai Jiangshan }; 2328b03ae3cSTejun Heo 2338b03ae3cSTejun Heo /* 234725e8ec5STejun Heo * Per-pool_workqueue statistics. These can be monitored using 235725e8ec5STejun Heo * tools/workqueue/wq_monitor.py. 236725e8ec5STejun Heo */ 237725e8ec5STejun Heo enum pool_workqueue_stats { 238725e8ec5STejun Heo PWQ_STAT_STARTED, /* work items started execution */ 239725e8ec5STejun Heo PWQ_STAT_COMPLETED, /* work items completed execution */ 2408a1dd1e5STejun Heo PWQ_STAT_CPU_TIME, /* total CPU time consumed */ 241616db877STejun Heo PWQ_STAT_CPU_INTENSIVE, /* wq_cpu_intensive_thresh_us violations */ 242725e8ec5STejun Heo PWQ_STAT_CM_WAKEUP, /* concurrency-management worker wakeups */ 2438639ecebSTejun Heo PWQ_STAT_REPATRIATED, /* unbound workers brought back into scope */ 244725e8ec5STejun Heo PWQ_STAT_MAYDAY, /* maydays to rescuer */ 245725e8ec5STejun Heo PWQ_STAT_RESCUED, /* linked work items executed by rescuer */ 246725e8ec5STejun Heo 247725e8ec5STejun Heo PWQ_NR_STATS, 248725e8ec5STejun Heo }; 249725e8ec5STejun Heo 250725e8ec5STejun Heo /* 251e9a8e01fSTejun Heo * The per-pool workqueue. While queued, bits below WORK_PWQ_SHIFT 252112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 253112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 254112202d9STejun Heo * number of flag bits. 2551da177e4SLinus Torvalds */ 256112202d9STejun Heo struct pool_workqueue { 257bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 2584690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 25973f53c4aSTejun Heo int work_color; /* L: current color */ 26073f53c4aSTejun Heo int flush_color; /* L: flushing color */ 2618864b4e5STejun Heo int refcnt; /* L: reference count */ 26273f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 26373f53c4aSTejun Heo /* L: nr of in_flight works */ 2644c065dbcSWaiman Long bool plugged; /* L: execution suspended */ 265018f3a13SLai Jiangshan 266018f3a13SLai Jiangshan /* 267018f3a13SLai Jiangshan * nr_active management and WORK_STRUCT_INACTIVE: 268018f3a13SLai Jiangshan * 269018f3a13SLai Jiangshan * When pwq->nr_active >= max_active, new work item is queued to 270018f3a13SLai Jiangshan * pwq->inactive_works instead of pool->worklist and marked with 271018f3a13SLai Jiangshan * WORK_STRUCT_INACTIVE. 272018f3a13SLai Jiangshan * 2735797b1c1STejun Heo * All work items marked with WORK_STRUCT_INACTIVE do not participate in 2745797b1c1STejun Heo * nr_active and all work items in pwq->inactive_works are marked with 2755797b1c1STejun Heo * WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE work items are 2765797b1c1STejun Heo * in pwq->inactive_works. Some of them are ready to run in 2775797b1c1STejun Heo * pool->worklist or worker->scheduled. Those work itmes are only struct 2785797b1c1STejun Heo * wq_barrier which is used for flush_work() and should not participate 2795797b1c1STejun Heo * in nr_active. For non-barrier work item, it is marked with 2805797b1c1STejun Heo * WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works. 281018f3a13SLai Jiangshan */ 2821e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 283f97a4a1aSLai Jiangshan struct list_head inactive_works; /* L: inactive works */ 2845797b1c1STejun Heo struct list_head pending_node; /* LN: node on wq_node_nr_active->pending_pwqs */ 2853c25a55dSLai Jiangshan struct list_head pwqs_node; /* WR: node on wq->pwqs */ 2862e109a28STejun Heo struct list_head mayday_node; /* MD: node on wq->maydays */ 2878864b4e5STejun Heo 288725e8ec5STejun Heo u64 stats[PWQ_NR_STATS]; 289725e8ec5STejun Heo 2908864b4e5STejun Heo /* 291967b494eSTejun Heo * Release of unbound pwq is punted to a kthread_worker. See put_pwq() 292687a9aa5STejun Heo * and pwq_release_workfn() for details. pool_workqueue itself is also 293687a9aa5STejun Heo * RCU protected so that the first pwq can be determined without 294967b494eSTejun Heo * grabbing wq->mutex. 2958864b4e5STejun Heo */ 296687a9aa5STejun Heo struct kthread_work release_work; 2978864b4e5STejun Heo struct rcu_head rcu; 298e9a8e01fSTejun Heo } __aligned(1 << WORK_STRUCT_PWQ_SHIFT); 2991da177e4SLinus Torvalds 3001da177e4SLinus Torvalds /* 30173f53c4aSTejun Heo * Structure used to wait for workqueue flush. 30273f53c4aSTejun Heo */ 30373f53c4aSTejun Heo struct wq_flusher { 3043c25a55dSLai Jiangshan struct list_head list; /* WQ: list of flushers */ 3053c25a55dSLai Jiangshan int flush_color; /* WQ: flush color waiting for */ 30673f53c4aSTejun Heo struct completion done; /* flush completion */ 30773f53c4aSTejun Heo }; 3081da177e4SLinus Torvalds 309226223abSTejun Heo struct wq_device; 310226223abSTejun Heo 31173f53c4aSTejun Heo /* 31291ccc6e7STejun Heo * Unlike in a per-cpu workqueue where max_active limits its concurrency level 31391ccc6e7STejun Heo * on each CPU, in an unbound workqueue, max_active applies to the whole system. 31491ccc6e7STejun Heo * As sharing a single nr_active across multiple sockets can be very expensive, 31591ccc6e7STejun Heo * the counting and enforcement is per NUMA node. 3165797b1c1STejun Heo * 3175797b1c1STejun Heo * The following struct is used to enforce per-node max_active. When a pwq wants 3185797b1c1STejun Heo * to start executing a work item, it should increment ->nr using 3195797b1c1STejun Heo * tryinc_node_nr_active(). If acquisition fails due to ->nr already being over 3205797b1c1STejun Heo * ->max, the pwq is queued on ->pending_pwqs. As in-flight work items finish 3215797b1c1STejun Heo * and decrement ->nr, node_activate_pending_pwq() activates the pending pwqs in 3225797b1c1STejun Heo * round-robin order. 32391ccc6e7STejun Heo */ 32491ccc6e7STejun Heo struct wq_node_nr_active { 3255797b1c1STejun Heo int max; /* per-node max_active */ 3265797b1c1STejun Heo atomic_t nr; /* per-node nr_active */ 3275797b1c1STejun Heo raw_spinlock_t lock; /* nests inside pool locks */ 3285797b1c1STejun Heo struct list_head pending_pwqs; /* LN: pwqs with inactive works */ 32991ccc6e7STejun Heo }; 33091ccc6e7STejun Heo 33191ccc6e7STejun Heo /* 332c5aa87bbSTejun Heo * The externally visible workqueue. It relays the issued work items to 333c5aa87bbSTejun Heo * the appropriate worker_pool through its pool_workqueues. 3341da177e4SLinus Torvalds */ 3351da177e4SLinus Torvalds struct workqueue_struct { 3363c25a55dSLai Jiangshan struct list_head pwqs; /* WR: all pwqs of this wq */ 337e2dca7adSTejun Heo struct list_head list; /* PR: list of all workqueues */ 33873f53c4aSTejun Heo 3393c25a55dSLai Jiangshan struct mutex mutex; /* protects this wq */ 3403c25a55dSLai Jiangshan int work_color; /* WQ: current work color */ 3413c25a55dSLai Jiangshan int flush_color; /* WQ: current flush color */ 342112202d9STejun Heo atomic_t nr_pwqs_to_flush; /* flush in progress */ 3433c25a55dSLai Jiangshan struct wq_flusher *first_flusher; /* WQ: first flusher */ 3443c25a55dSLai Jiangshan struct list_head flusher_queue; /* WQ: flush waiters */ 3453c25a55dSLai Jiangshan struct list_head flusher_overflow; /* WQ: flush overflow list */ 34673f53c4aSTejun Heo 3472e109a28STejun Heo struct list_head maydays; /* MD: pwqs requesting rescue */ 34830ae2fc0STejun Heo struct worker *rescuer; /* MD: rescue worker */ 349e22bee78STejun Heo 35087fc741eSLai Jiangshan int nr_drainers; /* WQ: drain in progress */ 3515797b1c1STejun Heo 3525797b1c1STejun Heo /* See alloc_workqueue() function comment for info on min/max_active */ 353a045a272STejun Heo int max_active; /* WO: max active works */ 3545797b1c1STejun Heo int min_active; /* WO: min active works */ 355a045a272STejun Heo int saved_max_active; /* WQ: saved max_active */ 3565797b1c1STejun Heo int saved_min_active; /* WQ: saved min_active */ 357226223abSTejun Heo 3585b95e1afSLai Jiangshan struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */ 3599f66cff2STejun Heo struct pool_workqueue __rcu *dfl_pwq; /* PW: only for unbound wqs */ 3606029a918STejun Heo 361226223abSTejun Heo #ifdef CONFIG_SYSFS 362226223abSTejun Heo struct wq_device *wq_dev; /* I: for sysfs interface */ 363226223abSTejun Heo #endif 3644e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 365669de8bdSBart Van Assche char *lock_name; 366669de8bdSBart Van Assche struct lock_class_key key; 3674f022f43SMatthew Brost struct lockdep_map __lockdep_map; 3684f022f43SMatthew Brost struct lockdep_map *lockdep_map; 3694e6045f1SJohannes Berg #endif 370ecf6881fSTejun Heo char name[WQ_NAME_LEN]; /* I: workqueue name */ 3712728fd2fSTejun Heo 372e2dca7adSTejun Heo /* 37324acfb71SThomas Gleixner * Destruction of workqueue_struct is RCU protected to allow walking 37424acfb71SThomas Gleixner * the workqueues list without grabbing wq_pool_mutex. 375e2dca7adSTejun Heo * This is used to dump all workqueues from sysrq. 376e2dca7adSTejun Heo */ 377e2dca7adSTejun Heo struct rcu_head rcu; 378e2dca7adSTejun Heo 3792728fd2fSTejun Heo /* hot fields used during command issue, aligned to cacheline */ 3802728fd2fSTejun Heo unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ 381c4c8f369SUros Bizjak struct pool_workqueue __rcu * __percpu *cpu_pwq; /* I: per-cpu pwqs */ 38291ccc6e7STejun Heo struct wq_node_nr_active *node_nr_active[]; /* I: per-node nr_active */ 3831da177e4SLinus Torvalds }; 3841da177e4SLinus Torvalds 38584193c07STejun Heo /* 38684193c07STejun Heo * Each pod type describes how CPUs should be grouped for unbound workqueues. 38784193c07STejun Heo * See the comment above workqueue_attrs->affn_scope. 38884193c07STejun Heo */ 38984193c07STejun Heo struct wq_pod_type { 39084193c07STejun Heo int nr_pods; /* number of pods */ 39184193c07STejun Heo cpumask_var_t *pod_cpus; /* pod -> cpus */ 39284193c07STejun Heo int *pod_node; /* pod -> node */ 39384193c07STejun Heo int *cpu_pod; /* cpu -> pod */ 39484193c07STejun Heo }; 39584193c07STejun Heo 3961211f3b2STejun Heo struct work_offq_data { 3971211f3b2STejun Heo u32 pool_id; 39886898fa6STejun Heo u32 disable; 3991211f3b2STejun Heo u32 flags; 4001211f3b2STejun Heo }; 4011211f3b2STejun Heo 40263c5484eSTejun Heo static const char *wq_affn_names[WQ_AFFN_NR_TYPES] = { 403523a301eSTejun Heo [WQ_AFFN_DFL] = "default", 40463c5484eSTejun Heo [WQ_AFFN_CPU] = "cpu", 40563c5484eSTejun Heo [WQ_AFFN_SMT] = "smt", 40663c5484eSTejun Heo [WQ_AFFN_CACHE] = "cache", 40763c5484eSTejun Heo [WQ_AFFN_NUMA] = "numa", 40863c5484eSTejun Heo [WQ_AFFN_SYSTEM] = "system", 40963c5484eSTejun Heo }; 410bce90380STejun Heo 411616db877STejun Heo /* 412616db877STejun Heo * Per-cpu work items which run for longer than the following threshold are 413616db877STejun Heo * automatically considered CPU intensive and excluded from concurrency 414616db877STejun Heo * management to prevent them from noticeably delaying other per-cpu work items. 415aa6fde93STejun Heo * ULONG_MAX indicates that the user hasn't overridden it with a boot parameter. 416aa6fde93STejun Heo * The actual value is initialized in wq_cpu_intensive_thresh_init(). 417616db877STejun Heo */ 418aa6fde93STejun Heo static unsigned long wq_cpu_intensive_thresh_us = ULONG_MAX; 419616db877STejun Heo module_param_named(cpu_intensive_thresh_us, wq_cpu_intensive_thresh_us, ulong, 0644); 420ccdec921SXuewen Yan #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT 421ccdec921SXuewen Yan static unsigned int wq_cpu_intensive_warning_thresh = 4; 422ccdec921SXuewen Yan module_param_named(cpu_intensive_warning_thresh, wq_cpu_intensive_warning_thresh, uint, 0644); 423ccdec921SXuewen Yan #endif 424616db877STejun Heo 425cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 426552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT); 427cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444); 428cee22a15SViresh Kumar 429863b710bSTejun Heo static bool wq_online; /* can kworkers be created yet? */ 430c7a40c49STejun Heo static bool wq_topo_initialized __read_mostly = false; 431c7a40c49STejun Heo 432c7a40c49STejun Heo static struct kmem_cache *pwq_cache; 433c7a40c49STejun Heo 434c7a40c49STejun Heo static struct wq_pod_type wq_pod_types[WQ_AFFN_NR_TYPES]; 435c7a40c49STejun Heo static enum wq_affn_scope wq_affn_dfl = WQ_AFFN_CACHE; 4363347fa09STejun Heo 437fef59c9cSTejun Heo /* buf for wq_update_unbound_pod_attrs(), protected by CPU hotplug exclusion */ 438b2b1f933SLai Jiangshan static struct workqueue_attrs *unbound_wq_update_pwq_attrs_buf; 4394c16bd32STejun Heo 44068e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ 4411258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */ 442a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ 443d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */ 444d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait); 4455bcab335STejun Heo 446e2dca7adSTejun Heo static LIST_HEAD(workqueues); /* PR: list of all workqueues */ 44768e13a67SLai Jiangshan static bool workqueue_freezing; /* PL: have wqs started freezing? */ 4487d19c5ceSTejun Heo 4498d84baf7SLai Jiangshan /* PL: mirror the cpu_online_mask excluding the CPU in the midst of hotplugging */ 4508d84baf7SLai Jiangshan static cpumask_var_t wq_online_cpumask; 4518d84baf7SLai Jiangshan 45299c621efSLai Jiangshan /* PL&A: allowable cpus for unbound wqs and work items */ 453ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask; 454ef557180SMike Galbraith 455fe28f631SWaiman Long /* PL: user requested unbound cpumask via sysfs */ 456fe28f631SWaiman Long static cpumask_var_t wq_requested_unbound_cpumask; 457fe28f631SWaiman Long 458fe28f631SWaiman Long /* PL: isolated cpumask to be excluded from unbound cpumask */ 459fe28f631SWaiman Long static cpumask_var_t wq_isolated_cpumask; 460fe28f631SWaiman Long 461ace3c549Stiozhang /* for further constrain wq_unbound_cpumask by cmdline parameter*/ 462ace3c549Stiozhang static struct cpumask wq_cmdline_cpumask __initdata; 463ace3c549Stiozhang 464ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */ 465ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last); 466b05a7928SFrederic Weisbecker 467f303fccbSTejun Heo /* 468f303fccbSTejun Heo * Local execution of unbound work items is no longer guaranteed. The 469f303fccbSTejun Heo * following always forces round-robin CPU selection on unbound work items 470f303fccbSTejun Heo * to uncover usages which depend on it. 471f303fccbSTejun Heo */ 472f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU 473f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true; 474f303fccbSTejun Heo #else 475f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false; 476f303fccbSTejun Heo #endif 477f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644); 478f303fccbSTejun Heo 4792f34d733STejun Heo /* to raise softirq for the BH worker pools on other CPUs */ 480b4722b85SBaoquan He static DEFINE_PER_CPU_SHARED_ALIGNED(struct irq_work [NR_STD_WORKER_POOLS], bh_pool_irq_works); 4812f34d733STejun Heo 4824cb1ef64STejun Heo /* the BH worker pools */ 483b4722b85SBaoquan He static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], bh_worker_pools); 4844cb1ef64STejun Heo 4857d19c5ceSTejun Heo /* the per-cpu worker pools */ 486b4722b85SBaoquan He static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools); 4877d19c5ceSTejun Heo 48868e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ 4897d19c5ceSTejun Heo 49068e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */ 49129c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); 49229c91e99STejun Heo 493c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */ 49429c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; 49529c91e99STejun Heo 4968a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */ 4978a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS]; 4988a2b7538STejun Heo 499967b494eSTejun Heo /* 500967b494eSTejun Heo * I: kthread_worker to release pwq's. pwq release needs to be bounced to a 501967b494eSTejun Heo * process context while holding a pool lock. Bounce to a dedicated kthread 502967b494eSTejun Heo * worker to avoid A-A deadlocks. 503967b494eSTejun Heo */ 50468279f9cSAlexey Dobriyan static struct kthread_worker *pwq_release_worker __ro_after_init; 505967b494eSTejun Heo 50668279f9cSAlexey Dobriyan struct workqueue_struct *system_wq __ro_after_init; 507ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq); 50868279f9cSAlexey Dobriyan struct workqueue_struct *system_highpri_wq __ro_after_init; 5091aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 51068279f9cSAlexey Dobriyan struct workqueue_struct *system_long_wq __ro_after_init; 511d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 51268279f9cSAlexey Dobriyan struct workqueue_struct *system_unbound_wq __ro_after_init; 513f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 51468279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_wq __ro_after_init; 51524d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 51668279f9cSAlexey Dobriyan struct workqueue_struct *system_power_efficient_wq __ro_after_init; 5170668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq); 51868279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_power_efficient_wq __ro_after_init; 5190668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq); 5204cb1ef64STejun Heo struct workqueue_struct *system_bh_wq; 5214cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_wq); 5224cb1ef64STejun Heo struct workqueue_struct *system_bh_highpri_wq; 5234cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_highpri_wq); 524d320c038STejun Heo 5257d19c5ceSTejun Heo static int worker_thread(void *__worker); 5266ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq); 527c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq); 52855df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool); 5297d19c5ceSTejun Heo 53097bd2347STejun Heo #define CREATE_TRACE_POINTS 53197bd2347STejun Heo #include <trace/events/workqueue.h> 53297bd2347STejun Heo 53368e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex() \ 534d355001fSTejun Heo RCU_LOCKDEP_WARN(!rcu_read_lock_any_held() && \ 535f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 53624acfb71SThomas Gleixner "RCU or wq_pool_mutex should be held") 5375bcab335STejun Heo 5385b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \ 539d355001fSTejun Heo RCU_LOCKDEP_WARN(!rcu_read_lock_any_held() && \ 540f78f5b90SPaul E. McKenney !lockdep_is_held(&wq->mutex) && \ 541f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 54224acfb71SThomas Gleixner "RCU, wq->mutex or wq_pool_mutex should be held") 5435b95e1afSLai Jiangshan 5444cb1ef64STejun Heo #define for_each_bh_worker_pool(pool, cpu) \ 5454cb1ef64STejun Heo for ((pool) = &per_cpu(bh_worker_pools, cpu)[0]; \ 5464cb1ef64STejun Heo (pool) < &per_cpu(bh_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 5474cb1ef64STejun Heo (pool)++) 5484cb1ef64STejun Heo 549f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu) \ 550f02ae73aSTejun Heo for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ 551f02ae73aSTejun Heo (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 5527a62c2c8STejun Heo (pool)++) 5534ce62e9eSTejun Heo 55449e3cf44STejun Heo /** 55517116969STejun Heo * for_each_pool - iterate through all worker_pools in the system 55617116969STejun Heo * @pool: iteration cursor 557611c92a0STejun Heo * @pi: integer used for iteration 558fa1b54e6STejun Heo * 55924acfb71SThomas Gleixner * This must be called either with wq_pool_mutex held or RCU read 56068e13a67SLai Jiangshan * locked. If the pool needs to be used beyond the locking in effect, the 56168e13a67SLai Jiangshan * caller is responsible for guaranteeing that the pool stays online. 562fa1b54e6STejun Heo * 563fa1b54e6STejun Heo * The if/else clause exists only for the lockdep assertion and can be 564fa1b54e6STejun Heo * ignored. 56517116969STejun Heo */ 566611c92a0STejun Heo #define for_each_pool(pool, pi) \ 567611c92a0STejun Heo idr_for_each_entry(&worker_pool_idr, pool, pi) \ 56868e13a67SLai Jiangshan if (({ assert_rcu_or_pool_mutex(); false; })) { } \ 569fa1b54e6STejun Heo else 57017116969STejun Heo 57117116969STejun Heo /** 572822d8405STejun Heo * for_each_pool_worker - iterate through all workers of a worker_pool 573822d8405STejun Heo * @worker: iteration cursor 574822d8405STejun Heo * @pool: worker_pool to iterate workers of 575822d8405STejun Heo * 5761258fae7STejun Heo * This must be called with wq_pool_attach_mutex. 577822d8405STejun Heo * 578822d8405STejun Heo * The if/else clause exists only for the lockdep assertion and can be 579822d8405STejun Heo * ignored. 580822d8405STejun Heo */ 581da028469SLai Jiangshan #define for_each_pool_worker(worker, pool) \ 582da028469SLai Jiangshan list_for_each_entry((worker), &(pool)->workers, node) \ 5831258fae7STejun Heo if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \ 584822d8405STejun Heo else 585822d8405STejun Heo 586822d8405STejun Heo /** 58749e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 58849e3cf44STejun Heo * @pwq: iteration cursor 58949e3cf44STejun Heo * @wq: the target workqueue 59076af4d93STejun Heo * 59124acfb71SThomas Gleixner * This must be called either with wq->mutex held or RCU read locked. 592794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 593794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 59476af4d93STejun Heo * 59576af4d93STejun Heo * The if/else clause exists only for the lockdep assertion and can be 59676af4d93STejun Heo * ignored. 59749e3cf44STejun Heo */ 59849e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 59949e9d1a9SSebastian Andrzej Siewior list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \ 6005a644662SJoel Fernandes (Google) lockdep_is_held(&(wq->mutex))) 601f3421797STejun Heo 602dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 603dc186ad7SThomas Gleixner 604f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr; 605dc186ad7SThomas Gleixner 60699777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 60799777288SStanislaw Gruszka { 60899777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 60999777288SStanislaw Gruszka } 61099777288SStanislaw Gruszka 611b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr) 612b9fdac7fSDu, Changbin { 613b9fdac7fSDu, Changbin struct work_struct *work = addr; 614b9fdac7fSDu, Changbin 615b9fdac7fSDu, Changbin return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work)); 616b9fdac7fSDu, Changbin } 617b9fdac7fSDu, Changbin 618dc186ad7SThomas Gleixner /* 619dc186ad7SThomas Gleixner * fixup_init is called when: 620dc186ad7SThomas Gleixner * - an active object is initialized 621dc186ad7SThomas Gleixner */ 62202a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state) 623dc186ad7SThomas Gleixner { 624dc186ad7SThomas Gleixner struct work_struct *work = addr; 625dc186ad7SThomas Gleixner 626dc186ad7SThomas Gleixner switch (state) { 627dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 628dc186ad7SThomas Gleixner cancel_work_sync(work); 629dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 63002a982a6SDu, Changbin return true; 631dc186ad7SThomas Gleixner default: 63202a982a6SDu, Changbin return false; 633dc186ad7SThomas Gleixner } 634dc186ad7SThomas Gleixner } 635dc186ad7SThomas Gleixner 636dc186ad7SThomas Gleixner /* 637dc186ad7SThomas Gleixner * fixup_free is called when: 638dc186ad7SThomas Gleixner * - an active object is freed 639dc186ad7SThomas Gleixner */ 64002a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state) 641dc186ad7SThomas Gleixner { 642dc186ad7SThomas Gleixner struct work_struct *work = addr; 643dc186ad7SThomas Gleixner 644dc186ad7SThomas Gleixner switch (state) { 645dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 646dc186ad7SThomas Gleixner cancel_work_sync(work); 647dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 64802a982a6SDu, Changbin return true; 649dc186ad7SThomas Gleixner default: 65002a982a6SDu, Changbin return false; 651dc186ad7SThomas Gleixner } 652dc186ad7SThomas Gleixner } 653dc186ad7SThomas Gleixner 654f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = { 655dc186ad7SThomas Gleixner .name = "work_struct", 65699777288SStanislaw Gruszka .debug_hint = work_debug_hint, 657b9fdac7fSDu, Changbin .is_static_object = work_is_static_object, 658dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 659dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 660dc186ad7SThomas Gleixner }; 661dc186ad7SThomas Gleixner 662dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 663dc186ad7SThomas Gleixner { 664dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 665dc186ad7SThomas Gleixner } 666dc186ad7SThomas Gleixner 667dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 668dc186ad7SThomas Gleixner { 669dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 670dc186ad7SThomas Gleixner } 671dc186ad7SThomas Gleixner 672dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 673dc186ad7SThomas Gleixner { 674dc186ad7SThomas Gleixner if (onstack) 675dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 676dc186ad7SThomas Gleixner else 677dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 678dc186ad7SThomas Gleixner } 679dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 680dc186ad7SThomas Gleixner 681dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 682dc186ad7SThomas Gleixner { 683dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 684dc186ad7SThomas Gleixner } 685dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 686dc186ad7SThomas Gleixner 687ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work) 688ea2e64f2SThomas Gleixner { 689ea2e64f2SThomas Gleixner destroy_timer_on_stack(&work->timer); 690ea2e64f2SThomas Gleixner debug_object_free(&work->work, &work_debug_descr); 691ea2e64f2SThomas Gleixner } 692ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack); 693ea2e64f2SThomas Gleixner 694dc186ad7SThomas Gleixner #else 695dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 696dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 697dc186ad7SThomas Gleixner #endif 698dc186ad7SThomas Gleixner 6994e8b22bdSLi Bin /** 70067dc8325SCai Huoqing * worker_pool_assign_id - allocate ID and assign it to @pool 7014e8b22bdSLi Bin * @pool: the pool pointer of interest 7024e8b22bdSLi Bin * 7034e8b22bdSLi Bin * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned 7044e8b22bdSLi Bin * successfully, -errno on failure. 7054e8b22bdSLi Bin */ 7069daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 7079daf9e67STejun Heo { 7089daf9e67STejun Heo int ret; 7099daf9e67STejun Heo 71068e13a67SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 7115bcab335STejun Heo 7124e8b22bdSLi Bin ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE, 7134e8b22bdSLi Bin GFP_KERNEL); 714229641a6STejun Heo if (ret >= 0) { 715e68035fbSTejun Heo pool->id = ret; 716229641a6STejun Heo return 0; 717229641a6STejun Heo } 7189daf9e67STejun Heo return ret; 7199daf9e67STejun Heo } 7209daf9e67STejun Heo 7219f66cff2STejun Heo static struct pool_workqueue __rcu ** 7229f66cff2STejun Heo unbound_pwq_slot(struct workqueue_struct *wq, int cpu) 7239f66cff2STejun Heo { 7249f66cff2STejun Heo if (cpu >= 0) 7259f66cff2STejun Heo return per_cpu_ptr(wq->cpu_pwq, cpu); 7269f66cff2STejun Heo else 7279f66cff2STejun Heo return &wq->dfl_pwq; 7289f66cff2STejun Heo } 7299f66cff2STejun Heo 7309f66cff2STejun Heo /* @cpu < 0 for dfl_pwq */ 7319f66cff2STejun Heo static struct pool_workqueue *unbound_pwq(struct workqueue_struct *wq, int cpu) 7329f66cff2STejun Heo { 7339f66cff2STejun Heo return rcu_dereference_check(*unbound_pwq_slot(wq, cpu), 7349f66cff2STejun Heo lockdep_is_held(&wq_pool_mutex) || 7359f66cff2STejun Heo lockdep_is_held(&wq->mutex)); 7369f66cff2STejun Heo } 7379f66cff2STejun Heo 7385797b1c1STejun Heo /** 7395797b1c1STejun Heo * unbound_effective_cpumask - effective cpumask of an unbound workqueue 7405797b1c1STejun Heo * @wq: workqueue of interest 7415797b1c1STejun Heo * 7425797b1c1STejun Heo * @wq->unbound_attrs->cpumask contains the cpumask requested by the user which 7435797b1c1STejun Heo * is masked with wq_unbound_cpumask to determine the effective cpumask. The 7445797b1c1STejun Heo * default pwq is always mapped to the pool with the current effective cpumask. 7455797b1c1STejun Heo */ 7465797b1c1STejun Heo static struct cpumask *unbound_effective_cpumask(struct workqueue_struct *wq) 7475797b1c1STejun Heo { 7485797b1c1STejun Heo return unbound_pwq(wq, -1)->pool->attrs->__pod_cpumask; 7495797b1c1STejun Heo } 7505797b1c1STejun Heo 75173f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 75273f53c4aSTejun Heo { 75373f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 75473f53c4aSTejun Heo } 75573f53c4aSTejun Heo 756c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data) 75773f53c4aSTejun Heo { 758c4560c2cSLai Jiangshan return (work_data >> WORK_STRUCT_COLOR_SHIFT) & 75973f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 76073f53c4aSTejun Heo } 76173f53c4aSTejun Heo 76273f53c4aSTejun Heo static int work_next_color(int color) 76373f53c4aSTejun Heo { 76473f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 765a848e3b6SOleg Nesterov } 766a848e3b6SOleg Nesterov 767456a78eeSTejun Heo static unsigned long pool_offq_flags(struct worker_pool *pool) 768456a78eeSTejun Heo { 769456a78eeSTejun Heo return (pool->flags & POOL_BH) ? WORK_OFFQ_BH : 0; 770456a78eeSTejun Heo } 771456a78eeSTejun Heo 7724594bf15SDavid Howells /* 773112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 774112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 7757c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 7767a22ad75STejun Heo * 777afe928c1STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending() and mark_work_canceling() 778afe928c1STejun Heo * can be used to set the pwq, pool or clear work->data. These functions should 779afe928c1STejun Heo * only be called while the work is owned - ie. while the PENDING bit is set. 7807a22ad75STejun Heo * 781112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 7827c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 783112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 7847c3eed5cSTejun Heo * available only while the work item is queued. 7854594bf15SDavid Howells */ 786bccdc1faSTejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data) 7877a22ad75STejun Heo { 7886183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 789bccdc1faSTejun Heo atomic_long_set(&work->data, data | work_static(work)); 7907a22ad75STejun Heo } 7917a22ad75STejun Heo 792112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 793bccdc1faSTejun Heo unsigned long flags) 794365970a1SDavid Howells { 795bccdc1faSTejun Heo set_work_data(work, (unsigned long)pwq | WORK_STRUCT_PENDING | 796bccdc1faSTejun Heo WORK_STRUCT_PWQ | flags); 797365970a1SDavid Howells } 798365970a1SDavid Howells 7994468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 800bccdc1faSTejun Heo int pool_id, unsigned long flags) 8014468a00fSLai Jiangshan { 802bccdc1faSTejun Heo set_work_data(work, ((unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT) | 803bccdc1faSTejun Heo WORK_STRUCT_PENDING | flags); 8044468a00fSLai Jiangshan } 8054468a00fSLai Jiangshan 8067c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 807bccdc1faSTejun Heo int pool_id, unsigned long flags) 8084d707b9fSOleg Nesterov { 80923657bb1STejun Heo /* 81023657bb1STejun Heo * The following wmb is paired with the implied mb in 81123657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 81223657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 81323657bb1STejun Heo * owner. 81423657bb1STejun Heo */ 81523657bb1STejun Heo smp_wmb(); 816bccdc1faSTejun Heo set_work_data(work, ((unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT) | 817bccdc1faSTejun Heo flags); 818346c09f8SRoman Pen /* 819346c09f8SRoman Pen * The following mb guarantees that previous clear of a PENDING bit 820346c09f8SRoman Pen * will not be reordered with any speculative LOADS or STORES from 821346c09f8SRoman Pen * work->current_func, which is executed afterwards. This possible 8228bdc6201SLiu Song * reordering can lead to a missed execution on attempt to queue 823346c09f8SRoman Pen * the same @work. E.g. consider this case: 824346c09f8SRoman Pen * 825346c09f8SRoman Pen * CPU#0 CPU#1 826346c09f8SRoman Pen * ---------------------------- -------------------------------- 827346c09f8SRoman Pen * 828346c09f8SRoman Pen * 1 STORE event_indicated 829346c09f8SRoman Pen * 2 queue_work_on() { 830346c09f8SRoman Pen * 3 test_and_set_bit(PENDING) 831346c09f8SRoman Pen * 4 } set_..._and_clear_pending() { 832346c09f8SRoman Pen * 5 set_work_data() # clear bit 833346c09f8SRoman Pen * 6 smp_mb() 834346c09f8SRoman Pen * 7 work->current_func() { 835346c09f8SRoman Pen * 8 LOAD event_indicated 836346c09f8SRoman Pen * } 837346c09f8SRoman Pen * 838346c09f8SRoman Pen * Without an explicit full barrier speculative LOAD on line 8 can 839346c09f8SRoman Pen * be executed before CPU#0 does STORE on line 1. If that happens, 840346c09f8SRoman Pen * CPU#0 observes the PENDING bit is still set and new execution of 841346c09f8SRoman Pen * a @work is not queued in a hope, that CPU#1 will eventually 842346c09f8SRoman Pen * finish the queued @work. Meanwhile CPU#1 does not see 843346c09f8SRoman Pen * event_indicated is set, because speculative LOAD was executed 844346c09f8SRoman Pen * before actual STORE. 845346c09f8SRoman Pen */ 846346c09f8SRoman Pen smp_mb(); 8474d707b9fSOleg Nesterov } 8484d707b9fSOleg Nesterov 849afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data) 850afa4bb77SLinus Torvalds { 851e9a8e01fSTejun Heo return (struct pool_workqueue *)(data & WORK_STRUCT_PWQ_MASK); 852afa4bb77SLinus Torvalds } 853afa4bb77SLinus Torvalds 854112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 8557a22ad75STejun Heo { 856e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 8577a22ad75STejun Heo 858112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 859afa4bb77SLinus Torvalds return work_struct_pwq(data); 860e120153dSTejun Heo else 861e120153dSTejun Heo return NULL; 8627a22ad75STejun Heo } 8637a22ad75STejun Heo 8647c3eed5cSTejun Heo /** 8657c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 8667c3eed5cSTejun Heo * @work: the work item of interest 8677c3eed5cSTejun Heo * 86868e13a67SLai Jiangshan * Pools are created and destroyed under wq_pool_mutex, and allows read 86924acfb71SThomas Gleixner * access under RCU read lock. As such, this function should be 87024acfb71SThomas Gleixner * called under wq_pool_mutex or inside of a rcu_read_lock() region. 871fa1b54e6STejun Heo * 872fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 873fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 874fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 875fa1b54e6STejun Heo * returned pool is and stays online. 876d185af30SYacine Belkadi * 877d185af30SYacine Belkadi * Return: The worker_pool @work was last associated with. %NULL if none. 8787c3eed5cSTejun Heo */ 8797c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 8807a22ad75STejun Heo { 881e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 8827c3eed5cSTejun Heo int pool_id; 8837a22ad75STejun Heo 88468e13a67SLai Jiangshan assert_rcu_or_pool_mutex(); 885fa1b54e6STejun Heo 886112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 887afa4bb77SLinus Torvalds return work_struct_pwq(data)->pool; 8887a22ad75STejun Heo 8897c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 8907c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 8917a22ad75STejun Heo return NULL; 8927a22ad75STejun Heo 893fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 8947c3eed5cSTejun Heo } 8957c3eed5cSTejun Heo 8961211f3b2STejun Heo static unsigned long shift_and_mask(unsigned long v, u32 shift, u32 bits) 8977c3eed5cSTejun Heo { 89838f7e145SWill Deacon return (v >> shift) & ((1U << bits) - 1); 8997c3eed5cSTejun Heo } 9007c3eed5cSTejun Heo 9011211f3b2STejun Heo static void work_offqd_unpack(struct work_offq_data *offqd, unsigned long data) 902bbb68dfaSTejun Heo { 9031211f3b2STejun Heo WARN_ON_ONCE(data & WORK_STRUCT_PWQ); 904bbb68dfaSTejun Heo 9051211f3b2STejun Heo offqd->pool_id = shift_and_mask(data, WORK_OFFQ_POOL_SHIFT, 9061211f3b2STejun Heo WORK_OFFQ_POOL_BITS); 90786898fa6STejun Heo offqd->disable = shift_and_mask(data, WORK_OFFQ_DISABLE_SHIFT, 90886898fa6STejun Heo WORK_OFFQ_DISABLE_BITS); 9091211f3b2STejun Heo offqd->flags = data & WORK_OFFQ_FLAG_MASK; 910bbb68dfaSTejun Heo } 911bbb68dfaSTejun Heo 9121211f3b2STejun Heo static unsigned long work_offqd_pack_flags(struct work_offq_data *offqd) 913bbb68dfaSTejun Heo { 91486898fa6STejun Heo return ((unsigned long)offqd->disable << WORK_OFFQ_DISABLE_SHIFT) | 91586898fa6STejun Heo ((unsigned long)offqd->flags); 916bbb68dfaSTejun Heo } 917bbb68dfaSTejun Heo 918e22bee78STejun Heo /* 9193270476aSTejun Heo * Policy functions. These define the policies on how the global worker 9203270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 921d565ed63STejun Heo * they're being called with pool->lock held. 922e22bee78STejun Heo */ 923e22bee78STejun Heo 924e22bee78STejun Heo /* 925e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 926e22bee78STejun Heo * running workers. 927974271c4STejun Heo * 928974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 929706026c2STejun Heo * function will always return %true for unbound pools as long as the 930974271c4STejun Heo * worklist isn't empty. 931e22bee78STejun Heo */ 93263d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 933e22bee78STejun Heo { 9340219a352STejun Heo return !list_empty(&pool->worklist) && !pool->nr_running; 935e22bee78STejun Heo } 936e22bee78STejun Heo 937e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 93863d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 939e22bee78STejun Heo { 94063d95a91STejun Heo return pool->nr_idle; 941e22bee78STejun Heo } 942e22bee78STejun Heo 943e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 94463d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 945e22bee78STejun Heo { 946bc35f7efSLai Jiangshan return !list_empty(&pool->worklist) && (pool->nr_running <= 1); 947e22bee78STejun Heo } 948e22bee78STejun Heo 949e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 95063d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 951e22bee78STejun Heo { 95263d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 953e22bee78STejun Heo } 954e22bee78STejun Heo 955e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 95663d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 957e22bee78STejun Heo { 958692b4825STejun Heo bool managing = pool->flags & POOL_MANAGER_ACTIVE; 95963d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 96063d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 961e22bee78STejun Heo 962e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 963e22bee78STejun Heo } 964e22bee78STejun Heo 9654690c4abSTejun Heo /** 966e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 967cb444766STejun Heo * @worker: self 968d302f017STejun Heo * @flags: flags to set 969d302f017STejun Heo * 970228f1d00SLai Jiangshan * Set @flags in @worker->flags and adjust nr_running accordingly. 971d302f017STejun Heo */ 972228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags) 973d302f017STejun Heo { 974bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 975e22bee78STejun Heo 976bc8b50c2STejun Heo lockdep_assert_held(&pool->lock); 977cb444766STejun Heo 978228f1d00SLai Jiangshan /* If transitioning into NOT_RUNNING, adjust nr_running. */ 979e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 980e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 981bc35f7efSLai Jiangshan pool->nr_running--; 982e22bee78STejun Heo } 983e22bee78STejun Heo 984d302f017STejun Heo worker->flags |= flags; 985d302f017STejun Heo } 986d302f017STejun Heo 987d302f017STejun Heo /** 988e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 989cb444766STejun Heo * @worker: self 990d302f017STejun Heo * @flags: flags to clear 991d302f017STejun Heo * 992e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 993d302f017STejun Heo */ 994d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 995d302f017STejun Heo { 99663d95a91STejun Heo struct worker_pool *pool = worker->pool; 997e22bee78STejun Heo unsigned int oflags = worker->flags; 998e22bee78STejun Heo 999bc8b50c2STejun Heo lockdep_assert_held(&pool->lock); 1000cb444766STejun Heo 1001d302f017STejun Heo worker->flags &= ~flags; 1002e22bee78STejun Heo 100342c025f3STejun Heo /* 100442c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 100542c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 100642c025f3STejun Heo * of multiple flags, not a single flag. 100742c025f3STejun Heo */ 1008e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 1009e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 1010bc35f7efSLai Jiangshan pool->nr_running++; 1011d302f017STejun Heo } 1012d302f017STejun Heo 1013797e8345STejun Heo /* Return the first idle worker. Called with pool->lock held. */ 1014797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool) 1015797e8345STejun Heo { 1016797e8345STejun Heo if (unlikely(list_empty(&pool->idle_list))) 1017797e8345STejun Heo return NULL; 1018797e8345STejun Heo 1019797e8345STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 1020797e8345STejun Heo } 1021797e8345STejun Heo 1022797e8345STejun Heo /** 1023797e8345STejun Heo * worker_enter_idle - enter idle state 1024797e8345STejun Heo * @worker: worker which is entering idle state 1025797e8345STejun Heo * 1026797e8345STejun Heo * @worker is entering idle state. Update stats and idle timer if 1027797e8345STejun Heo * necessary. 1028797e8345STejun Heo * 1029797e8345STejun Heo * LOCKING: 1030797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1031797e8345STejun Heo */ 1032797e8345STejun Heo static void worker_enter_idle(struct worker *worker) 1033797e8345STejun Heo { 1034797e8345STejun Heo struct worker_pool *pool = worker->pool; 1035797e8345STejun Heo 1036797e8345STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 1037797e8345STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 1038797e8345STejun Heo (worker->hentry.next || worker->hentry.pprev))) 1039797e8345STejun Heo return; 1040797e8345STejun Heo 1041797e8345STejun Heo /* can't use worker_set_flags(), also called from create_worker() */ 1042797e8345STejun Heo worker->flags |= WORKER_IDLE; 1043797e8345STejun Heo pool->nr_idle++; 1044797e8345STejun Heo worker->last_active = jiffies; 1045797e8345STejun Heo 1046797e8345STejun Heo /* idle_list is LIFO */ 1047797e8345STejun Heo list_add(&worker->entry, &pool->idle_list); 1048797e8345STejun Heo 1049797e8345STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1050797e8345STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1051797e8345STejun Heo 1052797e8345STejun Heo /* Sanity check nr_running. */ 1053797e8345STejun Heo WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running); 1054797e8345STejun Heo } 1055797e8345STejun Heo 1056797e8345STejun Heo /** 1057797e8345STejun Heo * worker_leave_idle - leave idle state 1058797e8345STejun Heo * @worker: worker which is leaving idle state 1059797e8345STejun Heo * 1060797e8345STejun Heo * @worker is leaving idle state. Update stats. 1061797e8345STejun Heo * 1062797e8345STejun Heo * LOCKING: 1063797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1064797e8345STejun Heo */ 1065797e8345STejun Heo static void worker_leave_idle(struct worker *worker) 1066797e8345STejun Heo { 1067797e8345STejun Heo struct worker_pool *pool = worker->pool; 1068797e8345STejun Heo 1069797e8345STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 1070797e8345STejun Heo return; 1071797e8345STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1072797e8345STejun Heo pool->nr_idle--; 1073797e8345STejun Heo list_del_init(&worker->entry); 1074797e8345STejun Heo } 1075797e8345STejun Heo 1076797e8345STejun Heo /** 1077797e8345STejun Heo * find_worker_executing_work - find worker which is executing a work 1078797e8345STejun Heo * @pool: pool of interest 1079797e8345STejun Heo * @work: work to find worker for 1080797e8345STejun Heo * 1081797e8345STejun Heo * Find a worker which is executing @work on @pool by searching 1082797e8345STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 1083797e8345STejun Heo * to match, its current execution should match the address of @work and 1084797e8345STejun Heo * its work function. This is to avoid unwanted dependency between 1085797e8345STejun Heo * unrelated work executions through a work item being recycled while still 1086797e8345STejun Heo * being executed. 1087797e8345STejun Heo * 1088797e8345STejun Heo * This is a bit tricky. A work item may be freed once its execution 1089797e8345STejun Heo * starts and nothing prevents the freed area from being recycled for 1090797e8345STejun Heo * another work item. If the same work item address ends up being reused 1091797e8345STejun Heo * before the original execution finishes, workqueue will identify the 1092797e8345STejun Heo * recycled work item as currently executing and make it wait until the 1093797e8345STejun Heo * current execution finishes, introducing an unwanted dependency. 1094797e8345STejun Heo * 1095797e8345STejun Heo * This function checks the work item address and work function to avoid 1096797e8345STejun Heo * false positives. Note that this isn't complete as one may construct a 1097797e8345STejun Heo * work function which can introduce dependency onto itself through a 1098797e8345STejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 1099797e8345STejun Heo * foot that badly, there's only so much we can do, and if such deadlock 1100797e8345STejun Heo * actually occurs, it should be easy to locate the culprit work function. 1101797e8345STejun Heo * 1102797e8345STejun Heo * CONTEXT: 1103797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1104797e8345STejun Heo * 1105797e8345STejun Heo * Return: 1106797e8345STejun Heo * Pointer to worker which is executing @work if found, %NULL 1107797e8345STejun Heo * otherwise. 1108797e8345STejun Heo */ 1109797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 1110797e8345STejun Heo struct work_struct *work) 1111797e8345STejun Heo { 1112797e8345STejun Heo struct worker *worker; 1113797e8345STejun Heo 1114797e8345STejun Heo hash_for_each_possible(pool->busy_hash, worker, hentry, 1115797e8345STejun Heo (unsigned long)work) 1116797e8345STejun Heo if (worker->current_work == work && 1117797e8345STejun Heo worker->current_func == work->func) 1118797e8345STejun Heo return worker; 1119797e8345STejun Heo 1120797e8345STejun Heo return NULL; 1121797e8345STejun Heo } 1122797e8345STejun Heo 1123797e8345STejun Heo /** 1124797e8345STejun Heo * move_linked_works - move linked works to a list 1125797e8345STejun Heo * @work: start of series of works to be scheduled 1126797e8345STejun Heo * @head: target list to append @work to 1127797e8345STejun Heo * @nextp: out parameter for nested worklist walking 1128797e8345STejun Heo * 1129873eaca6STejun Heo * Schedule linked works starting from @work to @head. Work series to be 1130873eaca6STejun Heo * scheduled starts at @work and includes any consecutive work with 1131873eaca6STejun Heo * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on 1132873eaca6STejun Heo * @nextp. 1133797e8345STejun Heo * 1134797e8345STejun Heo * CONTEXT: 1135797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1136797e8345STejun Heo */ 1137797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 1138797e8345STejun Heo struct work_struct **nextp) 1139797e8345STejun Heo { 1140797e8345STejun Heo struct work_struct *n; 1141797e8345STejun Heo 1142797e8345STejun Heo /* 1143797e8345STejun Heo * Linked worklist will always end before the end of the list, 1144797e8345STejun Heo * use NULL for list head. 1145797e8345STejun Heo */ 1146797e8345STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1147797e8345STejun Heo list_move_tail(&work->entry, head); 1148797e8345STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1149797e8345STejun Heo break; 1150797e8345STejun Heo } 1151797e8345STejun Heo 1152797e8345STejun Heo /* 1153797e8345STejun Heo * If we're already inside safe list traversal and have moved 1154797e8345STejun Heo * multiple works to the scheduled queue, the next position 1155797e8345STejun Heo * needs to be updated. 1156797e8345STejun Heo */ 1157797e8345STejun Heo if (nextp) 1158797e8345STejun Heo *nextp = n; 1159797e8345STejun Heo } 1160797e8345STejun Heo 1161797e8345STejun Heo /** 1162873eaca6STejun Heo * assign_work - assign a work item and its linked work items to a worker 1163873eaca6STejun Heo * @work: work to assign 1164873eaca6STejun Heo * @worker: worker to assign to 1165873eaca6STejun Heo * @nextp: out parameter for nested worklist walking 1166873eaca6STejun Heo * 1167873eaca6STejun Heo * Assign @work and its linked work items to @worker. If @work is already being 1168873eaca6STejun Heo * executed by another worker in the same pool, it'll be punted there. 1169873eaca6STejun Heo * 1170873eaca6STejun Heo * If @nextp is not NULL, it's updated to point to the next work of the last 1171873eaca6STejun Heo * scheduled work. This allows assign_work() to be nested inside 1172873eaca6STejun Heo * list_for_each_entry_safe(). 1173873eaca6STejun Heo * 1174873eaca6STejun Heo * Returns %true if @work was successfully assigned to @worker. %false if @work 1175873eaca6STejun Heo * was punted to another worker already executing it. 1176873eaca6STejun Heo */ 1177873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker, 1178873eaca6STejun Heo struct work_struct **nextp) 1179873eaca6STejun Heo { 1180873eaca6STejun Heo struct worker_pool *pool = worker->pool; 1181873eaca6STejun Heo struct worker *collision; 1182873eaca6STejun Heo 1183873eaca6STejun Heo lockdep_assert_held(&pool->lock); 1184873eaca6STejun Heo 1185873eaca6STejun Heo /* 1186873eaca6STejun Heo * A single work shouldn't be executed concurrently by multiple workers. 1187873eaca6STejun Heo * __queue_work() ensures that @work doesn't jump to a different pool 1188873eaca6STejun Heo * while still running in the previous pool. Here, we should ensure that 1189873eaca6STejun Heo * @work is not executed concurrently by multiple workers from the same 1190873eaca6STejun Heo * pool. Check whether anyone is already processing the work. If so, 1191873eaca6STejun Heo * defer the work to the currently executing one. 1192873eaca6STejun Heo */ 1193873eaca6STejun Heo collision = find_worker_executing_work(pool, work); 1194873eaca6STejun Heo if (unlikely(collision)) { 1195873eaca6STejun Heo move_linked_works(work, &collision->scheduled, nextp); 1196873eaca6STejun Heo return false; 1197873eaca6STejun Heo } 1198873eaca6STejun Heo 1199873eaca6STejun Heo move_linked_works(work, &worker->scheduled, nextp); 1200873eaca6STejun Heo return true; 1201873eaca6STejun Heo } 1202873eaca6STejun Heo 12032f34d733STejun Heo static struct irq_work *bh_pool_irq_work(struct worker_pool *pool) 12042f34d733STejun Heo { 12052f34d733STejun Heo int high = pool->attrs->nice == HIGHPRI_NICE_LEVEL ? 1 : 0; 12062f34d733STejun Heo 12072f34d733STejun Heo return &per_cpu(bh_pool_irq_works, pool->cpu)[high]; 12082f34d733STejun Heo } 12092f34d733STejun Heo 1210fd0a68a2STejun Heo static void kick_bh_pool(struct worker_pool *pool) 1211fd0a68a2STejun Heo { 1212fd0a68a2STejun Heo #ifdef CONFIG_SMP 12131acd92d9STejun Heo /* see drain_dead_softirq_workfn() for BH_DRAINING */ 12141acd92d9STejun Heo if (unlikely(pool->cpu != smp_processor_id() && 12151acd92d9STejun Heo !(pool->flags & POOL_BH_DRAINING))) { 1216fd0a68a2STejun Heo irq_work_queue_on(bh_pool_irq_work(pool), pool->cpu); 1217fd0a68a2STejun Heo return; 1218fd0a68a2STejun Heo } 1219fd0a68a2STejun Heo #endif 1220fd0a68a2STejun Heo if (pool->attrs->nice == HIGHPRI_NICE_LEVEL) 1221fd0a68a2STejun Heo raise_softirq_irqoff(HI_SOFTIRQ); 1222fd0a68a2STejun Heo else 1223fd0a68a2STejun Heo raise_softirq_irqoff(TASKLET_SOFTIRQ); 1224fd0a68a2STejun Heo } 1225fd0a68a2STejun Heo 1226873eaca6STejun Heo /** 12270219a352STejun Heo * kick_pool - wake up an idle worker if necessary 12280219a352STejun Heo * @pool: pool to kick 1229797e8345STejun Heo * 12300219a352STejun Heo * @pool may have pending work items. Wake up worker if necessary. Returns 12310219a352STejun Heo * whether a worker was woken up. 1232797e8345STejun Heo */ 12330219a352STejun Heo static bool kick_pool(struct worker_pool *pool) 1234797e8345STejun Heo { 1235797e8345STejun Heo struct worker *worker = first_idle_worker(pool); 12368639ecebSTejun Heo struct task_struct *p; 1237797e8345STejun Heo 12380219a352STejun Heo lockdep_assert_held(&pool->lock); 12390219a352STejun Heo 12400219a352STejun Heo if (!need_more_worker(pool) || !worker) 12410219a352STejun Heo return false; 12420219a352STejun Heo 12434cb1ef64STejun Heo if (pool->flags & POOL_BH) { 1244fd0a68a2STejun Heo kick_bh_pool(pool); 12454cb1ef64STejun Heo return true; 12464cb1ef64STejun Heo } 12474cb1ef64STejun Heo 12488639ecebSTejun Heo p = worker->task; 12498639ecebSTejun Heo 12508639ecebSTejun Heo #ifdef CONFIG_SMP 12518639ecebSTejun Heo /* 12528639ecebSTejun Heo * Idle @worker is about to execute @work and waking up provides an 12538639ecebSTejun Heo * opportunity to migrate @worker at a lower cost by setting the task's 12548639ecebSTejun Heo * wake_cpu field. Let's see if we want to move @worker to improve 12558639ecebSTejun Heo * execution locality. 12568639ecebSTejun Heo * 12578639ecebSTejun Heo * We're waking the worker that went idle the latest and there's some 12588639ecebSTejun Heo * chance that @worker is marked idle but hasn't gone off CPU yet. If 12598639ecebSTejun Heo * so, setting the wake_cpu won't do anything. As this is a best-effort 12608639ecebSTejun Heo * optimization and the race window is narrow, let's leave as-is for 12618639ecebSTejun Heo * now. If this becomes pronounced, we can skip over workers which are 12628639ecebSTejun Heo * still on cpu when picking an idle worker. 12638639ecebSTejun Heo * 12648639ecebSTejun Heo * If @pool has non-strict affinity, @worker might have ended up outside 12658639ecebSTejun Heo * its affinity scope. Repatriate. 12668639ecebSTejun Heo */ 12678639ecebSTejun Heo if (!pool->attrs->affn_strict && 12688639ecebSTejun Heo !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) { 12698639ecebSTejun Heo struct work_struct *work = list_first_entry(&pool->worklist, 12708639ecebSTejun Heo struct work_struct, entry); 127157a01eafSSven Schnelle int wake_cpu = cpumask_any_and_distribute(pool->attrs->__pod_cpumask, 127257a01eafSSven Schnelle cpu_online_mask); 127357a01eafSSven Schnelle if (wake_cpu < nr_cpu_ids) { 127457a01eafSSven Schnelle p->wake_cpu = wake_cpu; 12758639ecebSTejun Heo get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++; 12768639ecebSTejun Heo } 127757a01eafSSven Schnelle } 12788639ecebSTejun Heo #endif 12798639ecebSTejun Heo wake_up_process(p); 12800219a352STejun Heo return true; 1281797e8345STejun Heo } 1282797e8345STejun Heo 128363638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT 128463638450STejun Heo 128563638450STejun Heo /* 128663638450STejun Heo * Concurrency-managed per-cpu work items that hog CPU for longer than 128763638450STejun Heo * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism, 128863638450STejun Heo * which prevents them from stalling other concurrency-managed work items. If a 128963638450STejun Heo * work function keeps triggering this mechanism, it's likely that the work item 129063638450STejun Heo * should be using an unbound workqueue instead. 129163638450STejun Heo * 129263638450STejun Heo * wq_cpu_intensive_report() tracks work functions which trigger such conditions 129363638450STejun Heo * and report them so that they can be examined and converted to use unbound 129463638450STejun Heo * workqueues as appropriate. To avoid flooding the console, each violating work 129563638450STejun Heo * function is tracked and reported with exponential backoff. 129663638450STejun Heo */ 129763638450STejun Heo #define WCI_MAX_ENTS 128 129863638450STejun Heo 129963638450STejun Heo struct wci_ent { 130063638450STejun Heo work_func_t func; 130163638450STejun Heo atomic64_t cnt; 130263638450STejun Heo struct hlist_node hash_node; 130363638450STejun Heo }; 130463638450STejun Heo 130563638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS]; 130663638450STejun Heo static int wci_nr_ents; 130763638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock); 130863638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS)); 130963638450STejun Heo 131063638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func) 131163638450STejun Heo { 131263638450STejun Heo struct wci_ent *ent; 131363638450STejun Heo 131463638450STejun Heo hash_for_each_possible_rcu(wci_hash, ent, hash_node, 131563638450STejun Heo (unsigned long)func) { 131663638450STejun Heo if (ent->func == func) 131763638450STejun Heo return ent; 131863638450STejun Heo } 131963638450STejun Heo return NULL; 132063638450STejun Heo } 132163638450STejun Heo 132263638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) 132363638450STejun Heo { 132463638450STejun Heo struct wci_ent *ent; 132563638450STejun Heo 132663638450STejun Heo restart: 132763638450STejun Heo ent = wci_find_ent(func); 132863638450STejun Heo if (ent) { 132963638450STejun Heo u64 cnt; 133063638450STejun Heo 133163638450STejun Heo /* 1332ccdec921SXuewen Yan * Start reporting from the warning_thresh and back off 133363638450STejun Heo * exponentially. 133463638450STejun Heo */ 133563638450STejun Heo cnt = atomic64_inc_return_relaxed(&ent->cnt); 1336ccdec921SXuewen Yan if (wq_cpu_intensive_warning_thresh && 1337ccdec921SXuewen Yan cnt >= wq_cpu_intensive_warning_thresh && 1338ccdec921SXuewen Yan is_power_of_2(cnt + 1 - wq_cpu_intensive_warning_thresh)) 133963638450STejun Heo printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n", 134063638450STejun Heo ent->func, wq_cpu_intensive_thresh_us, 134163638450STejun Heo atomic64_read(&ent->cnt)); 134263638450STejun Heo return; 134363638450STejun Heo } 134463638450STejun Heo 134563638450STejun Heo /* 134663638450STejun Heo * @func is a new violation. Allocate a new entry for it. If wcn_ents[] 134763638450STejun Heo * is exhausted, something went really wrong and we probably made enough 134863638450STejun Heo * noise already. 134963638450STejun Heo */ 135063638450STejun Heo if (wci_nr_ents >= WCI_MAX_ENTS) 135163638450STejun Heo return; 135263638450STejun Heo 135363638450STejun Heo raw_spin_lock(&wci_lock); 135463638450STejun Heo 135563638450STejun Heo if (wci_nr_ents >= WCI_MAX_ENTS) { 135663638450STejun Heo raw_spin_unlock(&wci_lock); 135763638450STejun Heo return; 135863638450STejun Heo } 135963638450STejun Heo 136063638450STejun Heo if (wci_find_ent(func)) { 136163638450STejun Heo raw_spin_unlock(&wci_lock); 136263638450STejun Heo goto restart; 136363638450STejun Heo } 136463638450STejun Heo 136563638450STejun Heo ent = &wci_ents[wci_nr_ents++]; 136663638450STejun Heo ent->func = func; 1367ccdec921SXuewen Yan atomic64_set(&ent->cnt, 0); 136863638450STejun Heo hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func); 136963638450STejun Heo 137063638450STejun Heo raw_spin_unlock(&wci_lock); 1371ccdec921SXuewen Yan 1372ccdec921SXuewen Yan goto restart; 137363638450STejun Heo } 137463638450STejun Heo 137563638450STejun Heo #else /* CONFIG_WQ_CPU_INTENSIVE_REPORT */ 137663638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {} 137763638450STejun Heo #endif /* CONFIG_WQ_CPU_INTENSIVE_REPORT */ 137863638450STejun Heo 1379c54d5046STejun Heo /** 13801da177e4SLinus Torvalds * wq_worker_running - a worker is running again 13811da177e4SLinus Torvalds * @task: task waking up 13821da177e4SLinus Torvalds * 13831da177e4SLinus Torvalds * This function is called when a worker returns from schedule() 13841da177e4SLinus Torvalds */ 13851da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task) 13861da177e4SLinus Torvalds { 13871da177e4SLinus Torvalds struct worker *worker = kthread_data(task); 13881da177e4SLinus Torvalds 1389c8f6219bSZqiang if (!READ_ONCE(worker->sleeping)) 13901da177e4SLinus Torvalds return; 13911da177e4SLinus Torvalds 13921da177e4SLinus Torvalds /* 13931da177e4SLinus Torvalds * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check 13941da177e4SLinus Torvalds * and the nr_running increment below, we may ruin the nr_running reset 13951da177e4SLinus Torvalds * and leave with an unexpected pool->nr_running == 1 on the newly unbound 13961da177e4SLinus Torvalds * pool. Protect against such race. 13971da177e4SLinus Torvalds */ 13981da177e4SLinus Torvalds preempt_disable(); 13991da177e4SLinus Torvalds if (!(worker->flags & WORKER_NOT_RUNNING)) 14001da177e4SLinus Torvalds worker->pool->nr_running++; 14011da177e4SLinus Torvalds preempt_enable(); 1402616db877STejun Heo 1403616db877STejun Heo /* 1404616db877STejun Heo * CPU intensive auto-detection cares about how long a work item hogged 1405616db877STejun Heo * CPU without sleeping. Reset the starting timestamp on wakeup. 1406616db877STejun Heo */ 1407616db877STejun Heo worker->current_at = worker->task->se.sum_exec_runtime; 1408616db877STejun Heo 1409c8f6219bSZqiang WRITE_ONCE(worker->sleeping, 0); 14101da177e4SLinus Torvalds } 14111da177e4SLinus Torvalds 14121da177e4SLinus Torvalds /** 14131da177e4SLinus Torvalds * wq_worker_sleeping - a worker is going to sleep 14141da177e4SLinus Torvalds * @task: task going to sleep 14151da177e4SLinus Torvalds * 14161da177e4SLinus Torvalds * This function is called from schedule() when a busy worker is 14171da177e4SLinus Torvalds * going to sleep. 14181da177e4SLinus Torvalds */ 14191da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task) 14201da177e4SLinus Torvalds { 14211da177e4SLinus Torvalds struct worker *worker = kthread_data(task); 14221da177e4SLinus Torvalds struct worker_pool *pool; 14231da177e4SLinus Torvalds 14241da177e4SLinus Torvalds /* 14251da177e4SLinus Torvalds * Rescuers, which may not have all the fields set up like normal 14261da177e4SLinus Torvalds * workers, also reach here, let's not access anything before 14271da177e4SLinus Torvalds * checking NOT_RUNNING. 14281da177e4SLinus Torvalds */ 14291da177e4SLinus Torvalds if (worker->flags & WORKER_NOT_RUNNING) 14301da177e4SLinus Torvalds return; 14311da177e4SLinus Torvalds 14321da177e4SLinus Torvalds pool = worker->pool; 14331da177e4SLinus Torvalds 14341da177e4SLinus Torvalds /* Return if preempted before wq_worker_running() was reached */ 1435c8f6219bSZqiang if (READ_ONCE(worker->sleeping)) 14361da177e4SLinus Torvalds return; 14371da177e4SLinus Torvalds 1438c8f6219bSZqiang WRITE_ONCE(worker->sleeping, 1); 14391da177e4SLinus Torvalds raw_spin_lock_irq(&pool->lock); 14401da177e4SLinus Torvalds 14411da177e4SLinus Torvalds /* 14421da177e4SLinus Torvalds * Recheck in case unbind_workers() preempted us. We don't 14431da177e4SLinus Torvalds * want to decrement nr_running after the worker is unbound 14441da177e4SLinus Torvalds * and nr_running has been reset. 14451da177e4SLinus Torvalds */ 14461da177e4SLinus Torvalds if (worker->flags & WORKER_NOT_RUNNING) { 14471da177e4SLinus Torvalds raw_spin_unlock_irq(&pool->lock); 14481da177e4SLinus Torvalds return; 14491da177e4SLinus Torvalds } 14501da177e4SLinus Torvalds 14511da177e4SLinus Torvalds pool->nr_running--; 14520219a352STejun Heo if (kick_pool(pool)) 1453725e8ec5STejun Heo worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++; 14540219a352STejun Heo 14551da177e4SLinus Torvalds raw_spin_unlock_irq(&pool->lock); 14561da177e4SLinus Torvalds } 14571da177e4SLinus Torvalds 14581da177e4SLinus Torvalds /** 1459616db877STejun Heo * wq_worker_tick - a scheduler tick occurred while a kworker is running 1460616db877STejun Heo * @task: task currently running 1461616db877STejun Heo * 146286dd6c04SIngo Molnar * Called from sched_tick(). We're in the IRQ context and the current 1463616db877STejun Heo * worker's fields which follow the 'K' locking rule can be accessed safely. 1464616db877STejun Heo */ 1465616db877STejun Heo void wq_worker_tick(struct task_struct *task) 1466616db877STejun Heo { 1467616db877STejun Heo struct worker *worker = kthread_data(task); 1468616db877STejun Heo struct pool_workqueue *pwq = worker->current_pwq; 1469616db877STejun Heo struct worker_pool *pool = worker->pool; 1470616db877STejun Heo 1471616db877STejun Heo if (!pwq) 1472616db877STejun Heo return; 1473616db877STejun Heo 14748a1dd1e5STejun Heo pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC; 14758a1dd1e5STejun Heo 147618c8ae81SZqiang if (!wq_cpu_intensive_thresh_us) 147718c8ae81SZqiang return; 147818c8ae81SZqiang 1479616db877STejun Heo /* 1480616db877STejun Heo * If the current worker is concurrency managed and hogged the CPU for 1481616db877STejun Heo * longer than wq_cpu_intensive_thresh_us, it's automatically marked 1482616db877STejun Heo * CPU_INTENSIVE to avoid stalling other concurrency-managed work items. 1483c8f6219bSZqiang * 1484c8f6219bSZqiang * Set @worker->sleeping means that @worker is in the process of 1485c8f6219bSZqiang * switching out voluntarily and won't be contributing to 1486c8f6219bSZqiang * @pool->nr_running until it wakes up. As wq_worker_sleeping() also 1487c8f6219bSZqiang * decrements ->nr_running, setting CPU_INTENSIVE here can lead to 1488c8f6219bSZqiang * double decrements. The task is releasing the CPU anyway. Let's skip. 1489c8f6219bSZqiang * We probably want to make this prettier in the future. 1490616db877STejun Heo */ 1491c8f6219bSZqiang if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) || 1492616db877STejun Heo worker->task->se.sum_exec_runtime - worker->current_at < 1493616db877STejun Heo wq_cpu_intensive_thresh_us * NSEC_PER_USEC) 1494616db877STejun Heo return; 1495616db877STejun Heo 1496616db877STejun Heo raw_spin_lock(&pool->lock); 1497616db877STejun Heo 1498616db877STejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE); 149963638450STejun Heo wq_cpu_intensive_report(worker->current_func); 1500616db877STejun Heo pwq->stats[PWQ_STAT_CPU_INTENSIVE]++; 1501616db877STejun Heo 15020219a352STejun Heo if (kick_pool(pool)) 1503616db877STejun Heo pwq->stats[PWQ_STAT_CM_WAKEUP]++; 1504616db877STejun Heo 1505616db877STejun Heo raw_spin_unlock(&pool->lock); 1506616db877STejun Heo } 1507616db877STejun Heo 1508616db877STejun Heo /** 15091da177e4SLinus Torvalds * wq_worker_last_func - retrieve worker's last work function 15101da177e4SLinus Torvalds * @task: Task to retrieve last work function of. 15111da177e4SLinus Torvalds * 15121da177e4SLinus Torvalds * Determine the last function a worker executed. This is called from 15131da177e4SLinus Torvalds * the scheduler to get a worker's last known identity. 15141da177e4SLinus Torvalds * 15159b41ea72SAndrew Morton * CONTEXT: 15161da177e4SLinus Torvalds * raw_spin_lock_irq(rq->lock) 15171da177e4SLinus Torvalds * 1518f756d5e2SNathan Lynch * This function is called during schedule() when a kworker is going 1519f756d5e2SNathan Lynch * to sleep. It's used by psi to identify aggregation workers during 15201da177e4SLinus Torvalds * dequeuing, to allow periodic aggregation to shut-off when that 15211da177e4SLinus Torvalds * worker is the last task in the system or cgroup to go to sleep. 15221da177e4SLinus Torvalds * 15231da177e4SLinus Torvalds * As this function doesn't involve any workqueue-related locking, it 15241da177e4SLinus Torvalds * only returns stable values when called from inside the scheduler's 15251da177e4SLinus Torvalds * queuing and dequeuing paths, when @task, which must be a kworker, 1526365970a1SDavid Howells * is guaranteed to not be processing any works. 1527365970a1SDavid Howells * 1528365970a1SDavid Howells * Return: 1529365970a1SDavid Howells * The last work function %current executed as a worker, NULL if it 1530365970a1SDavid Howells * hasn't executed any work yet. 1531365970a1SDavid Howells */ 1532365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task) 1533365970a1SDavid Howells { 1534365970a1SDavid Howells struct worker *worker = kthread_data(task); 1535365970a1SDavid Howells 1536365970a1SDavid Howells return worker->last_func; 1537365970a1SDavid Howells } 1538365970a1SDavid Howells 1539d302f017STejun Heo /** 154091ccc6e7STejun Heo * wq_node_nr_active - Determine wq_node_nr_active to use 154191ccc6e7STejun Heo * @wq: workqueue of interest 154291ccc6e7STejun Heo * @node: NUMA node, can be %NUMA_NO_NODE 154391ccc6e7STejun Heo * 154491ccc6e7STejun Heo * Determine wq_node_nr_active to use for @wq on @node. Returns: 154591ccc6e7STejun Heo * 154691ccc6e7STejun Heo * - %NULL for per-cpu workqueues as they don't need to use shared nr_active. 154791ccc6e7STejun Heo * 154891ccc6e7STejun Heo * - node_nr_active[nr_node_ids] if @node is %NUMA_NO_NODE. 154991ccc6e7STejun Heo * 155091ccc6e7STejun Heo * - Otherwise, node_nr_active[@node]. 155191ccc6e7STejun Heo */ 155291ccc6e7STejun Heo static struct wq_node_nr_active *wq_node_nr_active(struct workqueue_struct *wq, 155391ccc6e7STejun Heo int node) 155491ccc6e7STejun Heo { 155591ccc6e7STejun Heo if (!(wq->flags & WQ_UNBOUND)) 155691ccc6e7STejun Heo return NULL; 155791ccc6e7STejun Heo 155891ccc6e7STejun Heo if (node == NUMA_NO_NODE) 155991ccc6e7STejun Heo node = nr_node_ids; 156091ccc6e7STejun Heo 156191ccc6e7STejun Heo return wq->node_nr_active[node]; 156291ccc6e7STejun Heo } 156391ccc6e7STejun Heo 156491ccc6e7STejun Heo /** 15655797b1c1STejun Heo * wq_update_node_max_active - Update per-node max_actives to use 15665797b1c1STejun Heo * @wq: workqueue to update 15675797b1c1STejun Heo * @off_cpu: CPU that's going down, -1 if a CPU is not going down 15685797b1c1STejun Heo * 15695797b1c1STejun Heo * Update @wq->node_nr_active[]->max. @wq must be unbound. max_active is 15705797b1c1STejun Heo * distributed among nodes according to the proportions of numbers of online 15715797b1c1STejun Heo * cpus. The result is always between @wq->min_active and max_active. 15725797b1c1STejun Heo */ 15735797b1c1STejun Heo static void wq_update_node_max_active(struct workqueue_struct *wq, int off_cpu) 15745797b1c1STejun Heo { 15755797b1c1STejun Heo struct cpumask *effective = unbound_effective_cpumask(wq); 15765797b1c1STejun Heo int min_active = READ_ONCE(wq->min_active); 15775797b1c1STejun Heo int max_active = READ_ONCE(wq->max_active); 15785797b1c1STejun Heo int total_cpus, node; 15795797b1c1STejun Heo 15805797b1c1STejun Heo lockdep_assert_held(&wq->mutex); 15815797b1c1STejun Heo 1582c5f8cd6cSTejun Heo if (!wq_topo_initialized) 1583c5f8cd6cSTejun Heo return; 1584c5f8cd6cSTejun Heo 158515930da4STejun Heo if (off_cpu >= 0 && !cpumask_test_cpu(off_cpu, effective)) 15865797b1c1STejun Heo off_cpu = -1; 15875797b1c1STejun Heo 15885797b1c1STejun Heo total_cpus = cpumask_weight_and(effective, cpu_online_mask); 15895797b1c1STejun Heo if (off_cpu >= 0) 15905797b1c1STejun Heo total_cpus--; 15915797b1c1STejun Heo 159291f09870SLai Jiangshan /* If all CPUs of the wq get offline, use the default values */ 159391f09870SLai Jiangshan if (unlikely(!total_cpus)) { 159491f09870SLai Jiangshan for_each_node(node) 159591f09870SLai Jiangshan wq_node_nr_active(wq, node)->max = min_active; 159691f09870SLai Jiangshan 159791f09870SLai Jiangshan wq_node_nr_active(wq, NUMA_NO_NODE)->max = max_active; 159891f09870SLai Jiangshan return; 159991f09870SLai Jiangshan } 160091f09870SLai Jiangshan 16015797b1c1STejun Heo for_each_node(node) { 16025797b1c1STejun Heo int node_cpus; 16035797b1c1STejun Heo 16045797b1c1STejun Heo node_cpus = cpumask_weight_and(effective, cpumask_of_node(node)); 16055797b1c1STejun Heo if (off_cpu >= 0 && cpu_to_node(off_cpu) == node) 16065797b1c1STejun Heo node_cpus--; 16075797b1c1STejun Heo 16085797b1c1STejun Heo wq_node_nr_active(wq, node)->max = 16095797b1c1STejun Heo clamp(DIV_ROUND_UP(max_active * node_cpus, total_cpus), 16105797b1c1STejun Heo min_active, max_active); 16115797b1c1STejun Heo } 16125797b1c1STejun Heo 1613d40f9202STejun Heo wq_node_nr_active(wq, NUMA_NO_NODE)->max = max_active; 16145797b1c1STejun Heo } 16155797b1c1STejun Heo 16165797b1c1STejun Heo /** 16178864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 16188864b4e5STejun Heo * @pwq: pool_workqueue to get 16198864b4e5STejun Heo * 16208864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 16218864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 16228864b4e5STejun Heo */ 16238864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 16248864b4e5STejun Heo { 16258864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 16268864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 16278864b4e5STejun Heo pwq->refcnt++; 16288864b4e5STejun Heo } 16298864b4e5STejun Heo 16308864b4e5STejun Heo /** 16318864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 16328864b4e5STejun Heo * @pwq: pool_workqueue to put 16338864b4e5STejun Heo * 16348864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 16358864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 16368864b4e5STejun Heo */ 16378864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 16388864b4e5STejun Heo { 16398864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 16408864b4e5STejun Heo if (likely(--pwq->refcnt)) 16418864b4e5STejun Heo return; 16428864b4e5STejun Heo /* 1643967b494eSTejun Heo * @pwq can't be released under pool->lock, bounce to a dedicated 1644967b494eSTejun Heo * kthread_worker to avoid A-A deadlocks. 16458864b4e5STejun Heo */ 1646687a9aa5STejun Heo kthread_queue_work(pwq_release_worker, &pwq->release_work); 16478864b4e5STejun Heo } 16488864b4e5STejun Heo 1649dce90d47STejun Heo /** 1650dce90d47STejun Heo * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock 1651dce90d47STejun Heo * @pwq: pool_workqueue to put (can be %NULL) 1652dce90d47STejun Heo * 1653dce90d47STejun Heo * put_pwq() with locking. This function also allows %NULL @pwq. 1654dce90d47STejun Heo */ 1655dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq) 1656dce90d47STejun Heo { 1657dce90d47STejun Heo if (pwq) { 1658dce90d47STejun Heo /* 165924acfb71SThomas Gleixner * As both pwqs and pools are RCU protected, the 1660dce90d47STejun Heo * following lock operations are safe. 1661dce90d47STejun Heo */ 1662a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 1663dce90d47STejun Heo put_pwq(pwq); 1664a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 1665dce90d47STejun Heo } 1666dce90d47STejun Heo } 1667dce90d47STejun Heo 1668afa87ce8STejun Heo static bool pwq_is_empty(struct pool_workqueue *pwq) 1669afa87ce8STejun Heo { 1670afa87ce8STejun Heo return !pwq->nr_active && list_empty(&pwq->inactive_works); 1671afa87ce8STejun Heo } 1672afa87ce8STejun Heo 16734c638030STejun Heo static void __pwq_activate_work(struct pool_workqueue *pwq, 16744c638030STejun Heo struct work_struct *work) 1675bf4ede01STejun Heo { 16761c270b79STejun Heo unsigned long *wdb = work_data_bits(work); 16771c270b79STejun Heo 16781c270b79STejun Heo WARN_ON_ONCE(!(*wdb & WORK_STRUCT_INACTIVE)); 1679bf4ede01STejun Heo trace_workqueue_activate_work(work); 168082607adcSTejun Heo if (list_empty(&pwq->pool->worklist)) 168182607adcSTejun Heo pwq->pool->watchdog_ts = jiffies; 1682112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 16831c270b79STejun Heo __clear_bit(WORK_STRUCT_INACTIVE_BIT, wdb); 16844c638030STejun Heo } 16854c638030STejun Heo 16865797b1c1STejun Heo static bool tryinc_node_nr_active(struct wq_node_nr_active *nna) 16875797b1c1STejun Heo { 16885797b1c1STejun Heo int max = READ_ONCE(nna->max); 16895797b1c1STejun Heo 16905797b1c1STejun Heo while (true) { 16915797b1c1STejun Heo int old, tmp; 16925797b1c1STejun Heo 16935797b1c1STejun Heo old = atomic_read(&nna->nr); 16945797b1c1STejun Heo if (old >= max) 16955797b1c1STejun Heo return false; 16965797b1c1STejun Heo tmp = atomic_cmpxchg_relaxed(&nna->nr, old, old + 1); 16975797b1c1STejun Heo if (tmp == old) 16985797b1c1STejun Heo return true; 16995797b1c1STejun Heo } 17005797b1c1STejun Heo } 17015797b1c1STejun Heo 17021c270b79STejun Heo /** 17031c270b79STejun Heo * pwq_tryinc_nr_active - Try to increment nr_active for a pwq 17041c270b79STejun Heo * @pwq: pool_workqueue of interest 17055797b1c1STejun Heo * @fill: max_active may have increased, try to increase concurrency level 17061c270b79STejun Heo * 17071c270b79STejun Heo * Try to increment nr_active for @pwq. Returns %true if an nr_active count is 17081c270b79STejun Heo * successfully obtained. %false otherwise. 17091c270b79STejun Heo */ 17105797b1c1STejun Heo static bool pwq_tryinc_nr_active(struct pool_workqueue *pwq, bool fill) 17113aa62497SLai Jiangshan { 17121c270b79STejun Heo struct workqueue_struct *wq = pwq->wq; 17131c270b79STejun Heo struct worker_pool *pool = pwq->pool; 171491ccc6e7STejun Heo struct wq_node_nr_active *nna = wq_node_nr_active(wq, pool->node); 17155797b1c1STejun Heo bool obtained = false; 17161c270b79STejun Heo 17171c270b79STejun Heo lockdep_assert_held(&pool->lock); 17181c270b79STejun Heo 17195797b1c1STejun Heo if (!nna) { 17204cb1ef64STejun Heo /* BH or per-cpu workqueue, pwq->nr_active is sufficient */ 17211c270b79STejun Heo obtained = pwq->nr_active < READ_ONCE(wq->max_active); 17225797b1c1STejun Heo goto out; 172391ccc6e7STejun Heo } 17245797b1c1STejun Heo 17254c065dbcSWaiman Long if (unlikely(pwq->plugged)) 17264c065dbcSWaiman Long return false; 17274c065dbcSWaiman Long 17285797b1c1STejun Heo /* 17295797b1c1STejun Heo * Unbound workqueue uses per-node shared nr_active $nna. If @pwq is 17305797b1c1STejun Heo * already waiting on $nna, pwq_dec_nr_active() will maintain the 17315797b1c1STejun Heo * concurrency level. Don't jump the line. 17325797b1c1STejun Heo * 17335797b1c1STejun Heo * We need to ignore the pending test after max_active has increased as 17345797b1c1STejun Heo * pwq_dec_nr_active() can only maintain the concurrency level but not 17355797b1c1STejun Heo * increase it. This is indicated by @fill. 17365797b1c1STejun Heo */ 17375797b1c1STejun Heo if (!list_empty(&pwq->pending_node) && likely(!fill)) 17385797b1c1STejun Heo goto out; 17395797b1c1STejun Heo 17405797b1c1STejun Heo obtained = tryinc_node_nr_active(nna); 17415797b1c1STejun Heo if (obtained) 17425797b1c1STejun Heo goto out; 17435797b1c1STejun Heo 17445797b1c1STejun Heo /* 17455797b1c1STejun Heo * Lockless acquisition failed. Lock, add ourself to $nna->pending_pwqs 17465797b1c1STejun Heo * and try again. The smp_mb() is paired with the implied memory barrier 17475797b1c1STejun Heo * of atomic_dec_return() in pwq_dec_nr_active() to ensure that either 17485797b1c1STejun Heo * we see the decremented $nna->nr or they see non-empty 17495797b1c1STejun Heo * $nna->pending_pwqs. 17505797b1c1STejun Heo */ 17515797b1c1STejun Heo raw_spin_lock(&nna->lock); 17525797b1c1STejun Heo 17535797b1c1STejun Heo if (list_empty(&pwq->pending_node)) 17545797b1c1STejun Heo list_add_tail(&pwq->pending_node, &nna->pending_pwqs); 17555797b1c1STejun Heo else if (likely(!fill)) 17565797b1c1STejun Heo goto out_unlock; 17575797b1c1STejun Heo 17585797b1c1STejun Heo smp_mb(); 17595797b1c1STejun Heo 17605797b1c1STejun Heo obtained = tryinc_node_nr_active(nna); 17615797b1c1STejun Heo 17625797b1c1STejun Heo /* 17635797b1c1STejun Heo * If @fill, @pwq might have already been pending. Being spuriously 17645797b1c1STejun Heo * pending in cold paths doesn't affect anything. Let's leave it be. 17655797b1c1STejun Heo */ 17665797b1c1STejun Heo if (obtained && likely(!fill)) 17675797b1c1STejun Heo list_del_init(&pwq->pending_node); 17685797b1c1STejun Heo 17695797b1c1STejun Heo out_unlock: 17705797b1c1STejun Heo raw_spin_unlock(&nna->lock); 17715797b1c1STejun Heo out: 17725797b1c1STejun Heo if (obtained) 17735797b1c1STejun Heo pwq->nr_active++; 17741c270b79STejun Heo return obtained; 17751c270b79STejun Heo } 17761c270b79STejun Heo 17771c270b79STejun Heo /** 17781c270b79STejun Heo * pwq_activate_first_inactive - Activate the first inactive work item on a pwq 17791c270b79STejun Heo * @pwq: pool_workqueue of interest 17805797b1c1STejun Heo * @fill: max_active may have increased, try to increase concurrency level 17811c270b79STejun Heo * 17821c270b79STejun Heo * Activate the first inactive work item of @pwq if available and allowed by 17831c270b79STejun Heo * max_active limit. 17841c270b79STejun Heo * 17851c270b79STejun Heo * Returns %true if an inactive work item has been activated. %false if no 17861c270b79STejun Heo * inactive work item is found or max_active limit is reached. 17871c270b79STejun Heo */ 17885797b1c1STejun Heo static bool pwq_activate_first_inactive(struct pool_workqueue *pwq, bool fill) 17891c270b79STejun Heo { 17901c270b79STejun Heo struct work_struct *work = 17911c270b79STejun Heo list_first_entry_or_null(&pwq->inactive_works, 17923aa62497SLai Jiangshan struct work_struct, entry); 17933aa62497SLai Jiangshan 17945797b1c1STejun Heo if (work && pwq_tryinc_nr_active(pwq, fill)) { 17951c270b79STejun Heo __pwq_activate_work(pwq, work); 17961c270b79STejun Heo return true; 17971c270b79STejun Heo } else { 17981c270b79STejun Heo return false; 17991c270b79STejun Heo } 18001c270b79STejun Heo } 18011c270b79STejun Heo 18021c270b79STejun Heo /** 1803516d3dc9SWaiman Long * unplug_oldest_pwq - unplug the oldest pool_workqueue 1804516d3dc9SWaiman Long * @wq: workqueue_struct where its oldest pwq is to be unplugged 18054c065dbcSWaiman Long * 1806516d3dc9SWaiman Long * This function should only be called for ordered workqueues where only the 1807516d3dc9SWaiman Long * oldest pwq is unplugged, the others are plugged to suspend execution to 1808516d3dc9SWaiman Long * ensure proper work item ordering:: 18094c065dbcSWaiman Long * 18104c065dbcSWaiman Long * dfl_pwq --------------+ [P] - plugged 18114c065dbcSWaiman Long * | 18124c065dbcSWaiman Long * v 18134c065dbcSWaiman Long * pwqs -> A -> B [P] -> C [P] (newest) 18144c065dbcSWaiman Long * | | | 18154c065dbcSWaiman Long * 1 3 5 18164c065dbcSWaiman Long * | | | 18174c065dbcSWaiman Long * 2 4 6 1818516d3dc9SWaiman Long * 1819516d3dc9SWaiman Long * When the oldest pwq is drained and removed, this function should be called 1820516d3dc9SWaiman Long * to unplug the next oldest one to start its work item execution. Note that 1821516d3dc9SWaiman Long * pwq's are linked into wq->pwqs with the oldest first, so the first one in 1822516d3dc9SWaiman Long * the list is the oldest. 18234c065dbcSWaiman Long */ 18244c065dbcSWaiman Long static void unplug_oldest_pwq(struct workqueue_struct *wq) 18254c065dbcSWaiman Long { 18264c065dbcSWaiman Long struct pool_workqueue *pwq; 18274c065dbcSWaiman Long 18284c065dbcSWaiman Long lockdep_assert_held(&wq->mutex); 18294c065dbcSWaiman Long 18304c065dbcSWaiman Long /* Caller should make sure that pwqs isn't empty before calling */ 18314c065dbcSWaiman Long pwq = list_first_entry_or_null(&wq->pwqs, struct pool_workqueue, 18324c065dbcSWaiman Long pwqs_node); 18334c065dbcSWaiman Long raw_spin_lock_irq(&pwq->pool->lock); 18344c065dbcSWaiman Long if (pwq->plugged) { 18354c065dbcSWaiman Long pwq->plugged = false; 18364c065dbcSWaiman Long if (pwq_activate_first_inactive(pwq, true)) 18374c065dbcSWaiman Long kick_pool(pwq->pool); 18384c065dbcSWaiman Long } 18394c065dbcSWaiman Long raw_spin_unlock_irq(&pwq->pool->lock); 18404c065dbcSWaiman Long } 18414c065dbcSWaiman Long 18424c065dbcSWaiman Long /** 18435797b1c1STejun Heo * node_activate_pending_pwq - Activate a pending pwq on a wq_node_nr_active 18445797b1c1STejun Heo * @nna: wq_node_nr_active to activate a pending pwq for 18455797b1c1STejun Heo * @caller_pool: worker_pool the caller is locking 18465797b1c1STejun Heo * 18475797b1c1STejun Heo * Activate a pwq in @nna->pending_pwqs. Called with @caller_pool locked. 18485797b1c1STejun Heo * @caller_pool may be unlocked and relocked to lock other worker_pools. 18495797b1c1STejun Heo */ 18505797b1c1STejun Heo static void node_activate_pending_pwq(struct wq_node_nr_active *nna, 18515797b1c1STejun Heo struct worker_pool *caller_pool) 18525797b1c1STejun Heo { 18535797b1c1STejun Heo struct worker_pool *locked_pool = caller_pool; 18545797b1c1STejun Heo struct pool_workqueue *pwq; 18555797b1c1STejun Heo struct work_struct *work; 18565797b1c1STejun Heo 18575797b1c1STejun Heo lockdep_assert_held(&caller_pool->lock); 18585797b1c1STejun Heo 18595797b1c1STejun Heo raw_spin_lock(&nna->lock); 18605797b1c1STejun Heo retry: 18615797b1c1STejun Heo pwq = list_first_entry_or_null(&nna->pending_pwqs, 18625797b1c1STejun Heo struct pool_workqueue, pending_node); 18635797b1c1STejun Heo if (!pwq) 18645797b1c1STejun Heo goto out_unlock; 18655797b1c1STejun Heo 18665797b1c1STejun Heo /* 18675797b1c1STejun Heo * If @pwq is for a different pool than @locked_pool, we need to lock 18685797b1c1STejun Heo * @pwq->pool->lock. Let's trylock first. If unsuccessful, do the unlock 18695797b1c1STejun Heo * / lock dance. For that, we also need to release @nna->lock as it's 18705797b1c1STejun Heo * nested inside pool locks. 18715797b1c1STejun Heo */ 18725797b1c1STejun Heo if (pwq->pool != locked_pool) { 18735797b1c1STejun Heo raw_spin_unlock(&locked_pool->lock); 18745797b1c1STejun Heo locked_pool = pwq->pool; 18755797b1c1STejun Heo if (!raw_spin_trylock(&locked_pool->lock)) { 18765797b1c1STejun Heo raw_spin_unlock(&nna->lock); 18775797b1c1STejun Heo raw_spin_lock(&locked_pool->lock); 18785797b1c1STejun Heo raw_spin_lock(&nna->lock); 18795797b1c1STejun Heo goto retry; 18805797b1c1STejun Heo } 18815797b1c1STejun Heo } 18825797b1c1STejun Heo 18835797b1c1STejun Heo /* 18845797b1c1STejun Heo * $pwq may not have any inactive work items due to e.g. cancellations. 18855797b1c1STejun Heo * Drop it from pending_pwqs and see if there's another one. 18865797b1c1STejun Heo */ 18875797b1c1STejun Heo work = list_first_entry_or_null(&pwq->inactive_works, 18885797b1c1STejun Heo struct work_struct, entry); 18895797b1c1STejun Heo if (!work) { 18905797b1c1STejun Heo list_del_init(&pwq->pending_node); 18915797b1c1STejun Heo goto retry; 18925797b1c1STejun Heo } 18935797b1c1STejun Heo 18945797b1c1STejun Heo /* 18955797b1c1STejun Heo * Acquire an nr_active count and activate the inactive work item. If 18965797b1c1STejun Heo * $pwq still has inactive work items, rotate it to the end of the 18975797b1c1STejun Heo * pending_pwqs so that we round-robin through them. This means that 18985797b1c1STejun Heo * inactive work items are not activated in queueing order which is fine 18995797b1c1STejun Heo * given that there has never been any ordering across different pwqs. 19005797b1c1STejun Heo */ 19015797b1c1STejun Heo if (likely(tryinc_node_nr_active(nna))) { 19025797b1c1STejun Heo pwq->nr_active++; 19035797b1c1STejun Heo __pwq_activate_work(pwq, work); 19045797b1c1STejun Heo 19055797b1c1STejun Heo if (list_empty(&pwq->inactive_works)) 19065797b1c1STejun Heo list_del_init(&pwq->pending_node); 19075797b1c1STejun Heo else 19085797b1c1STejun Heo list_move_tail(&pwq->pending_node, &nna->pending_pwqs); 19095797b1c1STejun Heo 19105797b1c1STejun Heo /* if activating a foreign pool, make sure it's running */ 19115797b1c1STejun Heo if (pwq->pool != caller_pool) 19125797b1c1STejun Heo kick_pool(pwq->pool); 19135797b1c1STejun Heo } 19145797b1c1STejun Heo 19155797b1c1STejun Heo out_unlock: 19165797b1c1STejun Heo raw_spin_unlock(&nna->lock); 19175797b1c1STejun Heo if (locked_pool != caller_pool) { 19185797b1c1STejun Heo raw_spin_unlock(&locked_pool->lock); 19195797b1c1STejun Heo raw_spin_lock(&caller_pool->lock); 19205797b1c1STejun Heo } 19215797b1c1STejun Heo } 19225797b1c1STejun Heo 19235797b1c1STejun Heo /** 19241c270b79STejun Heo * pwq_dec_nr_active - Retire an active count 19251c270b79STejun Heo * @pwq: pool_workqueue of interest 19261c270b79STejun Heo * 19271c270b79STejun Heo * Decrement @pwq's nr_active and try to activate the first inactive work item. 19285797b1c1STejun Heo * For unbound workqueues, this function may temporarily drop @pwq->pool->lock. 19291c270b79STejun Heo */ 19301c270b79STejun Heo static void pwq_dec_nr_active(struct pool_workqueue *pwq) 19311c270b79STejun Heo { 19321c270b79STejun Heo struct worker_pool *pool = pwq->pool; 193391ccc6e7STejun Heo struct wq_node_nr_active *nna = wq_node_nr_active(pwq->wq, pool->node); 19341c270b79STejun Heo 19351c270b79STejun Heo lockdep_assert_held(&pool->lock); 19361c270b79STejun Heo 193791ccc6e7STejun Heo /* 193891ccc6e7STejun Heo * @pwq->nr_active should be decremented for both percpu and unbound 193991ccc6e7STejun Heo * workqueues. 194091ccc6e7STejun Heo */ 19411c270b79STejun Heo pwq->nr_active--; 194291ccc6e7STejun Heo 194391ccc6e7STejun Heo /* 194491ccc6e7STejun Heo * For a percpu workqueue, it's simple. Just need to kick the first 194591ccc6e7STejun Heo * inactive work item on @pwq itself. 194691ccc6e7STejun Heo */ 194791ccc6e7STejun Heo if (!nna) { 19485797b1c1STejun Heo pwq_activate_first_inactive(pwq, false); 194991ccc6e7STejun Heo return; 195091ccc6e7STejun Heo } 195191ccc6e7STejun Heo 19525797b1c1STejun Heo /* 19535797b1c1STejun Heo * If @pwq is for an unbound workqueue, it's more complicated because 19545797b1c1STejun Heo * multiple pwqs and pools may be sharing the nr_active count. When a 19555797b1c1STejun Heo * pwq needs to wait for an nr_active count, it puts itself on 19565797b1c1STejun Heo * $nna->pending_pwqs. The following atomic_dec_return()'s implied 19575797b1c1STejun Heo * memory barrier is paired with smp_mb() in pwq_tryinc_nr_active() to 19585797b1c1STejun Heo * guarantee that either we see non-empty pending_pwqs or they see 19595797b1c1STejun Heo * decremented $nna->nr. 19605797b1c1STejun Heo * 19615797b1c1STejun Heo * $nna->max may change as CPUs come online/offline and @pwq->wq's 19625797b1c1STejun Heo * max_active gets updated. However, it is guaranteed to be equal to or 19635797b1c1STejun Heo * larger than @pwq->wq->min_active which is above zero unless freezing. 19645797b1c1STejun Heo * This maintains the forward progress guarantee. 19655797b1c1STejun Heo */ 19665797b1c1STejun Heo if (atomic_dec_return(&nna->nr) >= READ_ONCE(nna->max)) 19675797b1c1STejun Heo return; 19685797b1c1STejun Heo 19695797b1c1STejun Heo if (!list_empty(&nna->pending_pwqs)) 19705797b1c1STejun Heo node_activate_pending_pwq(nna, pool); 19713aa62497SLai Jiangshan } 19723aa62497SLai Jiangshan 1973bf4ede01STejun Heo /** 1974112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1975112202d9STejun Heo * @pwq: pwq of interest 1976c4560c2cSLai Jiangshan * @work_data: work_data of work which left the queue 1977bf4ede01STejun Heo * 1978bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1979112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1980bf4ede01STejun Heo * 1981dd6c3c54STejun Heo * NOTE: 1982dd6c3c54STejun Heo * For unbound workqueues, this function may temporarily drop @pwq->pool->lock 1983dd6c3c54STejun Heo * and thus should be called after all other state updates for the in-flight 1984dd6c3c54STejun Heo * work item is complete. 1985dd6c3c54STejun Heo * 1986bf4ede01STejun Heo * CONTEXT: 1987a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1988bf4ede01STejun Heo */ 1989c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data) 1990bf4ede01STejun Heo { 1991c4560c2cSLai Jiangshan int color = get_work_color(work_data); 1992c4560c2cSLai Jiangshan 19931c270b79STejun Heo if (!(work_data & WORK_STRUCT_INACTIVE)) 19941c270b79STejun Heo pwq_dec_nr_active(pwq); 1995018f3a13SLai Jiangshan 1996018f3a13SLai Jiangshan pwq->nr_in_flight[color]--; 1997bf4ede01STejun Heo 1998bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1999112202d9STejun Heo if (likely(pwq->flush_color != color)) 20008864b4e5STejun Heo goto out_put; 2001bf4ede01STejun Heo 2002bf4ede01STejun Heo /* are there still in-flight works? */ 2003112202d9STejun Heo if (pwq->nr_in_flight[color]) 20048864b4e5STejun Heo goto out_put; 2005bf4ede01STejun Heo 2006112202d9STejun Heo /* this pwq is done, clear flush_color */ 2007112202d9STejun Heo pwq->flush_color = -1; 2008bf4ede01STejun Heo 2009bf4ede01STejun Heo /* 2010112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 2011bf4ede01STejun Heo * will handle the rest. 2012bf4ede01STejun Heo */ 2013112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 2014112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 20158864b4e5STejun Heo out_put: 20168864b4e5STejun Heo put_pwq(pwq); 2017bf4ede01STejun Heo } 2018bf4ede01STejun Heo 201936e227d2STejun Heo /** 2020bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 202136e227d2STejun Heo * @work: work item to steal 2022c5f5b942STejun Heo * @cflags: %WORK_CANCEL_ flags 2023c26e2f2eSTejun Heo * @irq_flags: place to store irq state 202436e227d2STejun Heo * 202536e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 2026d185af30SYacine Belkadi * stable state - idle, on timer or on worklist. 202736e227d2STejun Heo * 2028d185af30SYacine Belkadi * Return: 20293eb6b31bSMauro Carvalho Chehab * 20303eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 203136e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 203236e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 203336e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 20343eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 203536e227d2STejun Heo * 2036d185af30SYacine Belkadi * Note: 2037bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 2038e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 2039e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 2040e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 2041bbb68dfaSTejun Heo * 2042bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 2043c26e2f2eSTejun Heo * responsible for releasing it using local_irq_restore(*@irq_flags). 2044bbb68dfaSTejun Heo * 2045e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 2046bf4ede01STejun Heo */ 2047c5f5b942STejun Heo static int try_to_grab_pending(struct work_struct *work, u32 cflags, 2048c26e2f2eSTejun Heo unsigned long *irq_flags) 2049bf4ede01STejun Heo { 2050d565ed63STejun Heo struct worker_pool *pool; 2051112202d9STejun Heo struct pool_workqueue *pwq; 2052bf4ede01STejun Heo 2053c26e2f2eSTejun Heo local_irq_save(*irq_flags); 2054bbb68dfaSTejun Heo 205536e227d2STejun Heo /* try to steal the timer if it exists */ 2056c5f5b942STejun Heo if (cflags & WORK_CANCEL_DELAYED) { 205736e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 205836e227d2STejun Heo 2059e0aecdd8STejun Heo /* 2060e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 2061e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 2062e0aecdd8STejun Heo * running on the local CPU. 2063e0aecdd8STejun Heo */ 206436e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 206536e227d2STejun Heo return 1; 206636e227d2STejun Heo } 206736e227d2STejun Heo 206836e227d2STejun Heo /* try to claim PENDING the normal way */ 2069bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 2070bf4ede01STejun Heo return 0; 2071bf4ede01STejun Heo 207224acfb71SThomas Gleixner rcu_read_lock(); 2073bf4ede01STejun Heo /* 2074bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 2075bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 2076bf4ede01STejun Heo */ 2077d565ed63STejun Heo pool = get_work_pool(work); 2078d565ed63STejun Heo if (!pool) 2079bbb68dfaSTejun Heo goto fail; 2080bf4ede01STejun Heo 2081a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&pool->lock); 2082bf4ede01STejun Heo /* 2083112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 2084112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 2085112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 2086112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 2087112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 20880b3dae68SLai Jiangshan * item is currently queued on that pool. 2089bf4ede01STejun Heo */ 2090112202d9STejun Heo pwq = get_work_pwq(work); 2091112202d9STejun Heo if (pwq && pwq->pool == pool) { 2092b56c7207SLai Jiangshan unsigned long work_data = *work_data_bits(work); 2093c70e1779STejun Heo 2094bf4ede01STejun Heo debug_work_deactivate(work); 20953aa62497SLai Jiangshan 20963aa62497SLai Jiangshan /* 2097018f3a13SLai Jiangshan * A cancelable inactive work item must be in the 2098018f3a13SLai Jiangshan * pwq->inactive_works since a queued barrier can't be 2099018f3a13SLai Jiangshan * canceled (see the comments in insert_wq_barrier()). 2100018f3a13SLai Jiangshan * 2101b56c7207SLai Jiangshan * An inactive work item cannot be deleted directly because 2102d812796eSLai Jiangshan * it might have linked barrier work items which, if left 2103f97a4a1aSLai Jiangshan * on the inactive_works list, will confuse pwq->nr_active 2104b56c7207SLai Jiangshan * management later on and cause stall. Move the linked 2105b56c7207SLai Jiangshan * barrier work items to the worklist when deleting the grabbed 2106b56c7207SLai Jiangshan * item. Also keep WORK_STRUCT_INACTIVE in work_data, so that 2107b56c7207SLai Jiangshan * it doesn't participate in nr_active management in later 2108b56c7207SLai Jiangshan * pwq_dec_nr_in_flight(). 21093aa62497SLai Jiangshan */ 2110b56c7207SLai Jiangshan if (work_data & WORK_STRUCT_INACTIVE) 2111b56c7207SLai Jiangshan move_linked_works(work, &pwq->pool->worklist, NULL); 21123aa62497SLai Jiangshan 2113bf4ede01STejun Heo list_del_init(&work->entry); 211436e227d2STejun Heo 2115c70e1779STejun Heo /* 2116c70e1779STejun Heo * work->data points to pwq iff queued. Let's point to pool. As 2117c70e1779STejun Heo * this destroys work->data needed by the next step, stash it. 2118c70e1779STejun Heo */ 2119456a78eeSTejun Heo set_work_pool_and_keep_pending(work, pool->id, 2120456a78eeSTejun Heo pool_offq_flags(pool)); 21214468a00fSLai Jiangshan 2122dd6c3c54STejun Heo /* must be the last step, see the function comment */ 2123c70e1779STejun Heo pwq_dec_nr_in_flight(pwq, work_data); 2124dd6c3c54STejun Heo 2125a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 212624acfb71SThomas Gleixner rcu_read_unlock(); 212736e227d2STejun Heo return 1; 2128bf4ede01STejun Heo } 2129a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 2130bbb68dfaSTejun Heo fail: 213124acfb71SThomas Gleixner rcu_read_unlock(); 2132c26e2f2eSTejun Heo local_irq_restore(*irq_flags); 213336e227d2STejun Heo return -EAGAIN; 2134bf4ede01STejun Heo } 2135bf4ede01STejun Heo 2136978b8409STejun Heo /** 2137978b8409STejun Heo * work_grab_pending - steal work item from worklist and disable irq 2138978b8409STejun Heo * @work: work item to steal 2139978b8409STejun Heo * @cflags: %WORK_CANCEL_ flags 2140978b8409STejun Heo * @irq_flags: place to store IRQ state 2141978b8409STejun Heo * 2142978b8409STejun Heo * Grab PENDING bit of @work. @work can be in any stable state - idle, on timer 2143978b8409STejun Heo * or on worklist. 2144978b8409STejun Heo * 2145f09b10b6STejun Heo * Can be called from any context. IRQ is disabled on return with IRQ state 2146978b8409STejun Heo * stored in *@irq_flags. The caller is responsible for re-enabling it using 2147978b8409STejun Heo * local_irq_restore(). 2148978b8409STejun Heo * 2149978b8409STejun Heo * Returns %true if @work was pending. %false if idle. 2150978b8409STejun Heo */ 2151978b8409STejun Heo static bool work_grab_pending(struct work_struct *work, u32 cflags, 2152978b8409STejun Heo unsigned long *irq_flags) 2153978b8409STejun Heo { 2154978b8409STejun Heo int ret; 2155978b8409STejun Heo 2156f09b10b6STejun Heo while (true) { 2157978b8409STejun Heo ret = try_to_grab_pending(work, cflags, irq_flags); 2158f09b10b6STejun Heo if (ret >= 0) 2159978b8409STejun Heo return ret; 2160f09b10b6STejun Heo cpu_relax(); 2161f09b10b6STejun Heo } 2162978b8409STejun Heo } 2163978b8409STejun Heo 2164bf4ede01STejun Heo /** 2165706026c2STejun Heo * insert_work - insert a work into a pool 2166112202d9STejun Heo * @pwq: pwq @work belongs to 21674690c4abSTejun Heo * @work: work to insert 21684690c4abSTejun Heo * @head: insertion point 21694690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 21704690c4abSTejun Heo * 2171112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 2172706026c2STejun Heo * work_struct flags. 21734690c4abSTejun Heo * 21744690c4abSTejun Heo * CONTEXT: 2175a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 2176365970a1SDavid Howells */ 2177112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 2178112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 2179b89deed3SOleg Nesterov { 2180fe089f87STejun Heo debug_work_activate(work); 2181e1d8aa9fSFrederic Weisbecker 2182e89a85d6SWalter Wu /* record the work call stack in order to print it in KASAN reports */ 2183f70da745SMarco Elver kasan_record_aux_stack_noalloc(work); 2184e89a85d6SWalter Wu 21854690c4abSTejun Heo /* we own @work, set data and link */ 2186112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 21871a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 21888864b4e5STejun Heo get_pwq(pwq); 2189b89deed3SOleg Nesterov } 2190b89deed3SOleg Nesterov 2191c8efcc25STejun Heo /* 2192c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 21938d03ecfeSTejun Heo * same workqueue. 2194c8efcc25STejun Heo */ 2195c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 2196c8efcc25STejun Heo { 2197c8efcc25STejun Heo struct worker *worker; 2198c8efcc25STejun Heo 21998d03ecfeSTejun Heo worker = current_wq_worker(); 2200c8efcc25STejun Heo /* 2201bf393fd4SBart Van Assche * Return %true iff I'm a worker executing a work item on @wq. If 22028d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 2203c8efcc25STejun Heo */ 2204112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 2205c8efcc25STejun Heo } 2206c8efcc25STejun Heo 2207ef557180SMike Galbraith /* 2208ef557180SMike Galbraith * When queueing an unbound work item to a wq, prefer local CPU if allowed 2209ef557180SMike Galbraith * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to 2210ef557180SMike Galbraith * avoid perturbing sensitive tasks. 2211ef557180SMike Galbraith */ 2212ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu) 2213ef557180SMike Galbraith { 2214ef557180SMike Galbraith int new_cpu; 2215ef557180SMike Galbraith 2216f303fccbSTejun Heo if (likely(!wq_debug_force_rr_cpu)) { 2217ef557180SMike Galbraith if (cpumask_test_cpu(cpu, wq_unbound_cpumask)) 2218ef557180SMike Galbraith return cpu; 2219a8ec5880SAmmar Faizi } else { 2220a8ec5880SAmmar Faizi pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n"); 2221f303fccbSTejun Heo } 2222f303fccbSTejun Heo 2223ef557180SMike Galbraith new_cpu = __this_cpu_read(wq_rr_cpu_last); 2224ef557180SMike Galbraith new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask); 2225ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) { 2226ef557180SMike Galbraith new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask); 2227ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) 2228ef557180SMike Galbraith return cpu; 2229ef557180SMike Galbraith } 2230ef557180SMike Galbraith __this_cpu_write(wq_rr_cpu_last, new_cpu); 2231ef557180SMike Galbraith 2232ef557180SMike Galbraith return new_cpu; 2233ef557180SMike Galbraith } 2234ef557180SMike Galbraith 2235d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 22361da177e4SLinus Torvalds struct work_struct *work) 22371da177e4SLinus Torvalds { 2238112202d9STejun Heo struct pool_workqueue *pwq; 2239fe089f87STejun Heo struct worker_pool *last_pool, *pool; 22408a2e8e5dSTejun Heo unsigned int work_flags; 2241b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 22428930cabaSTejun Heo 22438930cabaSTejun Heo /* 22448930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 22458930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 22468930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 22478930cabaSTejun Heo * happen with IRQ disabled. 22488930cabaSTejun Heo */ 22498e8eb730SFrederic Weisbecker lockdep_assert_irqs_disabled(); 22501da177e4SLinus Torvalds 225133e3f0a3SRichard Clark /* 225233e3f0a3SRichard Clark * For a draining wq, only works from the same workqueue are 225333e3f0a3SRichard Clark * allowed. The __WQ_DESTROYING helps to spot the issue that 225433e3f0a3SRichard Clark * queues a new work item to a wq after destroy_workqueue(wq). 225533e3f0a3SRichard Clark */ 225633e3f0a3SRichard Clark if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) && 225733e3f0a3SRichard Clark WARN_ON_ONCE(!is_chained_work(wq)))) 2258e41e704bSTejun Heo return; 225924acfb71SThomas Gleixner rcu_read_lock(); 22609e8cd2f5STejun Heo retry: 2261aa202f1fSHillf Danton /* pwq which will be used unless @work is executing elsewhere */ 2262636b927eSTejun Heo if (req_cpu == WORK_CPU_UNBOUND) { 2263636b927eSTejun Heo if (wq->flags & WQ_UNBOUND) 2264ef557180SMike Galbraith cpu = wq_select_unbound_cpu(raw_smp_processor_id()); 2265636b927eSTejun Heo else 2266aa202f1fSHillf Danton cpu = raw_smp_processor_id(); 2267aa202f1fSHillf Danton } 2268f3421797STejun Heo 2269636b927eSTejun Heo pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu)); 2270fe089f87STejun Heo pool = pwq->pool; 2271fe089f87STejun Heo 227218aa9effSTejun Heo /* 2273c9178087STejun Heo * If @work was previously on a different pool, it might still be 2274c9178087STejun Heo * running there, in which case the work needs to be queued on that 2275c9178087STejun Heo * pool to guarantee non-reentrancy. 227658629d48SLai Jiangshan * 227758629d48SLai Jiangshan * For ordered workqueue, work items must be queued on the newest pwq 227858629d48SLai Jiangshan * for accurate order management. Guaranteed order also guarantees 227958629d48SLai Jiangshan * non-reentrancy. See the comments above unplug_oldest_pwq(). 228018aa9effSTejun Heo */ 2281c9e7cf27STejun Heo last_pool = get_work_pool(work); 228258629d48SLai Jiangshan if (last_pool && last_pool != pool && !(wq->flags & __WQ_ORDERED)) { 228318aa9effSTejun Heo struct worker *worker; 228418aa9effSTejun Heo 2285a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&last_pool->lock); 228618aa9effSTejun Heo 2287c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 228818aa9effSTejun Heo 2289112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 2290c9178087STejun Heo pwq = worker->current_pwq; 2291fe089f87STejun Heo pool = pwq->pool; 2292fe089f87STejun Heo WARN_ON_ONCE(pool != last_pool); 22938594fadeSLai Jiangshan } else { 229418aa9effSTejun Heo /* meh... not running there, queue here */ 2295a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&last_pool->lock); 2296fe089f87STejun Heo raw_spin_lock(&pool->lock); 229718aa9effSTejun Heo } 22988930cabaSTejun Heo } else { 2299fe089f87STejun Heo raw_spin_lock(&pool->lock); 23008930cabaSTejun Heo } 2301502ca9d8STejun Heo 23029e8cd2f5STejun Heo /* 2303636b927eSTejun Heo * pwq is determined and locked. For unbound pools, we could have raced 2304636b927eSTejun Heo * with pwq release and it could already be dead. If its refcnt is zero, 2305636b927eSTejun Heo * repeat pwq selection. Note that unbound pwqs never die without 2306636b927eSTejun Heo * another pwq replacing it in cpu_pwq or while work items are executing 2307636b927eSTejun Heo * on it, so the retrying is guaranteed to make forward-progress. 23089e8cd2f5STejun Heo */ 23099e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 23109e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 2311fe089f87STejun Heo raw_spin_unlock(&pool->lock); 23129e8cd2f5STejun Heo cpu_relax(); 23139e8cd2f5STejun Heo goto retry; 23149e8cd2f5STejun Heo } 23159e8cd2f5STejun Heo /* oops */ 23169e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 23179e8cd2f5STejun Heo wq->name, cpu); 23189e8cd2f5STejun Heo } 23199e8cd2f5STejun Heo 2320112202d9STejun Heo /* pwq determined, queue */ 2321112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 2322502ca9d8STejun Heo 232324acfb71SThomas Gleixner if (WARN_ON(!list_empty(&work->entry))) 232424acfb71SThomas Gleixner goto out; 23251e19ffc6STejun Heo 2326112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 2327112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 23281e19ffc6STejun Heo 2329a045a272STejun Heo /* 2330a045a272STejun Heo * Limit the number of concurrently active work items to max_active. 2331a045a272STejun Heo * @work must also queue behind existing inactive work items to maintain 2332a045a272STejun Heo * ordering when max_active changes. See wq_adjust_max_active(). 2333a045a272STejun Heo */ 23345797b1c1STejun Heo if (list_empty(&pwq->inactive_works) && pwq_tryinc_nr_active(pwq, false)) { 2335fe089f87STejun Heo if (list_empty(&pool->worklist)) 2336fe089f87STejun Heo pool->watchdog_ts = jiffies; 2337fe089f87STejun Heo 2338cdadf009STejun Heo trace_workqueue_activate_work(work); 2339fe089f87STejun Heo insert_work(pwq, work, &pool->worklist, work_flags); 23400219a352STejun Heo kick_pool(pool); 23418a2e8e5dSTejun Heo } else { 2342f97a4a1aSLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 2343fe089f87STejun Heo insert_work(pwq, work, &pwq->inactive_works, work_flags); 23448a2e8e5dSTejun Heo } 23451e19ffc6STejun Heo 234624acfb71SThomas Gleixner out: 2347fe089f87STejun Heo raw_spin_unlock(&pool->lock); 234824acfb71SThomas Gleixner rcu_read_unlock(); 23491da177e4SLinus Torvalds } 23501da177e4SLinus Torvalds 235186898fa6STejun Heo static bool clear_pending_if_disabled(struct work_struct *work) 235286898fa6STejun Heo { 235386898fa6STejun Heo unsigned long data = *work_data_bits(work); 235486898fa6STejun Heo struct work_offq_data offqd; 235586898fa6STejun Heo 235686898fa6STejun Heo if (likely((data & WORK_STRUCT_PWQ) || 235786898fa6STejun Heo !(data & WORK_OFFQ_DISABLE_MASK))) 235886898fa6STejun Heo return false; 235986898fa6STejun Heo 236086898fa6STejun Heo work_offqd_unpack(&offqd, data); 236186898fa6STejun Heo set_work_pool_and_clear_pending(work, offqd.pool_id, 236286898fa6STejun Heo work_offqd_pack_flags(&offqd)); 236386898fa6STejun Heo return true; 236486898fa6STejun Heo } 236586898fa6STejun Heo 23660fcb78c2SRolf Eike Beer /** 2367c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 2368c1a220e7SZhang Rui * @cpu: CPU number to execute work on 2369c1a220e7SZhang Rui * @wq: workqueue to use 2370c1a220e7SZhang Rui * @work: work to queue 2371c1a220e7SZhang Rui * 2372c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 2373443378f0SPaul E. McKenney * can't go away. Callers that fail to ensure that the specified 2374443378f0SPaul E. McKenney * CPU cannot go away will execute on a randomly chosen CPU. 2375854f5cc5SPaul E. McKenney * But note well that callers specifying a CPU that never has been 2376854f5cc5SPaul E. McKenney * online will get a splat. 2377d185af30SYacine Belkadi * 2378d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. 2379c1a220e7SZhang Rui */ 2380d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 2381d4283e93STejun Heo struct work_struct *work) 2382c1a220e7SZhang Rui { 2383d4283e93STejun Heo bool ret = false; 2384c26e2f2eSTejun Heo unsigned long irq_flags; 23858930cabaSTejun Heo 2386c26e2f2eSTejun Heo local_irq_save(irq_flags); 2387c1a220e7SZhang Rui 238886898fa6STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) && 238986898fa6STejun Heo !clear_pending_if_disabled(work)) { 23904690c4abSTejun Heo __queue_work(cpu, wq, work); 2391d4283e93STejun Heo ret = true; 2392c1a220e7SZhang Rui } 23938930cabaSTejun Heo 2394c26e2f2eSTejun Heo local_irq_restore(irq_flags); 2395c1a220e7SZhang Rui return ret; 2396c1a220e7SZhang Rui } 2397ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on); 2398c1a220e7SZhang Rui 23998204e0c1SAlexander Duyck /** 2400fef59c9cSTejun Heo * select_numa_node_cpu - Select a CPU based on NUMA node 24018204e0c1SAlexander Duyck * @node: NUMA node ID that we want to select a CPU from 24028204e0c1SAlexander Duyck * 24038204e0c1SAlexander Duyck * This function will attempt to find a "random" cpu available on a given 24048204e0c1SAlexander Duyck * node. If there are no CPUs available on the given node it will return 24058204e0c1SAlexander Duyck * WORK_CPU_UNBOUND indicating that we should just schedule to any 24068204e0c1SAlexander Duyck * available CPU if we need to schedule this work. 24078204e0c1SAlexander Duyck */ 2408fef59c9cSTejun Heo static int select_numa_node_cpu(int node) 24098204e0c1SAlexander Duyck { 24108204e0c1SAlexander Duyck int cpu; 24118204e0c1SAlexander Duyck 24128204e0c1SAlexander Duyck /* Delay binding to CPU if node is not valid or online */ 24138204e0c1SAlexander Duyck if (node < 0 || node >= MAX_NUMNODES || !node_online(node)) 24148204e0c1SAlexander Duyck return WORK_CPU_UNBOUND; 24158204e0c1SAlexander Duyck 24168204e0c1SAlexander Duyck /* Use local node/cpu if we are already there */ 24178204e0c1SAlexander Duyck cpu = raw_smp_processor_id(); 24188204e0c1SAlexander Duyck if (node == cpu_to_node(cpu)) 24198204e0c1SAlexander Duyck return cpu; 24208204e0c1SAlexander Duyck 24218204e0c1SAlexander Duyck /* Use "random" otherwise know as "first" online CPU of node */ 24228204e0c1SAlexander Duyck cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask); 24238204e0c1SAlexander Duyck 24248204e0c1SAlexander Duyck /* If CPU is valid return that, otherwise just defer */ 24258204e0c1SAlexander Duyck return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND; 24268204e0c1SAlexander Duyck } 24278204e0c1SAlexander Duyck 24288204e0c1SAlexander Duyck /** 24298204e0c1SAlexander Duyck * queue_work_node - queue work on a "random" cpu for a given NUMA node 24308204e0c1SAlexander Duyck * @node: NUMA node that we are targeting the work for 24318204e0c1SAlexander Duyck * @wq: workqueue to use 24328204e0c1SAlexander Duyck * @work: work to queue 24338204e0c1SAlexander Duyck * 24348204e0c1SAlexander Duyck * We queue the work to a "random" CPU within a given NUMA node. The basic 24358204e0c1SAlexander Duyck * idea here is to provide a way to somehow associate work with a given 24368204e0c1SAlexander Duyck * NUMA node. 24378204e0c1SAlexander Duyck * 24388204e0c1SAlexander Duyck * This function will only make a best effort attempt at getting this onto 24398204e0c1SAlexander Duyck * the right NUMA node. If no node is requested or the requested node is 24408204e0c1SAlexander Duyck * offline then we just fall back to standard queue_work behavior. 24418204e0c1SAlexander Duyck * 24428204e0c1SAlexander Duyck * Currently the "random" CPU ends up being the first available CPU in the 24438204e0c1SAlexander Duyck * intersection of cpu_online_mask and the cpumask of the node, unless we 24448204e0c1SAlexander Duyck * are running on the node. In that case we just use the current CPU. 24458204e0c1SAlexander Duyck * 24468204e0c1SAlexander Duyck * Return: %false if @work was already on a queue, %true otherwise. 24478204e0c1SAlexander Duyck */ 24488204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq, 24498204e0c1SAlexander Duyck struct work_struct *work) 24508204e0c1SAlexander Duyck { 2451c26e2f2eSTejun Heo unsigned long irq_flags; 24528204e0c1SAlexander Duyck bool ret = false; 24538204e0c1SAlexander Duyck 24548204e0c1SAlexander Duyck /* 24558204e0c1SAlexander Duyck * This current implementation is specific to unbound workqueues. 24568204e0c1SAlexander Duyck * Specifically we only return the first available CPU for a given 24578204e0c1SAlexander Duyck * node instead of cycling through individual CPUs within the node. 24588204e0c1SAlexander Duyck * 24598204e0c1SAlexander Duyck * If this is used with a per-cpu workqueue then the logic in 24608204e0c1SAlexander Duyck * workqueue_select_cpu_near would need to be updated to allow for 24618204e0c1SAlexander Duyck * some round robin type logic. 24628204e0c1SAlexander Duyck */ 24638204e0c1SAlexander Duyck WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)); 24648204e0c1SAlexander Duyck 2465c26e2f2eSTejun Heo local_irq_save(irq_flags); 24668204e0c1SAlexander Duyck 246786898fa6STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) && 246886898fa6STejun Heo !clear_pending_if_disabled(work)) { 2469fef59c9cSTejun Heo int cpu = select_numa_node_cpu(node); 24708204e0c1SAlexander Duyck 24718204e0c1SAlexander Duyck __queue_work(cpu, wq, work); 24728204e0c1SAlexander Duyck ret = true; 24738204e0c1SAlexander Duyck } 24748204e0c1SAlexander Duyck 2475c26e2f2eSTejun Heo local_irq_restore(irq_flags); 24768204e0c1SAlexander Duyck return ret; 24778204e0c1SAlexander Duyck } 24788204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node); 24798204e0c1SAlexander Duyck 24808c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t) 24811da177e4SLinus Torvalds { 24828c20feb6SKees Cook struct delayed_work *dwork = from_timer(dwork, t, timer); 24831da177e4SLinus Torvalds 2484e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 248560c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 24861da177e4SLinus Torvalds } 24871438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 24881da177e4SLinus Torvalds 24897beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 249052bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 24911da177e4SLinus Torvalds { 24927beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 24937beb2edfSTejun Heo struct work_struct *work = &dwork->work; 24941da177e4SLinus Torvalds 2495637fdbaeSTejun Heo WARN_ON_ONCE(!wq); 24964b243563SSami Tolvanen WARN_ON_ONCE(timer->function != delayed_work_timer_fn); 2497fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 2498fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 24997beb2edfSTejun Heo 25008852aac2STejun Heo /* 25018852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 25028852aac2STejun Heo * both optimization and correctness. The earliest @timer can 25038852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 25048852aac2STejun Heo * on that there's no such delay when @delay is 0. 25058852aac2STejun Heo */ 25068852aac2STejun Heo if (!delay) { 25078852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 25088852aac2STejun Heo return; 25098852aac2STejun Heo } 25108852aac2STejun Heo 251160c057bcSLai Jiangshan dwork->wq = wq; 25121265057fSTejun Heo dwork->cpu = cpu; 25137beb2edfSTejun Heo timer->expires = jiffies + delay; 25147beb2edfSTejun Heo 2515aae17ebbSLeonardo Bras if (housekeeping_enabled(HK_TYPE_TIMER)) { 2516aae17ebbSLeonardo Bras /* If the current cpu is a housekeeping cpu, use it. */ 2517aae17ebbSLeonardo Bras cpu = smp_processor_id(); 2518aae17ebbSLeonardo Bras if (!housekeeping_test_cpu(cpu, HK_TYPE_TIMER)) 2519aae17ebbSLeonardo Bras cpu = housekeeping_any_cpu(HK_TYPE_TIMER); 25207beb2edfSTejun Heo add_timer_on(timer, cpu); 2521aae17ebbSLeonardo Bras } else { 2522aae17ebbSLeonardo Bras if (likely(cpu == WORK_CPU_UNBOUND)) 2523c0e8c5b5SAnna-Maria Behnsen add_timer_global(timer); 2524aae17ebbSLeonardo Bras else 2525aae17ebbSLeonardo Bras add_timer_on(timer, cpu); 2526aae17ebbSLeonardo Bras } 25277beb2edfSTejun Heo } 25281da177e4SLinus Torvalds 25290fcb78c2SRolf Eike Beer /** 25300fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 25310fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 25320fcb78c2SRolf Eike Beer * @wq: workqueue to use 2533af9997e4SRandy Dunlap * @dwork: work to queue 25340fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 25350fcb78c2SRolf Eike Beer * 2536d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. If 2537715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 2538715f1300STejun Heo * execution. 25390fcb78c2SRolf Eike Beer */ 2540d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 254152bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 25427a6bc1cdSVenkatesh Pallipadi { 254352bad64dSDavid Howells struct work_struct *work = &dwork->work; 2544d4283e93STejun Heo bool ret = false; 2545c26e2f2eSTejun Heo unsigned long irq_flags; 25468930cabaSTejun Heo 25478930cabaSTejun Heo /* read the comment in __queue_work() */ 2548c26e2f2eSTejun Heo local_irq_save(irq_flags); 25497a6bc1cdSVenkatesh Pallipadi 255086898fa6STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) && 255186898fa6STejun Heo !clear_pending_if_disabled(work)) { 25527beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 2553d4283e93STejun Heo ret = true; 25547a6bc1cdSVenkatesh Pallipadi } 25558930cabaSTejun Heo 2556c26e2f2eSTejun Heo local_irq_restore(irq_flags); 25577a6bc1cdSVenkatesh Pallipadi return ret; 25587a6bc1cdSVenkatesh Pallipadi } 2559ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on); 25601da177e4SLinus Torvalds 2561c8e55f36STejun Heo /** 25628376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 25638376fe22STejun Heo * @cpu: CPU number to execute work on 25648376fe22STejun Heo * @wq: workqueue to use 25658376fe22STejun Heo * @dwork: work to queue 25668376fe22STejun Heo * @delay: number of jiffies to wait before queueing 25678376fe22STejun Heo * 25688376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 25698376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 25708376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 25718376fe22STejun Heo * current state. 25728376fe22STejun Heo * 2573d185af30SYacine Belkadi * Return: %false if @dwork was idle and queued, %true if @dwork was 25748376fe22STejun Heo * pending and its timer was modified. 25758376fe22STejun Heo * 2576e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 25778376fe22STejun Heo * See try_to_grab_pending() for details. 25788376fe22STejun Heo */ 25798376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 25808376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 25818376fe22STejun Heo { 2582c26e2f2eSTejun Heo unsigned long irq_flags; 2583f09b10b6STejun Heo bool ret; 25848376fe22STejun Heo 2585f09b10b6STejun Heo ret = work_grab_pending(&dwork->work, WORK_CANCEL_DELAYED, &irq_flags); 25868376fe22STejun Heo 2587f09b10b6STejun Heo if (!clear_pending_if_disabled(&dwork->work)) 25888376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 25898376fe22STejun Heo 2590f09b10b6STejun Heo local_irq_restore(irq_flags); 25918376fe22STejun Heo return ret; 25928376fe22STejun Heo } 25938376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 25948376fe22STejun Heo 259505f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu) 259605f0fe6bSTejun Heo { 259705f0fe6bSTejun Heo struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu); 259805f0fe6bSTejun Heo 259905f0fe6bSTejun Heo /* read the comment in __queue_work() */ 260005f0fe6bSTejun Heo local_irq_disable(); 260105f0fe6bSTejun Heo __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work); 260205f0fe6bSTejun Heo local_irq_enable(); 260305f0fe6bSTejun Heo } 260405f0fe6bSTejun Heo 260505f0fe6bSTejun Heo /** 260605f0fe6bSTejun Heo * queue_rcu_work - queue work after a RCU grace period 260705f0fe6bSTejun Heo * @wq: workqueue to use 260805f0fe6bSTejun Heo * @rwork: work to queue 260905f0fe6bSTejun Heo * 261005f0fe6bSTejun Heo * Return: %false if @rwork was already pending, %true otherwise. Note 261105f0fe6bSTejun Heo * that a full RCU grace period is guaranteed only after a %true return. 2612bf393fd4SBart Van Assche * While @rwork is guaranteed to be executed after a %false return, the 261305f0fe6bSTejun Heo * execution may happen before a full RCU grace period has passed. 261405f0fe6bSTejun Heo */ 261505f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork) 261605f0fe6bSTejun Heo { 261705f0fe6bSTejun Heo struct work_struct *work = &rwork->work; 261805f0fe6bSTejun Heo 261986898fa6STejun Heo /* 262086898fa6STejun Heo * rcu_work can't be canceled or disabled. Warn if the user reached 262186898fa6STejun Heo * inside @rwork and disabled the inner work. 262286898fa6STejun Heo */ 262386898fa6STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) && 262486898fa6STejun Heo !WARN_ON_ONCE(clear_pending_if_disabled(work))) { 262505f0fe6bSTejun Heo rwork->wq = wq; 2626a7e30c0eSUladzislau Rezki call_rcu_hurry(&rwork->rcu, rcu_work_rcufn); 262705f0fe6bSTejun Heo return true; 262805f0fe6bSTejun Heo } 262905f0fe6bSTejun Heo 263005f0fe6bSTejun Heo return false; 263105f0fe6bSTejun Heo } 263205f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work); 263305f0fe6bSTejun Heo 2634f7537df5SLai Jiangshan static struct worker *alloc_worker(int node) 2635c34056a3STejun Heo { 2636c34056a3STejun Heo struct worker *worker; 2637c34056a3STejun Heo 2638f7537df5SLai Jiangshan worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node); 2639c8e55f36STejun Heo if (worker) { 2640c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 2641affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 2642da028469SLai Jiangshan INIT_LIST_HEAD(&worker->node); 2643e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 2644e22bee78STejun Heo worker->flags = WORKER_PREP; 2645c8e55f36STejun Heo } 2646c34056a3STejun Heo return worker; 2647c34056a3STejun Heo } 2648c34056a3STejun Heo 26499546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool) 26509546b29eSTejun Heo { 26518639ecebSTejun Heo if (pool->cpu < 0 && pool->attrs->affn_strict) 26529546b29eSTejun Heo return pool->attrs->__pod_cpumask; 26538639ecebSTejun Heo else 26548639ecebSTejun Heo return pool->attrs->cpumask; 26559546b29eSTejun Heo } 26569546b29eSTejun Heo 2657c34056a3STejun Heo /** 26584736cbf7SLai Jiangshan * worker_attach_to_pool() - attach a worker to a pool 26594736cbf7SLai Jiangshan * @worker: worker to be attached 26604736cbf7SLai Jiangshan * @pool: the target pool 26614736cbf7SLai Jiangshan * 26624736cbf7SLai Jiangshan * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and 26634736cbf7SLai Jiangshan * cpu-binding of @worker are kept coordinated with the pool across 26644736cbf7SLai Jiangshan * cpu-[un]hotplugs. 26654736cbf7SLai Jiangshan */ 26664736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker, 26674736cbf7SLai Jiangshan struct worker_pool *pool) 26684736cbf7SLai Jiangshan { 26691258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 26704736cbf7SLai Jiangshan 26714736cbf7SLai Jiangshan /* 26724cb1ef64STejun Heo * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains stable 26734cb1ef64STejun Heo * across this function. See the comments above the flag definition for 26744cb1ef64STejun Heo * details. BH workers are, while per-CPU, always DISASSOCIATED. 26754736cbf7SLai Jiangshan */ 26764cb1ef64STejun Heo if (pool->flags & POOL_DISASSOCIATED) { 26774736cbf7SLai Jiangshan worker->flags |= WORKER_UNBOUND; 26784cb1ef64STejun Heo } else { 26794cb1ef64STejun Heo WARN_ON_ONCE(pool->flags & POOL_BH); 26805c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, pool->cpu); 26814cb1ef64STejun Heo } 26824736cbf7SLai Jiangshan 2683640f17c8SPeter Zijlstra if (worker->rescue_wq) 26849546b29eSTejun Heo set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool)); 2685640f17c8SPeter Zijlstra 26864736cbf7SLai Jiangshan list_add_tail(&worker->node, &pool->workers); 2687a2d812a2STejun Heo worker->pool = pool; 26884736cbf7SLai Jiangshan 26891258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 26904736cbf7SLai Jiangshan } 26914736cbf7SLai Jiangshan 2692f45b1c3cSLai Jiangshan static void unbind_worker(struct worker *worker) 2693f45b1c3cSLai Jiangshan { 2694f45b1c3cSLai Jiangshan lockdep_assert_held(&wq_pool_attach_mutex); 2695f45b1c3cSLai Jiangshan 2696f45b1c3cSLai Jiangshan kthread_set_per_cpu(worker->task, -1); 2697f45b1c3cSLai Jiangshan if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask)) 2698f45b1c3cSLai Jiangshan WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0); 2699f45b1c3cSLai Jiangshan else 2700f45b1c3cSLai Jiangshan WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0); 2701f45b1c3cSLai Jiangshan } 2702f45b1c3cSLai Jiangshan 2703f4b7b53cSLai Jiangshan 2704f4b7b53cSLai Jiangshan static void detach_worker(struct worker *worker) 2705f4b7b53cSLai Jiangshan { 2706f4b7b53cSLai Jiangshan lockdep_assert_held(&wq_pool_attach_mutex); 2707f4b7b53cSLai Jiangshan 2708f4b7b53cSLai Jiangshan unbind_worker(worker); 2709f4b7b53cSLai Jiangshan list_del(&worker->node); 2710f4b7b53cSLai Jiangshan } 2711f4b7b53cSLai Jiangshan 27124736cbf7SLai Jiangshan /** 271360f5a4bcSLai Jiangshan * worker_detach_from_pool() - detach a worker from its pool 271460f5a4bcSLai Jiangshan * @worker: worker which is attached to its pool 271560f5a4bcSLai Jiangshan * 27164736cbf7SLai Jiangshan * Undo the attaching which had been done in worker_attach_to_pool(). The 27174736cbf7SLai Jiangshan * caller worker shouldn't access to the pool after detached except it has 27184736cbf7SLai Jiangshan * other reference to the pool. 271960f5a4bcSLai Jiangshan */ 2720a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker) 272160f5a4bcSLai Jiangshan { 2722a2d812a2STejun Heo struct worker_pool *pool = worker->pool; 272360f5a4bcSLai Jiangshan 27244cb1ef64STejun Heo /* there is one permanent BH worker per CPU which should never detach */ 27254cb1ef64STejun Heo WARN_ON_ONCE(pool->flags & POOL_BH); 27264cb1ef64STejun Heo 27271258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 2728f4b7b53cSLai Jiangshan detach_worker(worker); 272973613840SLai Jiangshan worker->pool = NULL; 27301258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 273160f5a4bcSLai Jiangshan 2732b62c0751SLai Jiangshan /* clear leftover flags without pool->lock after it is detached */ 2733b62c0751SLai Jiangshan worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND); 273460f5a4bcSLai Jiangshan } 273560f5a4bcSLai Jiangshan 27362a1b02bcSTejun Heo static int format_worker_id(char *buf, size_t size, struct worker *worker, 27372a1b02bcSTejun Heo struct worker_pool *pool) 27382a1b02bcSTejun Heo { 27392a1b02bcSTejun Heo if (worker->rescue_wq) 27402a1b02bcSTejun Heo return scnprintf(buf, size, "kworker/R-%s", 27412a1b02bcSTejun Heo worker->rescue_wq->name); 27422a1b02bcSTejun Heo 27432a1b02bcSTejun Heo if (pool) { 27442a1b02bcSTejun Heo if (pool->cpu >= 0) 27452a1b02bcSTejun Heo return scnprintf(buf, size, "kworker/%d:%d%s", 27462a1b02bcSTejun Heo pool->cpu, worker->id, 27472a1b02bcSTejun Heo pool->attrs->nice < 0 ? "H" : ""); 27482a1b02bcSTejun Heo else 27492a1b02bcSTejun Heo return scnprintf(buf, size, "kworker/u%d:%d", 27502a1b02bcSTejun Heo pool->id, worker->id); 27512a1b02bcSTejun Heo } else { 27522a1b02bcSTejun Heo return scnprintf(buf, size, "kworker/dying"); 27532a1b02bcSTejun Heo } 27542a1b02bcSTejun Heo } 27552a1b02bcSTejun Heo 275660f5a4bcSLai Jiangshan /** 2757c34056a3STejun Heo * create_worker - create a new workqueue worker 275863d95a91STejun Heo * @pool: pool the new worker will belong to 2759c34056a3STejun Heo * 2760051e1850SLai Jiangshan * Create and start a new worker which is attached to @pool. 2761c34056a3STejun Heo * 2762c34056a3STejun Heo * CONTEXT: 2763c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 2764c34056a3STejun Heo * 2765d185af30SYacine Belkadi * Return: 2766c34056a3STejun Heo * Pointer to the newly created worker. 2767c34056a3STejun Heo */ 2768bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 2769c34056a3STejun Heo { 2770e441b56fSZhen Lei struct worker *worker; 2771e441b56fSZhen Lei int id; 2772c34056a3STejun Heo 27737cda9aaeSLai Jiangshan /* ID is needed to determine kthread name */ 2774e441b56fSZhen Lei id = ida_alloc(&pool->worker_ida, GFP_KERNEL); 27753f0ea0b8SPetr Mladek if (id < 0) { 27763f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n", 27773f0ea0b8SPetr Mladek ERR_PTR(id)); 2778e441b56fSZhen Lei return NULL; 27793f0ea0b8SPetr Mladek } 2780c34056a3STejun Heo 2781f7537df5SLai Jiangshan worker = alloc_worker(pool->node); 27823f0ea0b8SPetr Mladek if (!worker) { 27833f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to allocate a worker\n"); 2784c34056a3STejun Heo goto fail; 27853f0ea0b8SPetr Mladek } 2786c34056a3STejun Heo 2787c34056a3STejun Heo worker->id = id; 2788c34056a3STejun Heo 27894cb1ef64STejun Heo if (!(pool->flags & POOL_BH)) { 27902a1b02bcSTejun Heo char id_buf[WORKER_ID_LEN]; 2791e3c916a4STejun Heo 27922a1b02bcSTejun Heo format_worker_id(id_buf, sizeof(id_buf), worker, pool); 27934cb1ef64STejun Heo worker->task = kthread_create_on_node(worker_thread, worker, 27942a1b02bcSTejun Heo pool->node, "%s", id_buf); 27953f0ea0b8SPetr Mladek if (IS_ERR(worker->task)) { 279660f54038SPetr Mladek if (PTR_ERR(worker->task) == -EINTR) { 27972a1b02bcSTejun Heo pr_err("workqueue: Interrupted when creating a worker thread \"%s\"\n", 279860f54038SPetr Mladek id_buf); 279960f54038SPetr Mladek } else { 28003f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to create a worker thread: %pe", 28013f0ea0b8SPetr Mladek worker->task); 280260f54038SPetr Mladek } 2803c34056a3STejun Heo goto fail; 28043f0ea0b8SPetr Mladek } 2805c34056a3STejun Heo 280691151228SOleg Nesterov set_user_nice(worker->task, pool->attrs->nice); 28079546b29eSTejun Heo kthread_bind_mask(worker->task, pool_allowed_cpus(pool)); 28084cb1ef64STejun Heo } 280991151228SOleg Nesterov 2810da028469SLai Jiangshan /* successful, attach the worker to the pool */ 28114736cbf7SLai Jiangshan worker_attach_to_pool(worker, pool); 2812822d8405STejun Heo 2813051e1850SLai Jiangshan /* start the newly created worker */ 2814a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 28150219a352STejun Heo 2816051e1850SLai Jiangshan worker->pool->nr_workers++; 2817051e1850SLai Jiangshan worker_enter_idle(worker); 28180219a352STejun Heo 28190219a352STejun Heo /* 28200219a352STejun Heo * @worker is waiting on a completion in kthread() and will trigger hung 28216a229b0eSTejun Heo * check if not woken up soon. As kick_pool() is noop if @pool is empty, 28226a229b0eSTejun Heo * wake it up explicitly. 28230219a352STejun Heo */ 28244cb1ef64STejun Heo if (worker->task) 2825051e1850SLai Jiangshan wake_up_process(worker->task); 28260219a352STejun Heo 2827a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2828051e1850SLai Jiangshan 2829c34056a3STejun Heo return worker; 2830822d8405STejun Heo 2831c34056a3STejun Heo fail: 2832e441b56fSZhen Lei ida_free(&pool->worker_ida, id); 2833c34056a3STejun Heo kfree(worker); 2834c34056a3STejun Heo return NULL; 2835c34056a3STejun Heo } 2836c34056a3STejun Heo 2837f4b7b53cSLai Jiangshan static void detach_dying_workers(struct list_head *cull_list) 2838793777bcSValentin Schneider { 283968f83057SLai Jiangshan struct worker *worker; 2840793777bcSValentin Schneider 2841f4b7b53cSLai Jiangshan list_for_each_entry(worker, cull_list, entry) 2842f4b7b53cSLai Jiangshan detach_worker(worker); 2843793777bcSValentin Schneider } 2844793777bcSValentin Schneider 284568f83057SLai Jiangshan static void reap_dying_workers(struct list_head *cull_list) 2846e02b9312SValentin Schneider { 2847e02b9312SValentin Schneider struct worker *worker, *tmp; 2848e02b9312SValentin Schneider 2849e02b9312SValentin Schneider list_for_each_entry_safe(worker, tmp, cull_list, entry) { 2850e02b9312SValentin Schneider list_del_init(&worker->entry); 285168f83057SLai Jiangshan kthread_stop_put(worker->task); 285268f83057SLai Jiangshan kfree(worker); 2853e02b9312SValentin Schneider } 2854e02b9312SValentin Schneider } 2855e02b9312SValentin Schneider 2856e02b9312SValentin Schneider /** 2857e02b9312SValentin Schneider * set_worker_dying - Tag a worker for destruction 2858e02b9312SValentin Schneider * @worker: worker to be destroyed 2859e02b9312SValentin Schneider * @list: transfer worker away from its pool->idle_list and into list 2860e02b9312SValentin Schneider * 2861e02b9312SValentin Schneider * Tag @worker for destruction and adjust @pool stats accordingly. The worker 2862e02b9312SValentin Schneider * should be idle. 2863c8e55f36STejun Heo * 2864c8e55f36STejun Heo * CONTEXT: 2865a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 2866c34056a3STejun Heo */ 2867e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list) 2868c34056a3STejun Heo { 2869bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2870c34056a3STejun Heo 2871cd549687STejun Heo lockdep_assert_held(&pool->lock); 2872e02b9312SValentin Schneider lockdep_assert_held(&wq_pool_attach_mutex); 2873cd549687STejun Heo 2874c34056a3STejun Heo /* sanity check frenzy */ 28756183c009STejun Heo if (WARN_ON(worker->current_work) || 287673eb7fe7SLai Jiangshan WARN_ON(!list_empty(&worker->scheduled)) || 287773eb7fe7SLai Jiangshan WARN_ON(!(worker->flags & WORKER_IDLE))) 28786183c009STejun Heo return; 2879c34056a3STejun Heo 2880bd7bdd43STejun Heo pool->nr_workers--; 2881bd7bdd43STejun Heo pool->nr_idle--; 2882c8e55f36STejun Heo 2883cb444766STejun Heo worker->flags |= WORKER_DIE; 2884e02b9312SValentin Schneider 2885e02b9312SValentin Schneider list_move(&worker->entry, list); 288668f83057SLai Jiangshan 288768f83057SLai Jiangshan /* get an extra task struct reference for later kthread_stop_put() */ 288868f83057SLai Jiangshan get_task_struct(worker->task); 2889c34056a3STejun Heo } 2890c34056a3STejun Heo 28913f959aa3SValentin Schneider /** 28923f959aa3SValentin Schneider * idle_worker_timeout - check if some idle workers can now be deleted. 28933f959aa3SValentin Schneider * @t: The pool's idle_timer that just expired 28943f959aa3SValentin Schneider * 28953f959aa3SValentin Schneider * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in 28963f959aa3SValentin Schneider * worker_leave_idle(), as a worker flicking between idle and active while its 28973f959aa3SValentin Schneider * pool is at the too_many_workers() tipping point would cause too much timer 28983f959aa3SValentin Schneider * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let 28993f959aa3SValentin Schneider * it expire and re-evaluate things from there. 29003f959aa3SValentin Schneider */ 290132a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t) 2902e22bee78STejun Heo { 290332a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, idle_timer); 29043f959aa3SValentin Schneider bool do_cull = false; 29053f959aa3SValentin Schneider 29063f959aa3SValentin Schneider if (work_pending(&pool->idle_cull_work)) 29073f959aa3SValentin Schneider return; 29083f959aa3SValentin Schneider 29093f959aa3SValentin Schneider raw_spin_lock_irq(&pool->lock); 29103f959aa3SValentin Schneider 29113f959aa3SValentin Schneider if (too_many_workers(pool)) { 29123f959aa3SValentin Schneider struct worker *worker; 29133f959aa3SValentin Schneider unsigned long expires; 29143f959aa3SValentin Schneider 29153f959aa3SValentin Schneider /* idle_list is kept in LIFO order, check the last one */ 2916d70f5d57SLai Jiangshan worker = list_last_entry(&pool->idle_list, struct worker, entry); 29173f959aa3SValentin Schneider expires = worker->last_active + IDLE_WORKER_TIMEOUT; 29183f959aa3SValentin Schneider do_cull = !time_before(jiffies, expires); 29193f959aa3SValentin Schneider 29203f959aa3SValentin Schneider if (!do_cull) 29213f959aa3SValentin Schneider mod_timer(&pool->idle_timer, expires); 29223f959aa3SValentin Schneider } 29233f959aa3SValentin Schneider raw_spin_unlock_irq(&pool->lock); 29243f959aa3SValentin Schneider 29253f959aa3SValentin Schneider if (do_cull) 29263f959aa3SValentin Schneider queue_work(system_unbound_wq, &pool->idle_cull_work); 29273f959aa3SValentin Schneider } 29283f959aa3SValentin Schneider 29293f959aa3SValentin Schneider /** 29303f959aa3SValentin Schneider * idle_cull_fn - cull workers that have been idle for too long. 29313f959aa3SValentin Schneider * @work: the pool's work for handling these idle workers 29323f959aa3SValentin Schneider * 29333f959aa3SValentin Schneider * This goes through a pool's idle workers and gets rid of those that have been 29343f959aa3SValentin Schneider * idle for at least IDLE_WORKER_TIMEOUT seconds. 2935e02b9312SValentin Schneider * 2936e02b9312SValentin Schneider * We don't want to disturb isolated CPUs because of a pcpu kworker being 2937e02b9312SValentin Schneider * culled, so this also resets worker affinity. This requires a sleepable 2938e02b9312SValentin Schneider * context, hence the split between timer callback and work item. 29393f959aa3SValentin Schneider */ 29403f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work) 29413f959aa3SValentin Schneider { 29423f959aa3SValentin Schneider struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work); 29439680540cSYang Yingliang LIST_HEAD(cull_list); 2944e22bee78STejun Heo 2945e02b9312SValentin Schneider /* 2946e02b9312SValentin Schneider * Grabbing wq_pool_attach_mutex here ensures an already-running worker 2947f4b7b53cSLai Jiangshan * cannot proceed beyong set_pf_worker() in its self-destruct path. 2948f4b7b53cSLai Jiangshan * This is required as a previously-preempted worker could run after 2949f4b7b53cSLai Jiangshan * set_worker_dying() has happened but before detach_dying_workers() did. 2950e02b9312SValentin Schneider */ 2951e02b9312SValentin Schneider mutex_lock(&wq_pool_attach_mutex); 2952a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2953e22bee78STejun Heo 29543347fc9fSLai Jiangshan while (too_many_workers(pool)) { 2955e22bee78STejun Heo struct worker *worker; 2956e22bee78STejun Heo unsigned long expires; 2957e22bee78STejun Heo 2958d70f5d57SLai Jiangshan worker = list_last_entry(&pool->idle_list, struct worker, entry); 2959e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 2960e22bee78STejun Heo 29613347fc9fSLai Jiangshan if (time_before(jiffies, expires)) { 296263d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 29633347fc9fSLai Jiangshan break; 2964e22bee78STejun Heo } 29653347fc9fSLai Jiangshan 2966e02b9312SValentin Schneider set_worker_dying(worker, &cull_list); 2967e22bee78STejun Heo } 2968e22bee78STejun Heo 2969a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2970f4b7b53cSLai Jiangshan detach_dying_workers(&cull_list); 2971e02b9312SValentin Schneider mutex_unlock(&wq_pool_attach_mutex); 297268f83057SLai Jiangshan 297368f83057SLai Jiangshan reap_dying_workers(&cull_list); 2974e22bee78STejun Heo } 2975e22bee78STejun Heo 2976493a1724STejun Heo static void send_mayday(struct work_struct *work) 2977e22bee78STejun Heo { 2978112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2979112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 2980493a1724STejun Heo 29812e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 2982e22bee78STejun Heo 2983493008a8STejun Heo if (!wq->rescuer) 2984493a1724STejun Heo return; 2985e22bee78STejun Heo 2986e22bee78STejun Heo /* mayday mayday mayday */ 2987493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 298877668c8bSLai Jiangshan /* 298977668c8bSLai Jiangshan * If @pwq is for an unbound wq, its base ref may be put at 299077668c8bSLai Jiangshan * any time due to an attribute change. Pin @pwq until the 299177668c8bSLai Jiangshan * rescuer is done with it. 299277668c8bSLai Jiangshan */ 299377668c8bSLai Jiangshan get_pwq(pwq); 2994493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2995e22bee78STejun Heo wake_up_process(wq->rescuer->task); 2996725e8ec5STejun Heo pwq->stats[PWQ_STAT_MAYDAY]++; 2997493a1724STejun Heo } 2998e22bee78STejun Heo } 2999e22bee78STejun Heo 300032a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t) 3001e22bee78STejun Heo { 300232a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, mayday_timer); 3003e22bee78STejun Heo struct work_struct *work; 3004e22bee78STejun Heo 3005a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3006a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */ 3007e22bee78STejun Heo 300863d95a91STejun Heo if (need_to_create_worker(pool)) { 3009e22bee78STejun Heo /* 3010e22bee78STejun Heo * We've been trying to create a new worker but 3011e22bee78STejun Heo * haven't been successful. We might be hitting an 3012e22bee78STejun Heo * allocation deadlock. Send distress signals to 3013e22bee78STejun Heo * rescuers. 3014e22bee78STejun Heo */ 301563d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 3016e22bee78STejun Heo send_mayday(work); 3017e22bee78STejun Heo } 3018e22bee78STejun Heo 3019a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 3020a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3021e22bee78STejun Heo 302263d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 3023e22bee78STejun Heo } 3024e22bee78STejun Heo 3025e22bee78STejun Heo /** 3026e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 302763d95a91STejun Heo * @pool: pool to create a new worker for 3028e22bee78STejun Heo * 302963d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 3030e22bee78STejun Heo * have at least one idle worker on return from this function. If 3031e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 303263d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 3033e22bee78STejun Heo * possible allocation deadlock. 3034e22bee78STejun Heo * 3035c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 3036c5aa87bbSTejun Heo * may_start_working() %true. 3037e22bee78STejun Heo * 3038e22bee78STejun Heo * LOCKING: 3039a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 3040e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 3041e22bee78STejun Heo * manager. 3042e22bee78STejun Heo */ 304329187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool) 3044d565ed63STejun Heo __releases(&pool->lock) 3045d565ed63STejun Heo __acquires(&pool->lock) 3046e22bee78STejun Heo { 3047e22bee78STejun Heo restart: 3048a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 30499f9c2364STejun Heo 3050e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 305163d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 3052e22bee78STejun Heo 3053e22bee78STejun Heo while (true) { 3054051e1850SLai Jiangshan if (create_worker(pool) || !need_to_create_worker(pool)) 3055e22bee78STejun Heo break; 3056e22bee78STejun Heo 3057e212f361SLai Jiangshan schedule_timeout_interruptible(CREATE_COOLDOWN); 30589f9c2364STejun Heo 305963d95a91STejun Heo if (!need_to_create_worker(pool)) 3060e22bee78STejun Heo break; 3061e22bee78STejun Heo } 3062e22bee78STejun Heo 306363d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 3064a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3065051e1850SLai Jiangshan /* 3066051e1850SLai Jiangshan * This is necessary even after a new worker was just successfully 3067051e1850SLai Jiangshan * created as @pool->lock was dropped and the new worker might have 3068051e1850SLai Jiangshan * already become busy. 3069051e1850SLai Jiangshan */ 307063d95a91STejun Heo if (need_to_create_worker(pool)) 3071e22bee78STejun Heo goto restart; 3072e22bee78STejun Heo } 3073e22bee78STejun Heo 3074e22bee78STejun Heo /** 3075e22bee78STejun Heo * manage_workers - manage worker pool 3076e22bee78STejun Heo * @worker: self 3077e22bee78STejun Heo * 3078706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 3079e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 3080706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 3081e22bee78STejun Heo * 3082e22bee78STejun Heo * The caller can safely start processing works on false return. On 3083e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 3084e22bee78STejun Heo * and may_start_working() is true. 3085e22bee78STejun Heo * 3086e22bee78STejun Heo * CONTEXT: 3087a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 3088e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 3089e22bee78STejun Heo * 3090d185af30SYacine Belkadi * Return: 309129187a9eSTejun Heo * %false if the pool doesn't need management and the caller can safely 309229187a9eSTejun Heo * start processing works, %true if management function was performed and 309329187a9eSTejun Heo * the conditions that the caller verified before calling the function may 309429187a9eSTejun Heo * no longer be true. 3095e22bee78STejun Heo */ 3096e22bee78STejun Heo static bool manage_workers(struct worker *worker) 3097e22bee78STejun Heo { 309863d95a91STejun Heo struct worker_pool *pool = worker->pool; 3099e22bee78STejun Heo 3100692b4825STejun Heo if (pool->flags & POOL_MANAGER_ACTIVE) 310129187a9eSTejun Heo return false; 3102692b4825STejun Heo 3103692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 31042607d7a6STejun Heo pool->manager = worker; 3105e22bee78STejun Heo 310629187a9eSTejun Heo maybe_create_worker(pool); 3107e22bee78STejun Heo 31082607d7a6STejun Heo pool->manager = NULL; 3109692b4825STejun Heo pool->flags &= ~POOL_MANAGER_ACTIVE; 3110d8bb65abSSebastian Andrzej Siewior rcuwait_wake_up(&manager_wait); 311129187a9eSTejun Heo return true; 3112e22bee78STejun Heo } 3113e22bee78STejun Heo 3114a62428c0STejun Heo /** 3115a62428c0STejun Heo * process_one_work - process single work 3116c34056a3STejun Heo * @worker: self 3117a62428c0STejun Heo * @work: work to process 3118a62428c0STejun Heo * 3119a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 3120a62428c0STejun Heo * process a single work including synchronization against and 3121a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 3122a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 3123a62428c0STejun Heo * call this function to process a work. 3124a62428c0STejun Heo * 3125a62428c0STejun Heo * CONTEXT: 3126a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which is released and regrabbed. 3127a62428c0STejun Heo */ 3128c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 3129d565ed63STejun Heo __releases(&pool->lock) 3130d565ed63STejun Heo __acquires(&pool->lock) 31311da177e4SLinus Torvalds { 3132112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 3133bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 3134c4560c2cSLai Jiangshan unsigned long work_data; 3135c35aea39STejun Heo int lockdep_start_depth, rcu_start_depth; 31361acd92d9STejun Heo bool bh_draining = pool->flags & POOL_BH_DRAINING; 31374e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 31384e6045f1SJohannes Berg /* 3139a62428c0STejun Heo * It is permissible to free the struct work_struct from 3140a62428c0STejun Heo * inside the function that is called from it, this we need to 3141a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 3142a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 3143a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 31444e6045f1SJohannes Berg */ 31454d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 31464d82a1deSPeter Zijlstra 31474d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 31484e6045f1SJohannes Berg #endif 3149807407c0SLai Jiangshan /* ensure we're on the correct CPU */ 315085327af6SLai Jiangshan WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 3151ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 315225511a47STejun Heo 31538930cabaSTejun Heo /* claim and dequeue */ 3154dc186ad7SThomas Gleixner debug_work_deactivate(work); 3155c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 3156c34056a3STejun Heo worker->current_work = work; 3157a2c1c57bSTejun Heo worker->current_func = work->func; 3158112202d9STejun Heo worker->current_pwq = pwq; 31594cb1ef64STejun Heo if (worker->task) 3160616db877STejun Heo worker->current_at = worker->task->se.sum_exec_runtime; 3161c4560c2cSLai Jiangshan work_data = *work_data_bits(work); 3162d812796eSLai Jiangshan worker->current_color = get_work_color(work_data); 31637a22ad75STejun Heo 31648bf89593STejun Heo /* 31658bf89593STejun Heo * Record wq name for cmdline and debug reporting, may get 31668bf89593STejun Heo * overridden through set_worker_desc(). 31678bf89593STejun Heo */ 31688bf89593STejun Heo strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN); 31698bf89593STejun Heo 3170a62428c0STejun Heo list_del_init(&work->entry); 3171a62428c0STejun Heo 3172649027d7STejun Heo /* 3173228f1d00SLai Jiangshan * CPU intensive works don't participate in concurrency management. 3174228f1d00SLai Jiangshan * They're the scheduler's responsibility. This takes @worker out 3175228f1d00SLai Jiangshan * of concurrency management and the next code block will chain 3176228f1d00SLai Jiangshan * execution of the pending work items. 3177fb0e7bebSTejun Heo */ 3178616db877STejun Heo if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE)) 3179228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_CPU_INTENSIVE); 3180fb0e7bebSTejun Heo 3181974271c4STejun Heo /* 31820219a352STejun Heo * Kick @pool if necessary. It's always noop for per-cpu worker pools 31830219a352STejun Heo * since nr_running would always be >= 1 at this point. This is used to 31840219a352STejun Heo * chain execution of the pending work items for WORKER_NOT_RUNNING 31850219a352STejun Heo * workers such as the UNBOUND and CPU_INTENSIVE ones. 3186974271c4STejun Heo */ 31870219a352STejun Heo kick_pool(pool); 3188974271c4STejun Heo 31898930cabaSTejun Heo /* 31907c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 3191d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 319223657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 319323657bb1STejun Heo * disabled. 31948930cabaSTejun Heo */ 3195456a78eeSTejun Heo set_work_pool_and_clear_pending(work, pool->id, pool_offq_flags(pool)); 31961da177e4SLinus Torvalds 3197fe48ba7dSMirsad Goran Todorovac pwq->stats[PWQ_STAT_STARTED]++; 3198a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3199365970a1SDavid Howells 3200c35aea39STejun Heo rcu_start_depth = rcu_preempt_depth(); 3201c35aea39STejun Heo lockdep_start_depth = lockdep_depth(current); 32021acd92d9STejun Heo /* see drain_dead_softirq_workfn() */ 32031acd92d9STejun Heo if (!bh_draining) 32044f022f43SMatthew Brost lock_map_acquire(pwq->wq->lockdep_map); 32053295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 3206e6f3faa7SPeter Zijlstra /* 3207f52be570SPeter Zijlstra * Strictly speaking we should mark the invariant state without holding 3208f52be570SPeter Zijlstra * any locks, that is, before these two lock_map_acquire()'s. 3209e6f3faa7SPeter Zijlstra * 3210e6f3faa7SPeter Zijlstra * However, that would result in: 3211e6f3faa7SPeter Zijlstra * 3212e6f3faa7SPeter Zijlstra * A(W1) 3213e6f3faa7SPeter Zijlstra * WFC(C) 3214e6f3faa7SPeter Zijlstra * A(W1) 3215e6f3faa7SPeter Zijlstra * C(C) 3216e6f3faa7SPeter Zijlstra * 3217e6f3faa7SPeter Zijlstra * Which would create W1->C->W1 dependencies, even though there is no 3218e6f3faa7SPeter Zijlstra * actual deadlock possible. There are two solutions, using a 3219e6f3faa7SPeter Zijlstra * read-recursive acquire on the work(queue) 'locks', but this will then 3220f52be570SPeter Zijlstra * hit the lockdep limitation on recursive locks, or simply discard 3221e6f3faa7SPeter Zijlstra * these locks. 3222e6f3faa7SPeter Zijlstra * 3223e6f3faa7SPeter Zijlstra * AFAICT there is no possible deadlock scenario between the 3224e6f3faa7SPeter Zijlstra * flush_work() and complete() primitives (except for single-threaded 3225e6f3faa7SPeter Zijlstra * workqueues), so hiding them isn't a problem. 3226e6f3faa7SPeter Zijlstra */ 3227f52be570SPeter Zijlstra lockdep_invariant_state(true); 3228e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 3229a2c1c57bSTejun Heo worker->current_func(work); 3230e36c886aSArjan van de Ven /* 3231e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 3232e36c886aSArjan van de Ven * point will only record its address. 3233e36c886aSArjan van de Ven */ 32341c5da0ecSDaniel Jordan trace_workqueue_execute_end(work, worker->current_func); 3235725e8ec5STejun Heo pwq->stats[PWQ_STAT_COMPLETED]++; 32363295f0efSIngo Molnar lock_map_release(&lockdep_map); 32371acd92d9STejun Heo if (!bh_draining) 32384f022f43SMatthew Brost lock_map_release(pwq->wq->lockdep_map); 32391da177e4SLinus Torvalds 3240c35aea39STejun Heo if (unlikely((worker->task && in_atomic()) || 3241c35aea39STejun Heo lockdep_depth(current) != lockdep_start_depth || 3242c35aea39STejun Heo rcu_preempt_depth() != rcu_start_depth)) { 3243c35aea39STejun Heo pr_err("BUG: workqueue leaked atomic, lock or RCU: %s[%d]\n" 3244c35aea39STejun Heo " preempt=0x%08x lock=%d->%d RCU=%d->%d workfn=%ps\n", 3245c35aea39STejun Heo current->comm, task_pid_nr(current), preempt_count(), 3246c35aea39STejun Heo lockdep_start_depth, lockdep_depth(current), 3247c35aea39STejun Heo rcu_start_depth, rcu_preempt_depth(), 3248c35aea39STejun Heo worker->current_func); 3249d5abe669SPeter Zijlstra debug_show_held_locks(current); 3250d5abe669SPeter Zijlstra dump_stack(); 3251d5abe669SPeter Zijlstra } 3252d5abe669SPeter Zijlstra 3253b22ce278STejun Heo /* 3254025f50f3SSebastian Andrzej Siewior * The following prevents a kworker from hogging CPU on !PREEMPTION 3255b22ce278STejun Heo * kernels, where a requeueing work item waiting for something to 3256b22ce278STejun Heo * happen could deadlock with stop_machine as such work item could 3257b22ce278STejun Heo * indefinitely requeue itself while all other CPUs are trapped in 3258789cbbecSJoe Lawrence * stop_machine. At the same time, report a quiescent RCU state so 3259789cbbecSJoe Lawrence * the same condition doesn't freeze RCU. 3260b22ce278STejun Heo */ 32614cb1ef64STejun Heo if (worker->task) 3262a7e6425eSPaul E. McKenney cond_resched(); 3263b22ce278STejun Heo 3264a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3265a62428c0STejun Heo 3266616db877STejun Heo /* 3267616db877STejun Heo * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked 3268616db877STejun Heo * CPU intensive by wq_worker_tick() if @work hogged CPU longer than 3269616db877STejun Heo * wq_cpu_intensive_thresh_us. Clear it. 3270616db877STejun Heo */ 3271fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 3272fb0e7bebSTejun Heo 32731b69ac6bSJohannes Weiner /* tag the worker for identification in schedule() */ 32741b69ac6bSJohannes Weiner worker->last_func = worker->current_func; 32751b69ac6bSJohannes Weiner 3276a62428c0STejun Heo /* we're done with it, release */ 327742f8570fSSasha Levin hash_del(&worker->hentry); 3278c34056a3STejun Heo worker->current_work = NULL; 3279a2c1c57bSTejun Heo worker->current_func = NULL; 3280112202d9STejun Heo worker->current_pwq = NULL; 3281d812796eSLai Jiangshan worker->current_color = INT_MAX; 3282dd6c3c54STejun Heo 3283dd6c3c54STejun Heo /* must be the last step, see the function comment */ 3284c4560c2cSLai Jiangshan pwq_dec_nr_in_flight(pwq, work_data); 32851da177e4SLinus Torvalds } 32861da177e4SLinus Torvalds 3287affee4b2STejun Heo /** 3288affee4b2STejun Heo * process_scheduled_works - process scheduled works 3289affee4b2STejun Heo * @worker: self 3290affee4b2STejun Heo * 3291affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 3292affee4b2STejun Heo * may change while processing a work, so this function repeatedly 3293affee4b2STejun Heo * fetches a work from the top and executes it. 3294affee4b2STejun Heo * 3295affee4b2STejun Heo * CONTEXT: 3296a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 3297affee4b2STejun Heo * multiple times. 3298affee4b2STejun Heo */ 3299affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 33001da177e4SLinus Torvalds { 3301c0ab017dSTejun Heo struct work_struct *work; 3302c0ab017dSTejun Heo bool first = true; 3303c0ab017dSTejun Heo 3304c0ab017dSTejun Heo while ((work = list_first_entry_or_null(&worker->scheduled, 3305c0ab017dSTejun Heo struct work_struct, entry))) { 3306c0ab017dSTejun Heo if (first) { 3307c0ab017dSTejun Heo worker->pool->watchdog_ts = jiffies; 3308c0ab017dSTejun Heo first = false; 3309c0ab017dSTejun Heo } 3310c34056a3STejun Heo process_one_work(worker, work); 3311a62428c0STejun Heo } 33121da177e4SLinus Torvalds } 33131da177e4SLinus Torvalds 3314197f6accSTejun Heo static void set_pf_worker(bool val) 3315197f6accSTejun Heo { 3316197f6accSTejun Heo mutex_lock(&wq_pool_attach_mutex); 3317197f6accSTejun Heo if (val) 3318197f6accSTejun Heo current->flags |= PF_WQ_WORKER; 3319197f6accSTejun Heo else 3320197f6accSTejun Heo current->flags &= ~PF_WQ_WORKER; 3321197f6accSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 3322197f6accSTejun Heo } 3323197f6accSTejun Heo 33244690c4abSTejun Heo /** 33254690c4abSTejun Heo * worker_thread - the worker thread function 3326c34056a3STejun Heo * @__worker: self 33274690c4abSTejun Heo * 3328c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 3329c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 3330c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 3331c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 3332c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 3333d185af30SYacine Belkadi * 3334d185af30SYacine Belkadi * Return: 0 33354690c4abSTejun Heo */ 3336c34056a3STejun Heo static int worker_thread(void *__worker) 33371da177e4SLinus Torvalds { 3338c34056a3STejun Heo struct worker *worker = __worker; 3339bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 33401da177e4SLinus Torvalds 3341e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 3342197f6accSTejun Heo set_pf_worker(true); 3343c8e55f36STejun Heo woke_up: 3344a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3345affee4b2STejun Heo 3346a9ab775bSTejun Heo /* am I supposed to die? */ 3347a9ab775bSTejun Heo if (unlikely(worker->flags & WORKER_DIE)) { 3348a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3349197f6accSTejun Heo set_pf_worker(false); 335073613840SLai Jiangshan /* 335173613840SLai Jiangshan * The worker is dead and PF_WQ_WORKER is cleared, worker->pool 335273613840SLai Jiangshan * shouldn't be accessed, reset it to NULL in case otherwise. 335373613840SLai Jiangshan */ 335473613840SLai Jiangshan worker->pool = NULL; 3355e441b56fSZhen Lei ida_free(&pool->worker_ida, worker->id); 3356c8e55f36STejun Heo return 0; 3357c8e55f36STejun Heo } 3358c8e55f36STejun Heo 3359c8e55f36STejun Heo worker_leave_idle(worker); 3360db7bccf4STejun Heo recheck: 3361e22bee78STejun Heo /* no more worker necessary? */ 336263d95a91STejun Heo if (!need_more_worker(pool)) 3363e22bee78STejun Heo goto sleep; 3364e22bee78STejun Heo 3365e22bee78STejun Heo /* do we need to manage? */ 336663d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 3367e22bee78STejun Heo goto recheck; 3368e22bee78STejun Heo 3369c8e55f36STejun Heo /* 3370c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 3371c8e55f36STejun Heo * preparing to process a work or actually processing it. 3372c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 3373c8e55f36STejun Heo */ 33746183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 3375c8e55f36STejun Heo 3376e22bee78STejun Heo /* 3377a9ab775bSTejun Heo * Finish PREP stage. We're guaranteed to have at least one idle 3378a9ab775bSTejun Heo * worker or that someone else has already assumed the manager 3379a9ab775bSTejun Heo * role. This is where @worker starts participating in concurrency 3380a9ab775bSTejun Heo * management if applicable and concurrency management is restored 3381a9ab775bSTejun Heo * after being rebound. See rebind_workers() for details. 3382e22bee78STejun Heo */ 3383a9ab775bSTejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 3384e22bee78STejun Heo 3385e22bee78STejun Heo do { 3386affee4b2STejun Heo struct work_struct *work = 3387bd7bdd43STejun Heo list_first_entry(&pool->worklist, 3388affee4b2STejun Heo struct work_struct, entry); 3389affee4b2STejun Heo 3390873eaca6STejun Heo if (assign_work(work, worker, NULL)) 3391affee4b2STejun Heo process_scheduled_works(worker); 339263d95a91STejun Heo } while (keep_working(pool)); 3393affee4b2STejun Heo 3394228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_PREP); 3395d313dd85STejun Heo sleep: 3396c8e55f36STejun Heo /* 3397d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 3398d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 3399d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 3400d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 3401d565ed63STejun Heo * event. 3402c8e55f36STejun Heo */ 3403c8e55f36STejun Heo worker_enter_idle(worker); 3404c5a94a61SPeter Zijlstra __set_current_state(TASK_IDLE); 3405a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 34061da177e4SLinus Torvalds schedule(); 3407c8e55f36STejun Heo goto woke_up; 34081da177e4SLinus Torvalds } 34091da177e4SLinus Torvalds 3410e22bee78STejun Heo /** 3411e22bee78STejun Heo * rescuer_thread - the rescuer thread function 3412111c225aSTejun Heo * @__rescuer: self 3413e22bee78STejun Heo * 3414e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 3415493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 3416e22bee78STejun Heo * 3417706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 3418e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 3419e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 3420e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 3421e22bee78STejun Heo * the problem rescuer solves. 3422e22bee78STejun Heo * 3423706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 3424706026c2STejun Heo * workqueues which have works queued on the pool and let them process 3425e22bee78STejun Heo * those works so that forward progress can be guaranteed. 3426e22bee78STejun Heo * 3427e22bee78STejun Heo * This should happen rarely. 3428d185af30SYacine Belkadi * 3429d185af30SYacine Belkadi * Return: 0 3430e22bee78STejun Heo */ 3431111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 3432e22bee78STejun Heo { 3433111c225aSTejun Heo struct worker *rescuer = __rescuer; 3434111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 34354d595b86SLai Jiangshan bool should_stop; 3436e22bee78STejun Heo 3437e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 3438111c225aSTejun Heo 3439111c225aSTejun Heo /* 3440111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 3441111c225aSTejun Heo * doesn't participate in concurrency management. 3442111c225aSTejun Heo */ 3443197f6accSTejun Heo set_pf_worker(true); 3444e22bee78STejun Heo repeat: 3445c5a94a61SPeter Zijlstra set_current_state(TASK_IDLE); 34461da177e4SLinus Torvalds 34474d595b86SLai Jiangshan /* 34484d595b86SLai Jiangshan * By the time the rescuer is requested to stop, the workqueue 34494d595b86SLai Jiangshan * shouldn't have any work pending, but @wq->maydays may still have 34504d595b86SLai Jiangshan * pwq(s) queued. This can happen by non-rescuer workers consuming 34514d595b86SLai Jiangshan * all the work items before the rescuer got to them. Go through 34524d595b86SLai Jiangshan * @wq->maydays processing before acting on should_stop so that the 34534d595b86SLai Jiangshan * list is always empty on exit. 34544d595b86SLai Jiangshan */ 34554d595b86SLai Jiangshan should_stop = kthread_should_stop(); 34561da177e4SLinus Torvalds 3457493a1724STejun Heo /* see whether any pwq is asking for help */ 3458a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 3459493a1724STejun Heo 3460493a1724STejun Heo while (!list_empty(&wq->maydays)) { 3461493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 3462493a1724STejun Heo struct pool_workqueue, mayday_node); 3463112202d9STejun Heo struct worker_pool *pool = pwq->pool; 3464e22bee78STejun Heo struct work_struct *work, *n; 3465e22bee78STejun Heo 3466e22bee78STejun Heo __set_current_state(TASK_RUNNING); 3467493a1724STejun Heo list_del_init(&pwq->mayday_node); 3468493a1724STejun Heo 3469a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 3470e22bee78STejun Heo 347151697d39SLai Jiangshan worker_attach_to_pool(rescuer, pool); 347251697d39SLai Jiangshan 3473a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3474e22bee78STejun Heo 3475e22bee78STejun Heo /* 3476e22bee78STejun Heo * Slurp in all works issued via this workqueue and 3477e22bee78STejun Heo * process'em. 3478e22bee78STejun Heo */ 3479873eaca6STejun Heo WARN_ON_ONCE(!list_empty(&rescuer->scheduled)); 348082607adcSTejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) { 3481873eaca6STejun Heo if (get_work_pwq(work) == pwq && 3482873eaca6STejun Heo assign_work(work, rescuer, &n)) 3483725e8ec5STejun Heo pwq->stats[PWQ_STAT_RESCUED]++; 348482607adcSTejun Heo } 3485e22bee78STejun Heo 3486873eaca6STejun Heo if (!list_empty(&rescuer->scheduled)) { 3487e22bee78STejun Heo process_scheduled_works(rescuer); 34887576958aSTejun Heo 34897576958aSTejun Heo /* 3490008847f6SNeilBrown * The above execution of rescued work items could 3491008847f6SNeilBrown * have created more to rescue through 3492f97a4a1aSLai Jiangshan * pwq_activate_first_inactive() or chained 3493008847f6SNeilBrown * queueing. Let's put @pwq back on mayday list so 3494008847f6SNeilBrown * that such back-to-back work items, which may be 3495008847f6SNeilBrown * being used to relieve memory pressure, don't 3496008847f6SNeilBrown * incur MAYDAY_INTERVAL delay inbetween. 3497008847f6SNeilBrown */ 34984f3f4cf3SLai Jiangshan if (pwq->nr_active && need_to_create_worker(pool)) { 3499a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); 3500e66b39afSTejun Heo /* 3501e66b39afSTejun Heo * Queue iff we aren't racing destruction 3502e66b39afSTejun Heo * and somebody else hasn't queued it already. 3503e66b39afSTejun Heo */ 3504e66b39afSTejun Heo if (wq->rescuer && list_empty(&pwq->mayday_node)) { 3505008847f6SNeilBrown get_pwq(pwq); 3506e66b39afSTejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 3507e66b39afSTejun Heo } 3508a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 3509008847f6SNeilBrown } 3510008847f6SNeilBrown } 3511008847f6SNeilBrown 3512008847f6SNeilBrown /* 351377668c8bSLai Jiangshan * Put the reference grabbed by send_mayday(). @pool won't 351413b1d625SLai Jiangshan * go away while we're still attached to it. 351577668c8bSLai Jiangshan */ 351677668c8bSLai Jiangshan put_pwq(pwq); 351777668c8bSLai Jiangshan 351877668c8bSLai Jiangshan /* 35190219a352STejun Heo * Leave this pool. Notify regular workers; otherwise, we end up 35200219a352STejun Heo * with 0 concurrency and stalling the execution. 35217576958aSTejun Heo */ 35220219a352STejun Heo kick_pool(pool); 35237576958aSTejun Heo 3524a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 352513b1d625SLai Jiangshan 3526a2d812a2STejun Heo worker_detach_from_pool(rescuer); 352713b1d625SLai Jiangshan 3528a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 35291da177e4SLinus Torvalds } 35301da177e4SLinus Torvalds 3531a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 3532493a1724STejun Heo 35334d595b86SLai Jiangshan if (should_stop) { 35344d595b86SLai Jiangshan __set_current_state(TASK_RUNNING); 3535197f6accSTejun Heo set_pf_worker(false); 35364d595b86SLai Jiangshan return 0; 35374d595b86SLai Jiangshan } 35384d595b86SLai Jiangshan 3539111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 3540111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 3541e22bee78STejun Heo schedule(); 3542e22bee78STejun Heo goto repeat; 35431da177e4SLinus Torvalds } 35441da177e4SLinus Torvalds 35454cb1ef64STejun Heo static void bh_worker(struct worker *worker) 35464cb1ef64STejun Heo { 35474cb1ef64STejun Heo struct worker_pool *pool = worker->pool; 35484cb1ef64STejun Heo int nr_restarts = BH_WORKER_RESTARTS; 35494cb1ef64STejun Heo unsigned long end = jiffies + BH_WORKER_JIFFIES; 35504cb1ef64STejun Heo 35514cb1ef64STejun Heo raw_spin_lock_irq(&pool->lock); 35524cb1ef64STejun Heo worker_leave_idle(worker); 35534cb1ef64STejun Heo 35544cb1ef64STejun Heo /* 35554cb1ef64STejun Heo * This function follows the structure of worker_thread(). See there for 35564cb1ef64STejun Heo * explanations on each step. 35574cb1ef64STejun Heo */ 35584cb1ef64STejun Heo if (!need_more_worker(pool)) 35594cb1ef64STejun Heo goto done; 35604cb1ef64STejun Heo 35614cb1ef64STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 35624cb1ef64STejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 35634cb1ef64STejun Heo 35644cb1ef64STejun Heo do { 35654cb1ef64STejun Heo struct work_struct *work = 35664cb1ef64STejun Heo list_first_entry(&pool->worklist, 35674cb1ef64STejun Heo struct work_struct, entry); 35684cb1ef64STejun Heo 35694cb1ef64STejun Heo if (assign_work(work, worker, NULL)) 35704cb1ef64STejun Heo process_scheduled_works(worker); 35714cb1ef64STejun Heo } while (keep_working(pool) && 35724cb1ef64STejun Heo --nr_restarts && time_before(jiffies, end)); 35734cb1ef64STejun Heo 35744cb1ef64STejun Heo worker_set_flags(worker, WORKER_PREP); 35754cb1ef64STejun Heo done: 35764cb1ef64STejun Heo worker_enter_idle(worker); 35774cb1ef64STejun Heo kick_pool(pool); 35784cb1ef64STejun Heo raw_spin_unlock_irq(&pool->lock); 35794cb1ef64STejun Heo } 35804cb1ef64STejun Heo 35814cb1ef64STejun Heo /* 35824cb1ef64STejun Heo * TODO: Convert all tasklet users to workqueue and use softirq directly. 35834cb1ef64STejun Heo * 35844cb1ef64STejun Heo * This is currently called from tasklet[_hi]action() and thus is also called 35854cb1ef64STejun Heo * whenever there are tasklets to run. Let's do an early exit if there's nothing 35864cb1ef64STejun Heo * queued. Once conversion from tasklet is complete, the need_more_worker() test 35874cb1ef64STejun Heo * can be dropped. 35884cb1ef64STejun Heo * 35894cb1ef64STejun Heo * After full conversion, we'll add worker->softirq_action, directly use the 35904cb1ef64STejun Heo * softirq action and obtain the worker pointer from the softirq_action pointer. 35914cb1ef64STejun Heo */ 35924cb1ef64STejun Heo void workqueue_softirq_action(bool highpri) 35934cb1ef64STejun Heo { 35944cb1ef64STejun Heo struct worker_pool *pool = 35954cb1ef64STejun Heo &per_cpu(bh_worker_pools, smp_processor_id())[highpri]; 35964cb1ef64STejun Heo if (need_more_worker(pool)) 35974cb1ef64STejun Heo bh_worker(list_first_entry(&pool->workers, struct worker, node)); 35984cb1ef64STejun Heo } 35994cb1ef64STejun Heo 36001acd92d9STejun Heo struct wq_drain_dead_softirq_work { 36011acd92d9STejun Heo struct work_struct work; 36021acd92d9STejun Heo struct worker_pool *pool; 36031acd92d9STejun Heo struct completion done; 36041acd92d9STejun Heo }; 36051acd92d9STejun Heo 36061acd92d9STejun Heo static void drain_dead_softirq_workfn(struct work_struct *work) 36071acd92d9STejun Heo { 36081acd92d9STejun Heo struct wq_drain_dead_softirq_work *dead_work = 36091acd92d9STejun Heo container_of(work, struct wq_drain_dead_softirq_work, work); 36101acd92d9STejun Heo struct worker_pool *pool = dead_work->pool; 36111acd92d9STejun Heo bool repeat; 36121acd92d9STejun Heo 36131acd92d9STejun Heo /* 36141acd92d9STejun Heo * @pool's CPU is dead and we want to execute its still pending work 36151acd92d9STejun Heo * items from this BH work item which is running on a different CPU. As 36161acd92d9STejun Heo * its CPU is dead, @pool can't be kicked and, as work execution path 36171acd92d9STejun Heo * will be nested, a lockdep annotation needs to be suppressed. Mark 36181acd92d9STejun Heo * @pool with %POOL_BH_DRAINING for the special treatments. 36191acd92d9STejun Heo */ 36201acd92d9STejun Heo raw_spin_lock_irq(&pool->lock); 36211acd92d9STejun Heo pool->flags |= POOL_BH_DRAINING; 36221acd92d9STejun Heo raw_spin_unlock_irq(&pool->lock); 36231acd92d9STejun Heo 36241acd92d9STejun Heo bh_worker(list_first_entry(&pool->workers, struct worker, node)); 36251acd92d9STejun Heo 36261acd92d9STejun Heo raw_spin_lock_irq(&pool->lock); 36271acd92d9STejun Heo pool->flags &= ~POOL_BH_DRAINING; 36281acd92d9STejun Heo repeat = need_more_worker(pool); 36291acd92d9STejun Heo raw_spin_unlock_irq(&pool->lock); 36301acd92d9STejun Heo 36311acd92d9STejun Heo /* 36321acd92d9STejun Heo * bh_worker() might hit consecutive execution limit and bail. If there 36331acd92d9STejun Heo * still are pending work items, reschedule self and return so that we 36341acd92d9STejun Heo * don't hog this CPU's BH. 36351acd92d9STejun Heo */ 36361acd92d9STejun Heo if (repeat) { 36371acd92d9STejun Heo if (pool->attrs->nice == HIGHPRI_NICE_LEVEL) 36381acd92d9STejun Heo queue_work(system_bh_highpri_wq, work); 36391acd92d9STejun Heo else 36401acd92d9STejun Heo queue_work(system_bh_wq, work); 36411acd92d9STejun Heo } else { 36421acd92d9STejun Heo complete(&dead_work->done); 36431acd92d9STejun Heo } 36441acd92d9STejun Heo } 36451acd92d9STejun Heo 36461acd92d9STejun Heo /* 36471acd92d9STejun Heo * @cpu is dead. Drain the remaining BH work items on the current CPU. It's 36481acd92d9STejun Heo * possible to allocate dead_work per CPU and avoid flushing. However, then we 36491acd92d9STejun Heo * have to worry about draining overlapping with CPU coming back online or 36501acd92d9STejun Heo * nesting (one CPU's dead_work queued on another CPU which is also dead and so 36511acd92d9STejun Heo * on). Let's keep it simple and drain them synchronously. These are BH work 36521acd92d9STejun Heo * items which shouldn't be requeued on the same pool. Shouldn't take long. 36531acd92d9STejun Heo */ 36541acd92d9STejun Heo void workqueue_softirq_dead(unsigned int cpu) 36551acd92d9STejun Heo { 36561acd92d9STejun Heo int i; 36571acd92d9STejun Heo 36581acd92d9STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 36591acd92d9STejun Heo struct worker_pool *pool = &per_cpu(bh_worker_pools, cpu)[i]; 36601acd92d9STejun Heo struct wq_drain_dead_softirq_work dead_work; 36611acd92d9STejun Heo 36621acd92d9STejun Heo if (!need_more_worker(pool)) 36631acd92d9STejun Heo continue; 36641acd92d9STejun Heo 3665e7cc3be6SLai Jiangshan INIT_WORK_ONSTACK(&dead_work.work, drain_dead_softirq_workfn); 36661acd92d9STejun Heo dead_work.pool = pool; 36671acd92d9STejun Heo init_completion(&dead_work.done); 36681acd92d9STejun Heo 36691acd92d9STejun Heo if (pool->attrs->nice == HIGHPRI_NICE_LEVEL) 36701acd92d9STejun Heo queue_work(system_bh_highpri_wq, &dead_work.work); 36711acd92d9STejun Heo else 36721acd92d9STejun Heo queue_work(system_bh_wq, &dead_work.work); 36731acd92d9STejun Heo 36741acd92d9STejun Heo wait_for_completion(&dead_work.done); 367531103f40SZqiang destroy_work_on_stack(&dead_work.work); 36761acd92d9STejun Heo } 36771acd92d9STejun Heo } 36781acd92d9STejun Heo 3679fca839c0STejun Heo /** 3680fca839c0STejun Heo * check_flush_dependency - check for flush dependency sanity 3681fca839c0STejun Heo * @target_wq: workqueue being flushed 3682fca839c0STejun Heo * @target_work: work item being flushed (NULL for workqueue flushes) 3683*de35994eSTvrtko Ursulin * @from_cancel: are we called from the work cancel path 3684fca839c0STejun Heo * 3685fca839c0STejun Heo * %current is trying to flush the whole @target_wq or @target_work on it. 3686*de35994eSTvrtko Ursulin * If this is not the cancel path (which implies work being flushed is either 3687*de35994eSTvrtko Ursulin * already running, or will not be at all), check if @target_wq doesn't have 3688*de35994eSTvrtko Ursulin * %WQ_MEM_RECLAIM and verify that %current is not reclaiming memory or running 3689*de35994eSTvrtko Ursulin * on a workqueue which doesn't have %WQ_MEM_RECLAIM as that can break forward- 3690*de35994eSTvrtko Ursulin * progress guarantee leading to a deadlock. 3691fca839c0STejun Heo */ 3692fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq, 3693*de35994eSTvrtko Ursulin struct work_struct *target_work, 3694*de35994eSTvrtko Ursulin bool from_cancel) 3695fca839c0STejun Heo { 3696*de35994eSTvrtko Ursulin work_func_t target_func; 3697fca839c0STejun Heo struct worker *worker; 3698fca839c0STejun Heo 3699*de35994eSTvrtko Ursulin if (from_cancel || target_wq->flags & WQ_MEM_RECLAIM) 3700fca839c0STejun Heo return; 3701fca839c0STejun Heo 3702fca839c0STejun Heo worker = current_wq_worker(); 3703*de35994eSTvrtko Ursulin target_func = target_work ? target_work->func : NULL; 3704fca839c0STejun Heo 3705fca839c0STejun Heo WARN_ONCE(current->flags & PF_MEMALLOC, 3706d75f773cSSakari Ailus "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps", 3707fca839c0STejun Heo current->pid, current->comm, target_wq->name, target_func); 370823d11a58STejun Heo WARN_ONCE(worker && ((worker->current_pwq->wq->flags & 370923d11a58STejun Heo (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM), 3710d75f773cSSakari Ailus "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps", 3711fca839c0STejun Heo worker->current_pwq->wq->name, worker->current_func, 3712fca839c0STejun Heo target_wq->name, target_func); 3713fca839c0STejun Heo } 3714fca839c0STejun Heo 3715fc2e4d70SOleg Nesterov struct wq_barrier { 3716fc2e4d70SOleg Nesterov struct work_struct work; 3717fc2e4d70SOleg Nesterov struct completion done; 37182607d7a6STejun Heo struct task_struct *task; /* purely informational */ 3719fc2e4d70SOleg Nesterov }; 3720fc2e4d70SOleg Nesterov 3721fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 3722fc2e4d70SOleg Nesterov { 3723fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 3724fc2e4d70SOleg Nesterov complete(&barr->done); 3725fc2e4d70SOleg Nesterov } 3726fc2e4d70SOleg Nesterov 37274690c4abSTejun Heo /** 37284690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 3729112202d9STejun Heo * @pwq: pwq to insert barrier into 37304690c4abSTejun Heo * @barr: wq_barrier to insert 3731affee4b2STejun Heo * @target: target work to attach @barr to 3732affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 37334690c4abSTejun Heo * 3734affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 3735affee4b2STejun Heo * @target finishes execution. Please note that the ordering 3736affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 3737affee4b2STejun Heo * cpu. 3738affee4b2STejun Heo * 3739affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 3740affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 3741affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 3742affee4b2STejun Heo * flag of the previous work while there must be a valid next work 3743affee4b2STejun Heo * after a work with LINKED flag set. 3744affee4b2STejun Heo * 3745affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 3746112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 37474690c4abSTejun Heo * 37484690c4abSTejun Heo * CONTEXT: 3749a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 37504690c4abSTejun Heo */ 3751112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 3752affee4b2STejun Heo struct wq_barrier *barr, 3753affee4b2STejun Heo struct work_struct *target, struct worker *worker) 3754fc2e4d70SOleg Nesterov { 37554cb1ef64STejun Heo static __maybe_unused struct lock_class_key bh_key, thr_key; 3756d812796eSLai Jiangshan unsigned int work_flags = 0; 3757d812796eSLai Jiangshan unsigned int work_color; 3758affee4b2STejun Heo struct list_head *head; 3759affee4b2STejun Heo 3760dc186ad7SThomas Gleixner /* 3761d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 3762dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 3763dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 3764dc186ad7SThomas Gleixner * might deadlock. 37654cb1ef64STejun Heo * 37664cb1ef64STejun Heo * BH and threaded workqueues need separate lockdep keys to avoid 37674cb1ef64STejun Heo * spuriously triggering "inconsistent {SOFTIRQ-ON-W} -> {IN-SOFTIRQ-W} 37684cb1ef64STejun Heo * usage". 3769dc186ad7SThomas Gleixner */ 37704cb1ef64STejun Heo INIT_WORK_ONSTACK_KEY(&barr->work, wq_barrier_func, 37714cb1ef64STejun Heo (pwq->wq->flags & WQ_BH) ? &bh_key : &thr_key); 377222df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 377352fa5bc5SBoqun Feng 3774fd1a5b04SByungchul Park init_completion_map(&barr->done, &target->lockdep_map); 3775fd1a5b04SByungchul Park 37762607d7a6STejun Heo barr->task = current; 377783c22520SOleg Nesterov 37785797b1c1STejun Heo /* The barrier work item does not participate in nr_active. */ 3779018f3a13SLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 3780018f3a13SLai Jiangshan 3781affee4b2STejun Heo /* 3782affee4b2STejun Heo * If @target is currently being executed, schedule the 3783affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 3784affee4b2STejun Heo */ 3785d812796eSLai Jiangshan if (worker) { 3786affee4b2STejun Heo head = worker->scheduled.next; 3787d812796eSLai Jiangshan work_color = worker->current_color; 3788d812796eSLai Jiangshan } else { 3789affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 3790affee4b2STejun Heo 3791affee4b2STejun Heo head = target->entry.next; 3792affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 3793d21cece0SLai Jiangshan work_flags |= *bits & WORK_STRUCT_LINKED; 3794d812796eSLai Jiangshan work_color = get_work_color(*bits); 3795affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 3796affee4b2STejun Heo } 3797affee4b2STejun Heo 3798d812796eSLai Jiangshan pwq->nr_in_flight[work_color]++; 3799d812796eSLai Jiangshan work_flags |= work_color_to_flags(work_color); 3800d812796eSLai Jiangshan 3801d21cece0SLai Jiangshan insert_work(pwq, &barr->work, head, work_flags); 3802fc2e4d70SOleg Nesterov } 3803fc2e4d70SOleg Nesterov 380473f53c4aSTejun Heo /** 3805112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 380673f53c4aSTejun Heo * @wq: workqueue being flushed 380773f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 380873f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 380973f53c4aSTejun Heo * 3810112202d9STejun Heo * Prepare pwqs for workqueue flushing. 381173f53c4aSTejun Heo * 3812112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 3813112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 3814112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 3815112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 3816112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 381773f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 381873f53c4aSTejun Heo * 381973f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 382073f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 382173f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 382273f53c4aSTejun Heo * is returned. 382373f53c4aSTejun Heo * 3824112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 382573f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 382673f53c4aSTejun Heo * advanced to @work_color. 382773f53c4aSTejun Heo * 382873f53c4aSTejun Heo * CONTEXT: 38293c25a55dSLai Jiangshan * mutex_lock(wq->mutex). 383073f53c4aSTejun Heo * 3831d185af30SYacine Belkadi * Return: 383273f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 383373f53c4aSTejun Heo * otherwise. 383473f53c4aSTejun Heo */ 3835112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 383673f53c4aSTejun Heo int flush_color, int work_color) 38371da177e4SLinus Torvalds { 383873f53c4aSTejun Heo bool wait = false; 383949e3cf44STejun Heo struct pool_workqueue *pwq; 384085f0d8e3SWangyang Guo struct worker_pool *current_pool = NULL; 38411da177e4SLinus Torvalds 384273f53c4aSTejun Heo if (flush_color >= 0) { 38436183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 3844112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 3845dc186ad7SThomas Gleixner } 384614441960SOleg Nesterov 384785f0d8e3SWangyang Guo /* 384885f0d8e3SWangyang Guo * For unbound workqueue, pwqs will map to only a few pools. 384985f0d8e3SWangyang Guo * Most of the time, pwqs within the same pool will be linked 385085f0d8e3SWangyang Guo * sequentially to wq->pwqs by cpu index. So in the majority 385185f0d8e3SWangyang Guo * of pwq iters, the pool is the same, only doing lock/unlock 385285f0d8e3SWangyang Guo * if the pool has changed. This can largely reduce expensive 385385f0d8e3SWangyang Guo * lock operations. 385485f0d8e3SWangyang Guo */ 385549e3cf44STejun Heo for_each_pwq(pwq, wq) { 385685f0d8e3SWangyang Guo if (current_pool != pwq->pool) { 385785f0d8e3SWangyang Guo if (likely(current_pool)) 385885f0d8e3SWangyang Guo raw_spin_unlock_irq(¤t_pool->lock); 385985f0d8e3SWangyang Guo current_pool = pwq->pool; 386085f0d8e3SWangyang Guo raw_spin_lock_irq(¤t_pool->lock); 386185f0d8e3SWangyang Guo } 386273f53c4aSTejun Heo 386373f53c4aSTejun Heo if (flush_color >= 0) { 38646183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 386573f53c4aSTejun Heo 3866112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 3867112202d9STejun Heo pwq->flush_color = flush_color; 3868112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 386973f53c4aSTejun Heo wait = true; 38701da177e4SLinus Torvalds } 387173f53c4aSTejun Heo } 387273f53c4aSTejun Heo 387373f53c4aSTejun Heo if (work_color >= 0) { 38746183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 3875112202d9STejun Heo pwq->work_color = work_color; 387673f53c4aSTejun Heo } 387773f53c4aSTejun Heo 38781da177e4SLinus Torvalds } 38791da177e4SLinus Torvalds 388085f0d8e3SWangyang Guo if (current_pool) 388185f0d8e3SWangyang Guo raw_spin_unlock_irq(¤t_pool->lock); 388285f0d8e3SWangyang Guo 3883112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 388473f53c4aSTejun Heo complete(&wq->first_flusher->done); 388573f53c4aSTejun Heo 388673f53c4aSTejun Heo return wait; 388783c22520SOleg Nesterov } 38881da177e4SLinus Torvalds 3889c35aea39STejun Heo static void touch_wq_lockdep_map(struct workqueue_struct *wq) 3890c35aea39STejun Heo { 38914cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP 389284c425beSSergey Senozhatsky if (unlikely(!wq->lockdep_map)) 389384c425beSSergey Senozhatsky return; 389484c425beSSergey Senozhatsky 38954cb1ef64STejun Heo if (wq->flags & WQ_BH) 38964cb1ef64STejun Heo local_bh_disable(); 38974cb1ef64STejun Heo 38984f022f43SMatthew Brost lock_map_acquire(wq->lockdep_map); 38994f022f43SMatthew Brost lock_map_release(wq->lockdep_map); 39004cb1ef64STejun Heo 39014cb1ef64STejun Heo if (wq->flags & WQ_BH) 39024cb1ef64STejun Heo local_bh_enable(); 39034cb1ef64STejun Heo #endif 3904c35aea39STejun Heo } 3905c35aea39STejun Heo 3906c35aea39STejun Heo static void touch_work_lockdep_map(struct work_struct *work, 3907c35aea39STejun Heo struct workqueue_struct *wq) 3908c35aea39STejun Heo { 39094cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP 39104cb1ef64STejun Heo if (wq->flags & WQ_BH) 39114cb1ef64STejun Heo local_bh_disable(); 39124cb1ef64STejun Heo 3913c35aea39STejun Heo lock_map_acquire(&work->lockdep_map); 3914c35aea39STejun Heo lock_map_release(&work->lockdep_map); 39154cb1ef64STejun Heo 39164cb1ef64STejun Heo if (wq->flags & WQ_BH) 39174cb1ef64STejun Heo local_bh_enable(); 39184cb1ef64STejun Heo #endif 3919c35aea39STejun Heo } 3920c35aea39STejun Heo 39210fcb78c2SRolf Eike Beer /** 3922c4f135d6STetsuo Handa * __flush_workqueue - ensure that any scheduled work has run to completion. 39230fcb78c2SRolf Eike Beer * @wq: workqueue to flush 39241da177e4SLinus Torvalds * 3925c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 3926c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 39271da177e4SLinus Torvalds */ 3928c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq) 39291da177e4SLinus Torvalds { 393073f53c4aSTejun Heo struct wq_flusher this_flusher = { 393173f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 393273f53c4aSTejun Heo .flush_color = -1, 39334f022f43SMatthew Brost .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, (*wq->lockdep_map)), 393473f53c4aSTejun Heo }; 393573f53c4aSTejun Heo int next_color; 3936b1f4ec17SOleg Nesterov 39373347fa09STejun Heo if (WARN_ON(!wq_online)) 39383347fa09STejun Heo return; 39393347fa09STejun Heo 3940c35aea39STejun Heo touch_wq_lockdep_map(wq); 394187915adcSJohannes Berg 39423c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 394373f53c4aSTejun Heo 394473f53c4aSTejun Heo /* 394573f53c4aSTejun Heo * Start-to-wait phase 394673f53c4aSTejun Heo */ 394773f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 394873f53c4aSTejun Heo 394973f53c4aSTejun Heo if (next_color != wq->flush_color) { 395073f53c4aSTejun Heo /* 395173f53c4aSTejun Heo * Color space is not full. The current work_color 395273f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 395373f53c4aSTejun Heo * by one. 395473f53c4aSTejun Heo */ 39556183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 395673f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 395773f53c4aSTejun Heo wq->work_color = next_color; 395873f53c4aSTejun Heo 395973f53c4aSTejun Heo if (!wq->first_flusher) { 396073f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 39616183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 396273f53c4aSTejun Heo 396373f53c4aSTejun Heo wq->first_flusher = &this_flusher; 396473f53c4aSTejun Heo 3965112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 396673f53c4aSTejun Heo wq->work_color)) { 396773f53c4aSTejun Heo /* nothing to flush, done */ 396873f53c4aSTejun Heo wq->flush_color = next_color; 396973f53c4aSTejun Heo wq->first_flusher = NULL; 397073f53c4aSTejun Heo goto out_unlock; 397173f53c4aSTejun Heo } 397273f53c4aSTejun Heo } else { 397373f53c4aSTejun Heo /* wait in queue */ 39746183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 397573f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 3976112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 397773f53c4aSTejun Heo } 397873f53c4aSTejun Heo } else { 397973f53c4aSTejun Heo /* 398073f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 398173f53c4aSTejun Heo * The next flush completion will assign us 398273f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 398373f53c4aSTejun Heo */ 398473f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 398573f53c4aSTejun Heo } 398673f53c4aSTejun Heo 3987*de35994eSTvrtko Ursulin check_flush_dependency(wq, NULL, false); 3988fca839c0STejun Heo 39893c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 399073f53c4aSTejun Heo 399173f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 399273f53c4aSTejun Heo 399373f53c4aSTejun Heo /* 399473f53c4aSTejun Heo * Wake-up-and-cascade phase 399573f53c4aSTejun Heo * 399673f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 399773f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 399873f53c4aSTejun Heo */ 399900d5d15bSChris Wilson if (READ_ONCE(wq->first_flusher) != &this_flusher) 400073f53c4aSTejun Heo return; 400173f53c4aSTejun Heo 40023c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 400373f53c4aSTejun Heo 40044ce48b37STejun Heo /* we might have raced, check again with mutex held */ 40054ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 40064ce48b37STejun Heo goto out_unlock; 40074ce48b37STejun Heo 400800d5d15bSChris Wilson WRITE_ONCE(wq->first_flusher, NULL); 400973f53c4aSTejun Heo 40106183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 40116183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 401273f53c4aSTejun Heo 401373f53c4aSTejun Heo while (true) { 401473f53c4aSTejun Heo struct wq_flusher *next, *tmp; 401573f53c4aSTejun Heo 401673f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 401773f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 401873f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 401973f53c4aSTejun Heo break; 402073f53c4aSTejun Heo list_del_init(&next->list); 402173f53c4aSTejun Heo complete(&next->done); 402273f53c4aSTejun Heo } 402373f53c4aSTejun Heo 40246183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 402573f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 402673f53c4aSTejun Heo 402773f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 402873f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 402973f53c4aSTejun Heo 403073f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 403173f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 403273f53c4aSTejun Heo /* 403373f53c4aSTejun Heo * Assign the same color to all overflowed 403473f53c4aSTejun Heo * flushers, advance work_color and append to 403573f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 403673f53c4aSTejun Heo * phase for these overflowed flushers. 403773f53c4aSTejun Heo */ 403873f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 403973f53c4aSTejun Heo tmp->flush_color = wq->work_color; 404073f53c4aSTejun Heo 404173f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 404273f53c4aSTejun Heo 404373f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 404473f53c4aSTejun Heo &wq->flusher_queue); 4045112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 404673f53c4aSTejun Heo } 404773f53c4aSTejun Heo 404873f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 40496183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 405073f53c4aSTejun Heo break; 405173f53c4aSTejun Heo } 405273f53c4aSTejun Heo 405373f53c4aSTejun Heo /* 405473f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 4055112202d9STejun Heo * the new first flusher and arm pwqs. 405673f53c4aSTejun Heo */ 40576183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 40586183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 405973f53c4aSTejun Heo 406073f53c4aSTejun Heo list_del_init(&next->list); 406173f53c4aSTejun Heo wq->first_flusher = next; 406273f53c4aSTejun Heo 4063112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 406473f53c4aSTejun Heo break; 406573f53c4aSTejun Heo 406673f53c4aSTejun Heo /* 406773f53c4aSTejun Heo * Meh... this color is already done, clear first 406873f53c4aSTejun Heo * flusher and repeat cascading. 406973f53c4aSTejun Heo */ 407073f53c4aSTejun Heo wq->first_flusher = NULL; 407173f53c4aSTejun Heo } 407273f53c4aSTejun Heo 407373f53c4aSTejun Heo out_unlock: 40743c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 40751da177e4SLinus Torvalds } 4076c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue); 40771da177e4SLinus Torvalds 40789c5a2ba7STejun Heo /** 40799c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 40809c5a2ba7STejun Heo * @wq: workqueue to drain 40819c5a2ba7STejun Heo * 40829c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 40839c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 40849c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 4085b749b1b6SChen Hanxiao * repeatedly until it becomes empty. The number of flushing is determined 40869c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 40879c5a2ba7STejun Heo * takes too long. 40889c5a2ba7STejun Heo */ 40899c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 40909c5a2ba7STejun Heo { 40919c5a2ba7STejun Heo unsigned int flush_cnt = 0; 409249e3cf44STejun Heo struct pool_workqueue *pwq; 40939c5a2ba7STejun Heo 40949c5a2ba7STejun Heo /* 40959c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 40969c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 4097618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 40989c5a2ba7STejun Heo */ 409987fc741eSLai Jiangshan mutex_lock(&wq->mutex); 41009c5a2ba7STejun Heo if (!wq->nr_drainers++) 4101618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 410287fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 41039c5a2ba7STejun Heo reflush: 4104c4f135d6STetsuo Handa __flush_workqueue(wq); 41059c5a2ba7STejun Heo 4106b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 410776af4d93STejun Heo 410849e3cf44STejun Heo for_each_pwq(pwq, wq) { 4109fa2563e4SThomas Tuttle bool drained; 41109c5a2ba7STejun Heo 4111a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 4112afa87ce8STejun Heo drained = pwq_is_empty(pwq); 4113a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 4114fa2563e4SThomas Tuttle 4115fa2563e4SThomas Tuttle if (drained) 41169c5a2ba7STejun Heo continue; 41179c5a2ba7STejun Heo 41189c5a2ba7STejun Heo if (++flush_cnt == 10 || 41199c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 4120e9ad2eb3SStephen Zhang pr_warn("workqueue %s: %s() isn't complete after %u tries\n", 4121e9ad2eb3SStephen Zhang wq->name, __func__, flush_cnt); 412276af4d93STejun Heo 4123b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 41249c5a2ba7STejun Heo goto reflush; 41259c5a2ba7STejun Heo } 41269c5a2ba7STejun Heo 41279c5a2ba7STejun Heo if (!--wq->nr_drainers) 4128618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 412987fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 41309c5a2ba7STejun Heo } 41319c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 41329c5a2ba7STejun Heo 4133d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, 4134d6e89786SJohannes Berg bool from_cancel) 4135baf59022STejun Heo { 4136baf59022STejun Heo struct worker *worker = NULL; 4137c9e7cf27STejun Heo struct worker_pool *pool; 4138112202d9STejun Heo struct pool_workqueue *pwq; 4139c35aea39STejun Heo struct workqueue_struct *wq; 4140baf59022STejun Heo 414124acfb71SThomas Gleixner rcu_read_lock(); 4142fa1b54e6STejun Heo pool = get_work_pool(work); 4143fa1b54e6STejun Heo if (!pool) { 414424acfb71SThomas Gleixner rcu_read_unlock(); 4145fa1b54e6STejun Heo return false; 4146fa1b54e6STejun Heo } 4147fa1b54e6STejun Heo 4148a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 41490b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 4150112202d9STejun Heo pwq = get_work_pwq(work); 4151112202d9STejun Heo if (pwq) { 4152112202d9STejun Heo if (unlikely(pwq->pool != pool)) 4153baf59022STejun Heo goto already_gone; 4154606a5020STejun Heo } else { 4155c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 4156baf59022STejun Heo if (!worker) 4157baf59022STejun Heo goto already_gone; 4158112202d9STejun Heo pwq = worker->current_pwq; 4159606a5020STejun Heo } 4160baf59022STejun Heo 4161c35aea39STejun Heo wq = pwq->wq; 4162*de35994eSTvrtko Ursulin check_flush_dependency(wq, work, from_cancel); 4163fca839c0STejun Heo 4164112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 4165a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 4166baf59022STejun Heo 4167c35aea39STejun Heo touch_work_lockdep_map(work, wq); 4168c35aea39STejun Heo 4169e159489bSTejun Heo /* 4170a1d14934SPeter Zijlstra * Force a lock recursion deadlock when using flush_work() inside a 4171a1d14934SPeter Zijlstra * single-threaded or rescuer equipped workqueue. 4172a1d14934SPeter Zijlstra * 4173a1d14934SPeter Zijlstra * For single threaded workqueues the deadlock happens when the work 4174a1d14934SPeter Zijlstra * is after the work issuing the flush_work(). For rescuer equipped 4175a1d14934SPeter Zijlstra * workqueues the deadlock happens when the rescuer stalls, blocking 4176a1d14934SPeter Zijlstra * forward progress. 4177e159489bSTejun Heo */ 4178c35aea39STejun Heo if (!from_cancel && (wq->saved_max_active == 1 || wq->rescuer)) 4179c35aea39STejun Heo touch_wq_lockdep_map(wq); 4180c35aea39STejun Heo 418124acfb71SThomas Gleixner rcu_read_unlock(); 4182baf59022STejun Heo return true; 4183baf59022STejun Heo already_gone: 4184a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 418524acfb71SThomas Gleixner rcu_read_unlock(); 4186baf59022STejun Heo return false; 4187baf59022STejun Heo } 4188baf59022STejun Heo 4189d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel) 4190d6e89786SJohannes Berg { 4191d6e89786SJohannes Berg struct wq_barrier barr; 4192d6e89786SJohannes Berg 4193d6e89786SJohannes Berg if (WARN_ON(!wq_online)) 4194d6e89786SJohannes Berg return false; 4195d6e89786SJohannes Berg 41964d43d395STetsuo Handa if (WARN_ON(!work->func)) 41974d43d395STetsuo Handa return false; 41984d43d395STetsuo Handa 4199134874e2STejun Heo if (!start_flush_work(work, &barr, from_cancel)) 4200134874e2STejun Heo return false; 4201134874e2STejun Heo 4202134874e2STejun Heo /* 4203134874e2STejun Heo * start_flush_work() returned %true. If @from_cancel is set, we know 4204134874e2STejun Heo * that @work must have been executing during start_flush_work() and 4205134874e2STejun Heo * can't currently be queued. Its data must contain OFFQ bits. If @work 4206134874e2STejun Heo * was queued on a BH workqueue, we also know that it was running in the 4207134874e2STejun Heo * BH context and thus can be busy-waited. 4208134874e2STejun Heo */ 42098bc35475STejun Heo if (from_cancel) { 42108bc35475STejun Heo unsigned long data = *work_data_bits(work); 42118bc35475STejun Heo 42128bc35475STejun Heo if (!WARN_ON_ONCE(data & WORK_STRUCT_PWQ) && 42138bc35475STejun Heo (data & WORK_OFFQ_BH)) { 4214134874e2STejun Heo /* 42158bc35475STejun Heo * On RT, prevent a live lock when %current preempted 42168bc35475STejun Heo * soft interrupt processing or prevents ksoftirqd from 42178bc35475STejun Heo * running by keeping flipping BH. If the BH work item 42188bc35475STejun Heo * runs on a different CPU then this has no effect other 42198bc35475STejun Heo * than doing the BH disable/enable dance for nothing. 42208bc35475STejun Heo * This is copied from 4221134874e2STejun Heo * kernel/softirq.c::tasklet_unlock_spin_wait(). 4222134874e2STejun Heo */ 4223134874e2STejun Heo while (!try_wait_for_completion(&barr.done)) { 4224134874e2STejun Heo if (IS_ENABLED(CONFIG_PREEMPT_RT)) { 4225134874e2STejun Heo local_bh_disable(); 4226134874e2STejun Heo local_bh_enable(); 4227134874e2STejun Heo } else { 4228134874e2STejun Heo cpu_relax(); 4229134874e2STejun Heo } 4230134874e2STejun Heo } 42318bc35475STejun Heo goto out_destroy; 42328bc35475STejun Heo } 4233134874e2STejun Heo } 4234134874e2STejun Heo 42358bc35475STejun Heo wait_for_completion(&barr.done); 42368bc35475STejun Heo 42378bc35475STejun Heo out_destroy: 4238d6e89786SJohannes Berg destroy_work_on_stack(&barr.work); 4239d6e89786SJohannes Berg return true; 4240d6e89786SJohannes Berg } 4241d6e89786SJohannes Berg 4242db700897SOleg Nesterov /** 4243401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 4244401a8d04STejun Heo * @work: the work to flush 4245db700897SOleg Nesterov * 4246606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 4247606a5020STejun Heo * on return if it hasn't been requeued since flush started. 4248401a8d04STejun Heo * 4249d185af30SYacine Belkadi * Return: 4250401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 4251401a8d04STejun Heo * %false if it was already idle. 4252db700897SOleg Nesterov */ 4253401a8d04STejun Heo bool flush_work(struct work_struct *work) 4254db700897SOleg Nesterov { 4255134874e2STejun Heo might_sleep(); 4256d6e89786SJohannes Berg return __flush_work(work, false); 4257606a5020STejun Heo } 4258db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 4259db700897SOleg Nesterov 4260cdc6e4b3STejun Heo /** 4261cdc6e4b3STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 4262cdc6e4b3STejun Heo * @dwork: the delayed work to flush 4263cdc6e4b3STejun Heo * 4264cdc6e4b3STejun Heo * Delayed timer is cancelled and the pending work is queued for 4265cdc6e4b3STejun Heo * immediate execution. Like flush_work(), this function only 4266cdc6e4b3STejun Heo * considers the last queueing instance of @dwork. 4267cdc6e4b3STejun Heo * 4268cdc6e4b3STejun Heo * Return: 4269cdc6e4b3STejun Heo * %true if flush_work() waited for the work to finish execution, 4270cdc6e4b3STejun Heo * %false if it was already idle. 4271cdc6e4b3STejun Heo */ 4272cdc6e4b3STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 4273cdc6e4b3STejun Heo { 4274cdc6e4b3STejun Heo local_irq_disable(); 4275cdc6e4b3STejun Heo if (del_timer_sync(&dwork->timer)) 4276cdc6e4b3STejun Heo __queue_work(dwork->cpu, dwork->wq, &dwork->work); 4277cdc6e4b3STejun Heo local_irq_enable(); 4278cdc6e4b3STejun Heo return flush_work(&dwork->work); 4279cdc6e4b3STejun Heo } 4280cdc6e4b3STejun Heo EXPORT_SYMBOL(flush_delayed_work); 4281cdc6e4b3STejun Heo 4282cdc6e4b3STejun Heo /** 4283cdc6e4b3STejun Heo * flush_rcu_work - wait for a rwork to finish executing the last queueing 4284cdc6e4b3STejun Heo * @rwork: the rcu work to flush 4285cdc6e4b3STejun Heo * 4286cdc6e4b3STejun Heo * Return: 4287cdc6e4b3STejun Heo * %true if flush_rcu_work() waited for the work to finish execution, 4288cdc6e4b3STejun Heo * %false if it was already idle. 4289cdc6e4b3STejun Heo */ 4290cdc6e4b3STejun Heo bool flush_rcu_work(struct rcu_work *rwork) 4291cdc6e4b3STejun Heo { 4292cdc6e4b3STejun Heo if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) { 4293cdc6e4b3STejun Heo rcu_barrier(); 4294cdc6e4b3STejun Heo flush_work(&rwork->work); 4295cdc6e4b3STejun Heo return true; 4296cdc6e4b3STejun Heo } else { 4297cdc6e4b3STejun Heo return flush_work(&rwork->work); 4298cdc6e4b3STejun Heo } 4299cdc6e4b3STejun Heo } 4300cdc6e4b3STejun Heo EXPORT_SYMBOL(flush_rcu_work); 4301cdc6e4b3STejun Heo 430286898fa6STejun Heo static void work_offqd_disable(struct work_offq_data *offqd) 430386898fa6STejun Heo { 430486898fa6STejun Heo const unsigned long max = (1lu << WORK_OFFQ_DISABLE_BITS) - 1; 430586898fa6STejun Heo 430686898fa6STejun Heo if (likely(offqd->disable < max)) 430786898fa6STejun Heo offqd->disable++; 430886898fa6STejun Heo else 430986898fa6STejun Heo WARN_ONCE(true, "workqueue: work disable count overflowed\n"); 431086898fa6STejun Heo } 431186898fa6STejun Heo 431286898fa6STejun Heo static void work_offqd_enable(struct work_offq_data *offqd) 431386898fa6STejun Heo { 431486898fa6STejun Heo if (likely(offqd->disable > 0)) 431586898fa6STejun Heo offqd->disable--; 431686898fa6STejun Heo else 431786898fa6STejun Heo WARN_ONCE(true, "workqueue: work disable count underflowed\n"); 431886898fa6STejun Heo } 431986898fa6STejun Heo 4320c5f5b942STejun Heo static bool __cancel_work(struct work_struct *work, u32 cflags) 4321cdc6e4b3STejun Heo { 43221211f3b2STejun Heo struct work_offq_data offqd; 4323c26e2f2eSTejun Heo unsigned long irq_flags; 4324cdc6e4b3STejun Heo int ret; 4325cdc6e4b3STejun Heo 432686898fa6STejun Heo ret = work_grab_pending(work, cflags, &irq_flags); 4327cdc6e4b3STejun Heo 43281211f3b2STejun Heo work_offqd_unpack(&offqd, *work_data_bits(work)); 4329cdc6e4b3STejun Heo 433086898fa6STejun Heo if (cflags & WORK_CANCEL_DISABLE) 433186898fa6STejun Heo work_offqd_disable(&offqd); 433286898fa6STejun Heo 43331211f3b2STejun Heo set_work_pool_and_clear_pending(work, offqd.pool_id, 43341211f3b2STejun Heo work_offqd_pack_flags(&offqd)); 4335c26e2f2eSTejun Heo local_irq_restore(irq_flags); 4336cdc6e4b3STejun Heo return ret; 4337cdc6e4b3STejun Heo } 4338cdc6e4b3STejun Heo 4339c5f5b942STejun Heo static bool __cancel_work_sync(struct work_struct *work, u32 cflags) 4340401a8d04STejun Heo { 4341978b8409STejun Heo bool ret; 43421f1f642eSOleg Nesterov 4343f09b10b6STejun Heo ret = __cancel_work(work, cflags | WORK_CANCEL_DISABLE); 4344bbb68dfaSTejun Heo 4345134874e2STejun Heo if (*work_data_bits(work) & WORK_OFFQ_BH) 4346134874e2STejun Heo WARN_ON_ONCE(in_hardirq()); 4347134874e2STejun Heo else 4348134874e2STejun Heo might_sleep(); 4349bbb68dfaSTejun Heo 43503347fa09STejun Heo /* 4351c7a40c49STejun Heo * Skip __flush_work() during early boot when we know that @work isn't 4352c7a40c49STejun Heo * executing. This allows canceling during early boot. 43533347fa09STejun Heo */ 43543347fa09STejun Heo if (wq_online) 4355d6e89786SJohannes Berg __flush_work(work, true); 43563347fa09STejun Heo 4357f09b10b6STejun Heo if (!(cflags & WORK_CANCEL_DISABLE)) 4358f09b10b6STejun Heo enable_work(work); 43598603e1b3STejun Heo 43601f1f642eSOleg Nesterov return ret; 43611f1f642eSOleg Nesterov } 43621f1f642eSOleg Nesterov 4363cdc6e4b3STejun Heo /* 4364cdc6e4b3STejun Heo * See cancel_delayed_work() 4365cdc6e4b3STejun Heo */ 4366cdc6e4b3STejun Heo bool cancel_work(struct work_struct *work) 4367cdc6e4b3STejun Heo { 4368c5f5b942STejun Heo return __cancel_work(work, 0); 4369cdc6e4b3STejun Heo } 4370cdc6e4b3STejun Heo EXPORT_SYMBOL(cancel_work); 4371cdc6e4b3STejun Heo 43726e84d644SOleg Nesterov /** 4373401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 4374401a8d04STejun Heo * @work: the work to cancel 43756e84d644SOleg Nesterov * 4376134874e2STejun Heo * Cancel @work and wait for its execution to finish. This function can be used 4377134874e2STejun Heo * even if the work re-queues itself or migrates to another workqueue. On return 4378134874e2STejun Heo * from this function, @work is guaranteed to be not pending or executing on any 4379134874e2STejun Heo * CPU as long as there aren't racing enqueues. 43801f1f642eSOleg Nesterov * 4381134874e2STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for delayed_work's. 4382134874e2STejun Heo * Use cancel_delayed_work_sync() instead. 43836e84d644SOleg Nesterov * 4384134874e2STejun Heo * Must be called from a sleepable context if @work was last queued on a non-BH 4385134874e2STejun Heo * workqueue. Can also be called from non-hardirq atomic contexts including BH 4386134874e2STejun Heo * if @work was last queued on a BH workqueue. 4387401a8d04STejun Heo * 4388134874e2STejun Heo * Returns %true if @work was pending, %false otherwise. 43896e84d644SOleg Nesterov */ 4390401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 43916e84d644SOleg Nesterov { 4392c5f5b942STejun Heo return __cancel_work_sync(work, 0); 4393b89deed3SOleg Nesterov } 439428e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 4395b89deed3SOleg Nesterov 43966e84d644SOleg Nesterov /** 439757b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 439857b30ae7STejun Heo * @dwork: delayed_work to cancel 439909383498STejun Heo * 4400d185af30SYacine Belkadi * Kill off a pending delayed_work. 4401d185af30SYacine Belkadi * 4402d185af30SYacine Belkadi * Return: %true if @dwork was pending and canceled; %false if it wasn't 4403d185af30SYacine Belkadi * pending. 4404d185af30SYacine Belkadi * 4405d185af30SYacine Belkadi * Note: 4406d185af30SYacine Belkadi * The work callback function may still be running on return, unless 4407d185af30SYacine Belkadi * it returns %true and the work doesn't re-arm itself. Explicitly flush or 4408d185af30SYacine Belkadi * use cancel_delayed_work_sync() to wait on it. 440909383498STejun Heo * 441057b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 441109383498STejun Heo */ 441257b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 441309383498STejun Heo { 4414c5f5b942STejun Heo return __cancel_work(&dwork->work, WORK_CANCEL_DELAYED); 441509383498STejun Heo } 441657b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 441709383498STejun Heo 441809383498STejun Heo /** 4419401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 4420401a8d04STejun Heo * @dwork: the delayed work cancel 4421401a8d04STejun Heo * 4422401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 4423401a8d04STejun Heo * 4424d185af30SYacine Belkadi * Return: 4425401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 4426401a8d04STejun Heo */ 4427401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 44286e84d644SOleg Nesterov { 4429c5f5b942STejun Heo return __cancel_work_sync(&dwork->work, WORK_CANCEL_DELAYED); 44306e84d644SOleg Nesterov } 4431f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 44321da177e4SLinus Torvalds 44330fcb78c2SRolf Eike Beer /** 443486898fa6STejun Heo * disable_work - Disable and cancel a work item 443586898fa6STejun Heo * @work: work item to disable 443686898fa6STejun Heo * 443786898fa6STejun Heo * Disable @work by incrementing its disable count and cancel it if currently 443886898fa6STejun Heo * pending. As long as the disable count is non-zero, any attempt to queue @work 443986898fa6STejun Heo * will fail and return %false. The maximum supported disable depth is 2 to the 444086898fa6STejun Heo * power of %WORK_OFFQ_DISABLE_BITS, currently 65536. 444186898fa6STejun Heo * 4442f09b10b6STejun Heo * Can be called from any context. Returns %true if @work was pending, %false 4443f09b10b6STejun Heo * otherwise. 444486898fa6STejun Heo */ 444586898fa6STejun Heo bool disable_work(struct work_struct *work) 444686898fa6STejun Heo { 444786898fa6STejun Heo return __cancel_work(work, WORK_CANCEL_DISABLE); 444886898fa6STejun Heo } 444986898fa6STejun Heo EXPORT_SYMBOL_GPL(disable_work); 445086898fa6STejun Heo 445186898fa6STejun Heo /** 445286898fa6STejun Heo * disable_work_sync - Disable, cancel and drain a work item 445386898fa6STejun Heo * @work: work item to disable 445486898fa6STejun Heo * 445586898fa6STejun Heo * Similar to disable_work() but also wait for @work to finish if currently 445686898fa6STejun Heo * executing. 445786898fa6STejun Heo * 4458134874e2STejun Heo * Must be called from a sleepable context if @work was last queued on a non-BH 4459134874e2STejun Heo * workqueue. Can also be called from non-hardirq atomic contexts including BH 4460134874e2STejun Heo * if @work was last queued on a BH workqueue. 4461134874e2STejun Heo * 4462134874e2STejun Heo * Returns %true if @work was pending, %false otherwise. 446386898fa6STejun Heo */ 446486898fa6STejun Heo bool disable_work_sync(struct work_struct *work) 446586898fa6STejun Heo { 446686898fa6STejun Heo return __cancel_work_sync(work, WORK_CANCEL_DISABLE); 446786898fa6STejun Heo } 446886898fa6STejun Heo EXPORT_SYMBOL_GPL(disable_work_sync); 446986898fa6STejun Heo 447086898fa6STejun Heo /** 447186898fa6STejun Heo * enable_work - Enable a work item 447286898fa6STejun Heo * @work: work item to enable 447386898fa6STejun Heo * 447486898fa6STejun Heo * Undo disable_work[_sync]() by decrementing @work's disable count. @work can 447586898fa6STejun Heo * only be queued if its disable count is 0. 447686898fa6STejun Heo * 4477f09b10b6STejun Heo * Can be called from any context. Returns %true if the disable count reached 0. 4478f09b10b6STejun Heo * Otherwise, %false. 447986898fa6STejun Heo */ 448086898fa6STejun Heo bool enable_work(struct work_struct *work) 448186898fa6STejun Heo { 448286898fa6STejun Heo struct work_offq_data offqd; 448386898fa6STejun Heo unsigned long irq_flags; 448486898fa6STejun Heo 448586898fa6STejun Heo work_grab_pending(work, 0, &irq_flags); 448686898fa6STejun Heo 448786898fa6STejun Heo work_offqd_unpack(&offqd, *work_data_bits(work)); 448886898fa6STejun Heo work_offqd_enable(&offqd); 448986898fa6STejun Heo set_work_pool_and_clear_pending(work, offqd.pool_id, 449086898fa6STejun Heo work_offqd_pack_flags(&offqd)); 449186898fa6STejun Heo local_irq_restore(irq_flags); 449286898fa6STejun Heo 449386898fa6STejun Heo return !offqd.disable; 449486898fa6STejun Heo } 449586898fa6STejun Heo EXPORT_SYMBOL_GPL(enable_work); 449686898fa6STejun Heo 449786898fa6STejun Heo /** 449886898fa6STejun Heo * disable_delayed_work - Disable and cancel a delayed work item 449986898fa6STejun Heo * @dwork: delayed work item to disable 450086898fa6STejun Heo * 450186898fa6STejun Heo * disable_work() for delayed work items. 450286898fa6STejun Heo */ 450386898fa6STejun Heo bool disable_delayed_work(struct delayed_work *dwork) 450486898fa6STejun Heo { 450586898fa6STejun Heo return __cancel_work(&dwork->work, 450686898fa6STejun Heo WORK_CANCEL_DELAYED | WORK_CANCEL_DISABLE); 450786898fa6STejun Heo } 450886898fa6STejun Heo EXPORT_SYMBOL_GPL(disable_delayed_work); 450986898fa6STejun Heo 451086898fa6STejun Heo /** 451186898fa6STejun Heo * disable_delayed_work_sync - Disable, cancel and drain a delayed work item 451286898fa6STejun Heo * @dwork: delayed work item to disable 451386898fa6STejun Heo * 451486898fa6STejun Heo * disable_work_sync() for delayed work items. 451586898fa6STejun Heo */ 451686898fa6STejun Heo bool disable_delayed_work_sync(struct delayed_work *dwork) 451786898fa6STejun Heo { 451886898fa6STejun Heo return __cancel_work_sync(&dwork->work, 451986898fa6STejun Heo WORK_CANCEL_DELAYED | WORK_CANCEL_DISABLE); 452086898fa6STejun Heo } 452186898fa6STejun Heo EXPORT_SYMBOL_GPL(disable_delayed_work_sync); 452286898fa6STejun Heo 452386898fa6STejun Heo /** 452486898fa6STejun Heo * enable_delayed_work - Enable a delayed work item 452586898fa6STejun Heo * @dwork: delayed work item to enable 452686898fa6STejun Heo * 452786898fa6STejun Heo * enable_work() for delayed work items. 452886898fa6STejun Heo */ 452986898fa6STejun Heo bool enable_delayed_work(struct delayed_work *dwork) 453086898fa6STejun Heo { 453186898fa6STejun Heo return enable_work(&dwork->work); 453286898fa6STejun Heo } 453386898fa6STejun Heo EXPORT_SYMBOL_GPL(enable_delayed_work); 453486898fa6STejun Heo 453586898fa6STejun Heo /** 453631ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 4537b6136773SAndrew Morton * @func: the function to call 4538b6136773SAndrew Morton * 453931ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 454031ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 4541b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 454231ddd871STejun Heo * 4543d185af30SYacine Belkadi * Return: 454431ddd871STejun Heo * 0 on success, -errno on failure. 4545b6136773SAndrew Morton */ 454665f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 454715316ba8SChristoph Lameter { 454815316ba8SChristoph Lameter int cpu; 454938f51568SNamhyung Kim struct work_struct __percpu *works; 455015316ba8SChristoph Lameter 4551b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 4552b6136773SAndrew Morton if (!works) 455315316ba8SChristoph Lameter return -ENOMEM; 4554b6136773SAndrew Morton 4555ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 455693981800STejun Heo 455715316ba8SChristoph Lameter for_each_online_cpu(cpu) { 45589bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 45599bfb1839SIngo Molnar 45609bfb1839SIngo Molnar INIT_WORK(work, func); 45618de6d308SOleg Nesterov schedule_work_on(cpu, work); 456215316ba8SChristoph Lameter } 456393981800STejun Heo 456493981800STejun Heo for_each_online_cpu(cpu) 45658616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 456693981800STejun Heo 4567ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 4568b6136773SAndrew Morton free_percpu(works); 456915316ba8SChristoph Lameter return 0; 457015316ba8SChristoph Lameter } 457115316ba8SChristoph Lameter 4572eef6a7d5SAlan Stern /** 45731fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 45741fa44ecaSJames Bottomley * @fn: the function to execute 45751fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 45761fa44ecaSJames Bottomley * be available when the work executes) 45771fa44ecaSJames Bottomley * 45781fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 45791fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 45801fa44ecaSJames Bottomley * 4581d185af30SYacine Belkadi * Return: 0 - function was executed 45821fa44ecaSJames Bottomley * 1 - function was scheduled for execution 45831fa44ecaSJames Bottomley */ 458465f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 45851fa44ecaSJames Bottomley { 45861fa44ecaSJames Bottomley if (!in_interrupt()) { 458765f27f38SDavid Howells fn(&ew->work); 45881fa44ecaSJames Bottomley return 0; 45891fa44ecaSJames Bottomley } 45901fa44ecaSJames Bottomley 459165f27f38SDavid Howells INIT_WORK(&ew->work, fn); 45921fa44ecaSJames Bottomley schedule_work(&ew->work); 45931fa44ecaSJames Bottomley 45941fa44ecaSJames Bottomley return 1; 45951fa44ecaSJames Bottomley } 45961fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 45971fa44ecaSJames Bottomley 45987a4e344cSTejun Heo /** 45997a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 46007a4e344cSTejun Heo * @attrs: workqueue_attrs to free 46017a4e344cSTejun Heo * 46027a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 46037a4e344cSTejun Heo */ 4604513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs) 46057a4e344cSTejun Heo { 46067a4e344cSTejun Heo if (attrs) { 46077a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 46089546b29eSTejun Heo free_cpumask_var(attrs->__pod_cpumask); 46097a4e344cSTejun Heo kfree(attrs); 46107a4e344cSTejun Heo } 46117a4e344cSTejun Heo } 46127a4e344cSTejun Heo 46137a4e344cSTejun Heo /** 46147a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 46157a4e344cSTejun Heo * 46167a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 4617d185af30SYacine Belkadi * return it. 4618d185af30SYacine Belkadi * 4619d185af30SYacine Belkadi * Return: The allocated new workqueue_attr on success. %NULL on failure. 46207a4e344cSTejun Heo */ 4621513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void) 46227a4e344cSTejun Heo { 46237a4e344cSTejun Heo struct workqueue_attrs *attrs; 46247a4e344cSTejun Heo 4625be69d00dSThomas Gleixner attrs = kzalloc(sizeof(*attrs), GFP_KERNEL); 46267a4e344cSTejun Heo if (!attrs) 46277a4e344cSTejun Heo goto fail; 4628be69d00dSThomas Gleixner if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL)) 46297a4e344cSTejun Heo goto fail; 46309546b29eSTejun Heo if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL)) 46319546b29eSTejun Heo goto fail; 46327a4e344cSTejun Heo 463313e2e556STejun Heo cpumask_copy(attrs->cpumask, cpu_possible_mask); 4634523a301eSTejun Heo attrs->affn_scope = WQ_AFFN_DFL; 46357a4e344cSTejun Heo return attrs; 46367a4e344cSTejun Heo fail: 46377a4e344cSTejun Heo free_workqueue_attrs(attrs); 46387a4e344cSTejun Heo return NULL; 46397a4e344cSTejun Heo } 46407a4e344cSTejun Heo 464129c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 464229c91e99STejun Heo const struct workqueue_attrs *from) 464329c91e99STejun Heo { 464429c91e99STejun Heo to->nice = from->nice; 464529c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 46469546b29eSTejun Heo cpumask_copy(to->__pod_cpumask, from->__pod_cpumask); 46478639ecebSTejun Heo to->affn_strict = from->affn_strict; 464884193c07STejun Heo 46492865a8fbSShaohua Li /* 465084193c07STejun Heo * Unlike hash and equality test, copying shouldn't ignore wq-only 465184193c07STejun Heo * fields as copying is used for both pool and wq attrs. Instead, 465284193c07STejun Heo * get_unbound_pool() explicitly clears the fields. 46532865a8fbSShaohua Li */ 465484193c07STejun Heo to->affn_scope = from->affn_scope; 4655af73f5c9STejun Heo to->ordered = from->ordered; 465629c91e99STejun Heo } 465729c91e99STejun Heo 46585de7a03cSTejun Heo /* 46595de7a03cSTejun Heo * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the 46605de7a03cSTejun Heo * comments in 'struct workqueue_attrs' definition. 46615de7a03cSTejun Heo */ 46625de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs) 46635de7a03cSTejun Heo { 466484193c07STejun Heo attrs->affn_scope = WQ_AFFN_NR_TYPES; 46655de7a03cSTejun Heo attrs->ordered = false; 4666ae1296a7SLai Jiangshan if (attrs->affn_strict) 4667ae1296a7SLai Jiangshan cpumask_copy(attrs->cpumask, cpu_possible_mask); 46685de7a03cSTejun Heo } 46695de7a03cSTejun Heo 467029c91e99STejun Heo /* hash value of the content of @attr */ 467129c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 467229c91e99STejun Heo { 467329c91e99STejun Heo u32 hash = 0; 467429c91e99STejun Heo 467529c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 4676ae1296a7SLai Jiangshan hash = jhash_1word(attrs->affn_strict, hash); 46779546b29eSTejun Heo hash = jhash(cpumask_bits(attrs->__pod_cpumask), 46789546b29eSTejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 4679ae1296a7SLai Jiangshan if (!attrs->affn_strict) 4680ae1296a7SLai Jiangshan hash = jhash(cpumask_bits(attrs->cpumask), 4681ae1296a7SLai Jiangshan BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 468229c91e99STejun Heo return hash; 468329c91e99STejun Heo } 468429c91e99STejun Heo 468529c91e99STejun Heo /* content equality test */ 468629c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 468729c91e99STejun Heo const struct workqueue_attrs *b) 468829c91e99STejun Heo { 468929c91e99STejun Heo if (a->nice != b->nice) 469029c91e99STejun Heo return false; 4691ae1296a7SLai Jiangshan if (a->affn_strict != b->affn_strict) 469229c91e99STejun Heo return false; 46939546b29eSTejun Heo if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask)) 46949546b29eSTejun Heo return false; 4695ae1296a7SLai Jiangshan if (!a->affn_strict && !cpumask_equal(a->cpumask, b->cpumask)) 46968639ecebSTejun Heo return false; 469729c91e99STejun Heo return true; 469829c91e99STejun Heo } 469929c91e99STejun Heo 47000f36ee24STejun Heo /* Update @attrs with actually available CPUs */ 47010f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs, 47020f36ee24STejun Heo const cpumask_t *unbound_cpumask) 47030f36ee24STejun Heo { 47040f36ee24STejun Heo /* 47050f36ee24STejun Heo * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If 47060f36ee24STejun Heo * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to 47070f36ee24STejun Heo * @unbound_cpumask. 47080f36ee24STejun Heo */ 47090f36ee24STejun Heo cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask); 47100f36ee24STejun Heo if (unlikely(cpumask_empty(attrs->cpumask))) 47110f36ee24STejun Heo cpumask_copy(attrs->cpumask, unbound_cpumask); 47120f36ee24STejun Heo } 47130f36ee24STejun Heo 471484193c07STejun Heo /* find wq_pod_type to use for @attrs */ 471584193c07STejun Heo static const struct wq_pod_type * 471684193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs) 471784193c07STejun Heo { 4718523a301eSTejun Heo enum wq_affn_scope scope; 4719523a301eSTejun Heo struct wq_pod_type *pt; 4720523a301eSTejun Heo 4721523a301eSTejun Heo /* to synchronize access to wq_affn_dfl */ 4722523a301eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 4723523a301eSTejun Heo 4724523a301eSTejun Heo if (attrs->affn_scope == WQ_AFFN_DFL) 4725523a301eSTejun Heo scope = wq_affn_dfl; 4726523a301eSTejun Heo else 4727523a301eSTejun Heo scope = attrs->affn_scope; 4728523a301eSTejun Heo 4729523a301eSTejun Heo pt = &wq_pod_types[scope]; 473084193c07STejun Heo 473184193c07STejun Heo if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) && 473284193c07STejun Heo likely(pt->nr_pods)) 473384193c07STejun Heo return pt; 473484193c07STejun Heo 473584193c07STejun Heo /* 473684193c07STejun Heo * Before workqueue_init_topology(), only SYSTEM is available which is 473784193c07STejun Heo * initialized in workqueue_init_early(). 473884193c07STejun Heo */ 473984193c07STejun Heo pt = &wq_pod_types[WQ_AFFN_SYSTEM]; 474084193c07STejun Heo BUG_ON(!pt->nr_pods); 474184193c07STejun Heo return pt; 474284193c07STejun Heo } 474384193c07STejun Heo 47447a4e344cSTejun Heo /** 47457a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 47467a4e344cSTejun Heo * @pool: worker_pool to initialize 47477a4e344cSTejun Heo * 4748402dd89dSShailendra Verma * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs. 4749d185af30SYacine Belkadi * 4750d185af30SYacine Belkadi * Return: 0 on success, -errno on failure. Even on failure, all fields 475129c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 475229c91e99STejun Heo * on @pool safely to release it. 47537a4e344cSTejun Heo */ 47547a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 47554e1a1f9aSTejun Heo { 4756a9b8a985SSebastian Andrzej Siewior raw_spin_lock_init(&pool->lock); 475729c91e99STejun Heo pool->id = -1; 475829c91e99STejun Heo pool->cpu = -1; 4759f3f90ad4STejun Heo pool->node = NUMA_NO_NODE; 47604e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 476182607adcSTejun Heo pool->watchdog_ts = jiffies; 47624e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 47634e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 47644e1a1f9aSTejun Heo hash_init(pool->busy_hash); 47654e1a1f9aSTejun Heo 476632a6c723SKees Cook timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE); 47673f959aa3SValentin Schneider INIT_WORK(&pool->idle_cull_work, idle_cull_fn); 47684e1a1f9aSTejun Heo 476932a6c723SKees Cook timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0); 47704e1a1f9aSTejun Heo 4771da028469SLai Jiangshan INIT_LIST_HEAD(&pool->workers); 47727a4e344cSTejun Heo 47737cda9aaeSLai Jiangshan ida_init(&pool->worker_ida); 477429c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 477529c91e99STejun Heo pool->refcnt = 1; 477629c91e99STejun Heo 477729c91e99STejun Heo /* shouldn't fail above this point */ 4778be69d00dSThomas Gleixner pool->attrs = alloc_workqueue_attrs(); 47797a4e344cSTejun Heo if (!pool->attrs) 47807a4e344cSTejun Heo return -ENOMEM; 47815de7a03cSTejun Heo 47825de7a03cSTejun Heo wqattrs_clear_for_pool(pool->attrs); 47835de7a03cSTejun Heo 47847a4e344cSTejun Heo return 0; 47854e1a1f9aSTejun Heo } 47864e1a1f9aSTejun Heo 4787669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP 4788669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 4789669de8bdSBart Van Assche { 4790669de8bdSBart Van Assche char *lock_name; 4791669de8bdSBart Van Assche 4792669de8bdSBart Van Assche lockdep_register_key(&wq->key); 4793669de8bdSBart Van Assche lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name); 4794669de8bdSBart Van Assche if (!lock_name) 4795669de8bdSBart Van Assche lock_name = wq->name; 479669a106c0SQian Cai 479769a106c0SQian Cai wq->lock_name = lock_name; 47984f022f43SMatthew Brost wq->lockdep_map = &wq->__lockdep_map; 47994f022f43SMatthew Brost lockdep_init_map(wq->lockdep_map, lock_name, &wq->key, 0); 4800669de8bdSBart Van Assche } 4801669de8bdSBart Van Assche 4802669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 4803669de8bdSBart Van Assche { 4804ec0a7d44SMatthew Brost if (wq->lockdep_map != &wq->__lockdep_map) 4805ec0a7d44SMatthew Brost return; 4806ec0a7d44SMatthew Brost 4807669de8bdSBart Van Assche lockdep_unregister_key(&wq->key); 4808669de8bdSBart Van Assche } 4809669de8bdSBart Van Assche 4810669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 4811669de8bdSBart Van Assche { 4812ec0a7d44SMatthew Brost if (wq->lockdep_map != &wq->__lockdep_map) 4813ec0a7d44SMatthew Brost return; 4814ec0a7d44SMatthew Brost 4815669de8bdSBart Van Assche if (wq->lock_name != wq->name) 4816669de8bdSBart Van Assche kfree(wq->lock_name); 4817669de8bdSBart Van Assche } 4818669de8bdSBart Van Assche #else 4819669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 4820669de8bdSBart Van Assche { 4821669de8bdSBart Van Assche } 4822669de8bdSBart Van Assche 4823669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 4824669de8bdSBart Van Assche { 4825669de8bdSBart Van Assche } 4826669de8bdSBart Van Assche 4827669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 4828669de8bdSBart Van Assche { 4829669de8bdSBart Van Assche } 4830669de8bdSBart Van Assche #endif 4831669de8bdSBart Van Assche 483291ccc6e7STejun Heo static void free_node_nr_active(struct wq_node_nr_active **nna_ar) 483391ccc6e7STejun Heo { 483491ccc6e7STejun Heo int node; 483591ccc6e7STejun Heo 483691ccc6e7STejun Heo for_each_node(node) { 483791ccc6e7STejun Heo kfree(nna_ar[node]); 483891ccc6e7STejun Heo nna_ar[node] = NULL; 483991ccc6e7STejun Heo } 484091ccc6e7STejun Heo 484191ccc6e7STejun Heo kfree(nna_ar[nr_node_ids]); 484291ccc6e7STejun Heo nna_ar[nr_node_ids] = NULL; 484391ccc6e7STejun Heo } 484491ccc6e7STejun Heo 484591ccc6e7STejun Heo static void init_node_nr_active(struct wq_node_nr_active *nna) 484691ccc6e7STejun Heo { 4847c5f8cd6cSTejun Heo nna->max = WQ_DFL_MIN_ACTIVE; 484891ccc6e7STejun Heo atomic_set(&nna->nr, 0); 48495797b1c1STejun Heo raw_spin_lock_init(&nna->lock); 48505797b1c1STejun Heo INIT_LIST_HEAD(&nna->pending_pwqs); 485191ccc6e7STejun Heo } 485291ccc6e7STejun Heo 485391ccc6e7STejun Heo /* 485491ccc6e7STejun Heo * Each node's nr_active counter will be accessed mostly from its own node and 485591ccc6e7STejun Heo * should be allocated in the node. 485691ccc6e7STejun Heo */ 485791ccc6e7STejun Heo static int alloc_node_nr_active(struct wq_node_nr_active **nna_ar) 485891ccc6e7STejun Heo { 485991ccc6e7STejun Heo struct wq_node_nr_active *nna; 486091ccc6e7STejun Heo int node; 486191ccc6e7STejun Heo 486291ccc6e7STejun Heo for_each_node(node) { 486391ccc6e7STejun Heo nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, node); 486491ccc6e7STejun Heo if (!nna) 486591ccc6e7STejun Heo goto err_free; 486691ccc6e7STejun Heo init_node_nr_active(nna); 486791ccc6e7STejun Heo nna_ar[node] = nna; 486891ccc6e7STejun Heo } 486991ccc6e7STejun Heo 487091ccc6e7STejun Heo /* [nr_node_ids] is used as the fallback */ 487191ccc6e7STejun Heo nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, NUMA_NO_NODE); 487291ccc6e7STejun Heo if (!nna) 487391ccc6e7STejun Heo goto err_free; 487491ccc6e7STejun Heo init_node_nr_active(nna); 487591ccc6e7STejun Heo nna_ar[nr_node_ids] = nna; 487691ccc6e7STejun Heo 487791ccc6e7STejun Heo return 0; 487891ccc6e7STejun Heo 487991ccc6e7STejun Heo err_free: 488091ccc6e7STejun Heo free_node_nr_active(nna_ar); 488191ccc6e7STejun Heo return -ENOMEM; 488291ccc6e7STejun Heo } 488391ccc6e7STejun Heo 4884e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu) 4885e2dca7adSTejun Heo { 4886e2dca7adSTejun Heo struct workqueue_struct *wq = 4887e2dca7adSTejun Heo container_of(rcu, struct workqueue_struct, rcu); 4888e2dca7adSTejun Heo 488991ccc6e7STejun Heo if (wq->flags & WQ_UNBOUND) 489091ccc6e7STejun Heo free_node_nr_active(wq->node_nr_active); 489191ccc6e7STejun Heo 4892669de8bdSBart Van Assche wq_free_lockdep(wq); 4893ee1ceef7STejun Heo free_percpu(wq->cpu_pwq); 4894e2dca7adSTejun Heo free_workqueue_attrs(wq->unbound_attrs); 4895e2dca7adSTejun Heo kfree(wq); 4896e2dca7adSTejun Heo } 4897e2dca7adSTejun Heo 489829c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 489929c91e99STejun Heo { 490029c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 490129c91e99STejun Heo 49027cda9aaeSLai Jiangshan ida_destroy(&pool->worker_ida); 490329c91e99STejun Heo free_workqueue_attrs(pool->attrs); 490429c91e99STejun Heo kfree(pool); 490529c91e99STejun Heo } 490629c91e99STejun Heo 490729c91e99STejun Heo /** 490829c91e99STejun Heo * put_unbound_pool - put a worker_pool 490929c91e99STejun Heo * @pool: worker_pool to put 491029c91e99STejun Heo * 491124acfb71SThomas Gleixner * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU 4912c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 4913c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 4914c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 4915a892caccSTejun Heo * 4916a892caccSTejun Heo * Should be called with wq_pool_mutex held. 491729c91e99STejun Heo */ 491829c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 491929c91e99STejun Heo { 492029c91e99STejun Heo struct worker *worker; 49219680540cSYang Yingliang LIST_HEAD(cull_list); 4922e02b9312SValentin Schneider 4923a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 4924a892caccSTejun Heo 4925a892caccSTejun Heo if (--pool->refcnt) 492629c91e99STejun Heo return; 492729c91e99STejun Heo 492829c91e99STejun Heo /* sanity checks */ 492961d0fbb4SLai Jiangshan if (WARN_ON(!(pool->cpu < 0)) || 4930a892caccSTejun Heo WARN_ON(!list_empty(&pool->worklist))) 493129c91e99STejun Heo return; 493229c91e99STejun Heo 493329c91e99STejun Heo /* release id and unhash */ 493429c91e99STejun Heo if (pool->id >= 0) 493529c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 493629c91e99STejun Heo hash_del(&pool->hash_node); 493729c91e99STejun Heo 4938c5aa87bbSTejun Heo /* 4939692b4825STejun Heo * Become the manager and destroy all workers. This prevents 4940692b4825STejun Heo * @pool's workers from blocking on attach_mutex. We're the last 4941692b4825STejun Heo * manager and @pool gets freed with the flag set. 49429ab03be4SValentin Schneider * 49439ab03be4SValentin Schneider * Having a concurrent manager is quite unlikely to happen as we can 49449ab03be4SValentin Schneider * only get here with 49459ab03be4SValentin Schneider * pwq->refcnt == pool->refcnt == 0 49469ab03be4SValentin Schneider * which implies no work queued to the pool, which implies no worker can 49479ab03be4SValentin Schneider * become the manager. However a worker could have taken the role of 49489ab03be4SValentin Schneider * manager before the refcnts dropped to 0, since maybe_create_worker() 49499ab03be4SValentin Schneider * drops pool->lock 4950c5aa87bbSTejun Heo */ 49519ab03be4SValentin Schneider while (true) { 49529ab03be4SValentin Schneider rcuwait_wait_event(&manager_wait, 49539ab03be4SValentin Schneider !(pool->flags & POOL_MANAGER_ACTIVE), 4954d8bb65abSSebastian Andrzej Siewior TASK_UNINTERRUPTIBLE); 4955e02b9312SValentin Schneider 4956e02b9312SValentin Schneider mutex_lock(&wq_pool_attach_mutex); 49579ab03be4SValentin Schneider raw_spin_lock_irq(&pool->lock); 49589ab03be4SValentin Schneider if (!(pool->flags & POOL_MANAGER_ACTIVE)) { 4959692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 49609ab03be4SValentin Schneider break; 49619ab03be4SValentin Schneider } 49629ab03be4SValentin Schneider raw_spin_unlock_irq(&pool->lock); 4963e02b9312SValentin Schneider mutex_unlock(&wq_pool_attach_mutex); 49649ab03be4SValentin Schneider } 4965692b4825STejun Heo 49661037de36SLai Jiangshan while ((worker = first_idle_worker(pool))) 4967e02b9312SValentin Schneider set_worker_dying(worker, &cull_list); 496829c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 4969a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 497060f5a4bcSLai Jiangshan 4971f4b7b53cSLai Jiangshan detach_dying_workers(&cull_list); 4972e02b9312SValentin Schneider 49731258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 497460f5a4bcSLai Jiangshan 497568f83057SLai Jiangshan reap_dying_workers(&cull_list); 497660f5a4bcSLai Jiangshan 497729c91e99STejun Heo /* shut down the timers */ 497829c91e99STejun Heo del_timer_sync(&pool->idle_timer); 49793f959aa3SValentin Schneider cancel_work_sync(&pool->idle_cull_work); 498029c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 498129c91e99STejun Heo 498224acfb71SThomas Gleixner /* RCU protected to allow dereferences from get_work_pool() */ 498325b00775SPaul E. McKenney call_rcu(&pool->rcu, rcu_free_pool); 498429c91e99STejun Heo } 498529c91e99STejun Heo 498629c91e99STejun Heo /** 498729c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 498829c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 498929c91e99STejun Heo * 499029c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 499129c91e99STejun Heo * reference count and return it. If there already is a matching 499229c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 4993d185af30SYacine Belkadi * create a new one. 4994a892caccSTejun Heo * 4995a892caccSTejun Heo * Should be called with wq_pool_mutex held. 4996d185af30SYacine Belkadi * 4997d185af30SYacine Belkadi * Return: On success, a worker_pool with the same attributes as @attrs. 4998d185af30SYacine Belkadi * On failure, %NULL. 499929c91e99STejun Heo */ 500029c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 500129c91e99STejun Heo { 500284193c07STejun Heo struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA]; 500329c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 500429c91e99STejun Heo struct worker_pool *pool; 500584193c07STejun Heo int pod, node = NUMA_NO_NODE; 500629c91e99STejun Heo 5007a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 500829c91e99STejun Heo 500929c91e99STejun Heo /* do we already have a matching pool? */ 501029c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 501129c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 501229c91e99STejun Heo pool->refcnt++; 50133fb1823cSLai Jiangshan return pool; 501429c91e99STejun Heo } 501529c91e99STejun Heo } 501629c91e99STejun Heo 50179546b29eSTejun Heo /* If __pod_cpumask is contained inside a NUMA pod, that's our node */ 501884193c07STejun Heo for (pod = 0; pod < pt->nr_pods; pod++) { 50199546b29eSTejun Heo if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) { 502084193c07STejun Heo node = pt->pod_node[pod]; 5021e2273584SXunlei Pang break; 5022e2273584SXunlei Pang } 5023e2273584SXunlei Pang } 5024e2273584SXunlei Pang 502529c91e99STejun Heo /* nope, create a new one */ 502684193c07STejun Heo pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node); 502729c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 502829c91e99STejun Heo goto fail; 502929c91e99STejun Heo 503084193c07STejun Heo pool->node = node; 50315de7a03cSTejun Heo copy_workqueue_attrs(pool->attrs, attrs); 50325de7a03cSTejun Heo wqattrs_clear_for_pool(pool->attrs); 50332865a8fbSShaohua Li 503429c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 503529c91e99STejun Heo goto fail; 503629c91e99STejun Heo 503729c91e99STejun Heo /* create and start the initial worker */ 50383347fa09STejun Heo if (wq_online && !create_worker(pool)) 503929c91e99STejun Heo goto fail; 504029c91e99STejun Heo 504129c91e99STejun Heo /* install */ 504229c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 50433fb1823cSLai Jiangshan 504429c91e99STejun Heo return pool; 504529c91e99STejun Heo fail: 504629c91e99STejun Heo if (pool) 504729c91e99STejun Heo put_unbound_pool(pool); 504829c91e99STejun Heo return NULL; 504929c91e99STejun Heo } 505029c91e99STejun Heo 50518864b4e5STejun Heo /* 5052967b494eSTejun Heo * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero 5053967b494eSTejun Heo * refcnt and needs to be destroyed. 50548864b4e5STejun Heo */ 5055687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work) 50568864b4e5STejun Heo { 50578864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 5058687a9aa5STejun Heo release_work); 50598864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 50608864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 5061b42b0bddSYang Yingliang bool is_last = false; 50628864b4e5STejun Heo 5063b42b0bddSYang Yingliang /* 5064687a9aa5STejun Heo * When @pwq is not linked, it doesn't hold any reference to the 5065b42b0bddSYang Yingliang * @wq, and @wq is invalid to access. 5066b42b0bddSYang Yingliang */ 5067b42b0bddSYang Yingliang if (!list_empty(&pwq->pwqs_node)) { 50683c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 50698864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 5070bc0caf09STejun Heo is_last = list_empty(&wq->pwqs); 50714c065dbcSWaiman Long 50724c065dbcSWaiman Long /* 50734c065dbcSWaiman Long * For ordered workqueue with a plugged dfl_pwq, restart it now. 50744c065dbcSWaiman Long */ 50754c065dbcSWaiman Long if (!is_last && (wq->flags & __WQ_ORDERED)) 50764c065dbcSWaiman Long unplug_oldest_pwq(wq); 50774c065dbcSWaiman Long 50783c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 5079b42b0bddSYang Yingliang } 50808864b4e5STejun Heo 5081687a9aa5STejun Heo if (wq->flags & WQ_UNBOUND) { 5082a892caccSTejun Heo mutex_lock(&wq_pool_mutex); 50838864b4e5STejun Heo put_unbound_pool(pool); 5084a892caccSTejun Heo mutex_unlock(&wq_pool_mutex); 5085687a9aa5STejun Heo } 5086a892caccSTejun Heo 50875797b1c1STejun Heo if (!list_empty(&pwq->pending_node)) { 50885797b1c1STejun Heo struct wq_node_nr_active *nna = 50895797b1c1STejun Heo wq_node_nr_active(pwq->wq, pwq->pool->node); 50905797b1c1STejun Heo 50915797b1c1STejun Heo raw_spin_lock_irq(&nna->lock); 50925797b1c1STejun Heo list_del_init(&pwq->pending_node); 50935797b1c1STejun Heo raw_spin_unlock_irq(&nna->lock); 50945797b1c1STejun Heo } 50955797b1c1STejun Heo 509637c2277fSJulia Lawall kfree_rcu(pwq, rcu); 50978864b4e5STejun Heo 50988864b4e5STejun Heo /* 50998864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 5100e2dca7adSTejun Heo * is gonna access it anymore. Schedule RCU free. 51018864b4e5STejun Heo */ 5102669de8bdSBart Van Assche if (is_last) { 5103669de8bdSBart Van Assche wq_unregister_lockdep(wq); 510425b00775SPaul E. McKenney call_rcu(&wq->rcu, rcu_free_wq); 51056029a918STejun Heo } 5106669de8bdSBart Van Assche } 51078864b4e5STejun Heo 510867dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */ 5109f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, 5110f147f29eSTejun Heo struct worker_pool *pool) 5111d2c1d404STejun Heo { 5112e9a8e01fSTejun Heo BUG_ON((unsigned long)pwq & ~WORK_STRUCT_PWQ_MASK); 5113d2c1d404STejun Heo 5114e50aba9aSTejun Heo memset(pwq, 0, sizeof(*pwq)); 5115e50aba9aSTejun Heo 5116d2c1d404STejun Heo pwq->pool = pool; 5117d2c1d404STejun Heo pwq->wq = wq; 5118d2c1d404STejun Heo pwq->flush_color = -1; 51198864b4e5STejun Heo pwq->refcnt = 1; 5120f97a4a1aSLai Jiangshan INIT_LIST_HEAD(&pwq->inactive_works); 51215797b1c1STejun Heo INIT_LIST_HEAD(&pwq->pending_node); 51221befcf30STejun Heo INIT_LIST_HEAD(&pwq->pwqs_node); 5123d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 5124687a9aa5STejun Heo kthread_init_work(&pwq->release_work, pwq_release_workfn); 5125f147f29eSTejun Heo } 5126d2c1d404STejun Heo 5127f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */ 51281befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq) 5129f147f29eSTejun Heo { 5130f147f29eSTejun Heo struct workqueue_struct *wq = pwq->wq; 5131f147f29eSTejun Heo 5132f147f29eSTejun Heo lockdep_assert_held(&wq->mutex); 513375ccf595STejun Heo 51341befcf30STejun Heo /* may be called multiple times, ignore if already linked */ 51351befcf30STejun Heo if (!list_empty(&pwq->pwqs_node)) 51361befcf30STejun Heo return; 51371befcf30STejun Heo 513829b1cb41SLai Jiangshan /* set the matching work_color */ 513975ccf595STejun Heo pwq->work_color = wq->work_color; 5140983ca25eSTejun Heo 5141983ca25eSTejun Heo /* link in @pwq */ 514226fb7e3dSWaiman Long list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs); 5143df2d5ae4STejun Heo } 51446029a918STejun Heo 5145f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ 5146f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, 5147f147f29eSTejun Heo const struct workqueue_attrs *attrs) 5148f147f29eSTejun Heo { 5149f147f29eSTejun Heo struct worker_pool *pool; 5150f147f29eSTejun Heo struct pool_workqueue *pwq; 5151f147f29eSTejun Heo 5152f147f29eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 5153f147f29eSTejun Heo 5154f147f29eSTejun Heo pool = get_unbound_pool(attrs); 5155f147f29eSTejun Heo if (!pool) 5156f147f29eSTejun Heo return NULL; 5157f147f29eSTejun Heo 5158e50aba9aSTejun Heo pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); 5159f147f29eSTejun Heo if (!pwq) { 5160f147f29eSTejun Heo put_unbound_pool(pool); 5161f147f29eSTejun Heo return NULL; 5162f147f29eSTejun Heo } 5163f147f29eSTejun Heo 5164f147f29eSTejun Heo init_pwq(pwq, wq, pool); 5165f147f29eSTejun Heo return pwq; 5166d2c1d404STejun Heo } 5167d2c1d404STejun Heo 51681726a171SLai Jiangshan static void apply_wqattrs_lock(void) 51691726a171SLai Jiangshan { 51701726a171SLai Jiangshan mutex_lock(&wq_pool_mutex); 51711726a171SLai Jiangshan } 51721726a171SLai Jiangshan 51731726a171SLai Jiangshan static void apply_wqattrs_unlock(void) 51741726a171SLai Jiangshan { 51751726a171SLai Jiangshan mutex_unlock(&wq_pool_mutex); 51761726a171SLai Jiangshan } 51771726a171SLai Jiangshan 51784c16bd32STejun Heo /** 5179fef59c9cSTejun Heo * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod 5180042f7df1SLai Jiangshan * @attrs: the wq_attrs of the default pwq of the target workqueue 518184193c07STejun Heo * @cpu: the target CPU 51824c16bd32STejun Heo * 518388a41b18SLai Jiangshan * Calculate the cpumask a workqueue with @attrs should use on @pod. 51849546b29eSTejun Heo * The result is stored in @attrs->__pod_cpumask. 51854c16bd32STejun Heo * 5186fef59c9cSTejun Heo * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled 5187fef59c9cSTejun Heo * and @pod has online CPUs requested by @attrs, the returned cpumask is the 5188fef59c9cSTejun Heo * intersection of the possible CPUs of @pod and @attrs->cpumask. 51894c16bd32STejun Heo * 5190fef59c9cSTejun Heo * The caller is responsible for ensuring that the cpumask of @pod stays stable. 51914c16bd32STejun Heo */ 519288a41b18SLai Jiangshan static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu) 51934c16bd32STejun Heo { 519484193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 519584193c07STejun Heo int pod = pt->cpu_pod[cpu]; 51964c16bd32STejun Heo 5197fbb3d4c1SLai Jiangshan /* calculate possible CPUs in @pod that @attrs wants */ 51989546b29eSTejun Heo cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask); 5199fbb3d4c1SLai Jiangshan /* does @pod have any online CPUs @attrs wants? */ 5200fbb3d4c1SLai Jiangshan if (!cpumask_intersects(attrs->__pod_cpumask, wq_online_cpumask)) { 52019546b29eSTejun Heo cpumask_copy(attrs->__pod_cpumask, attrs->cpumask); 520284193c07STejun Heo return; 520384193c07STejun Heo } 52044c16bd32STejun Heo } 52054c16bd32STejun Heo 52069f66cff2STejun Heo /* install @pwq into @wq and return the old pwq, @cpu < 0 for dfl_pwq */ 5207636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq, 5208636b927eSTejun Heo int cpu, struct pool_workqueue *pwq) 52091befcf30STejun Heo { 52109f66cff2STejun Heo struct pool_workqueue __rcu **slot = unbound_pwq_slot(wq, cpu); 52111befcf30STejun Heo struct pool_workqueue *old_pwq; 52121befcf30STejun Heo 52135b95e1afSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 52141befcf30STejun Heo lockdep_assert_held(&wq->mutex); 52151befcf30STejun Heo 52161befcf30STejun Heo /* link_pwq() can handle duplicate calls */ 52171befcf30STejun Heo link_pwq(pwq); 52181befcf30STejun Heo 52199f66cff2STejun Heo old_pwq = rcu_access_pointer(*slot); 52209f66cff2STejun Heo rcu_assign_pointer(*slot, pwq); 52211befcf30STejun Heo return old_pwq; 52221befcf30STejun Heo } 52231befcf30STejun Heo 52242d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */ 52252d5f0764SLai Jiangshan struct apply_wqattrs_ctx { 52262d5f0764SLai Jiangshan struct workqueue_struct *wq; /* target workqueue */ 52272d5f0764SLai Jiangshan struct workqueue_attrs *attrs; /* attrs to apply */ 5228042f7df1SLai Jiangshan struct list_head list; /* queued for batching commit */ 52292d5f0764SLai Jiangshan struct pool_workqueue *dfl_pwq; 52302d5f0764SLai Jiangshan struct pool_workqueue *pwq_tbl[]; 52312d5f0764SLai Jiangshan }; 52322d5f0764SLai Jiangshan 52332d5f0764SLai Jiangshan /* free the resources after success or abort */ 52342d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx) 52352d5f0764SLai Jiangshan { 52362d5f0764SLai Jiangshan if (ctx) { 5237636b927eSTejun Heo int cpu; 52382d5f0764SLai Jiangshan 5239636b927eSTejun Heo for_each_possible_cpu(cpu) 5240636b927eSTejun Heo put_pwq_unlocked(ctx->pwq_tbl[cpu]); 52412d5f0764SLai Jiangshan put_pwq_unlocked(ctx->dfl_pwq); 52422d5f0764SLai Jiangshan 52432d5f0764SLai Jiangshan free_workqueue_attrs(ctx->attrs); 52442d5f0764SLai Jiangshan 52452d5f0764SLai Jiangshan kfree(ctx); 52462d5f0764SLai Jiangshan } 52472d5f0764SLai Jiangshan } 52482d5f0764SLai Jiangshan 52492d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */ 52502d5f0764SLai Jiangshan static struct apply_wqattrs_ctx * 52512d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq, 525299c621efSLai Jiangshan const struct workqueue_attrs *attrs, 525399c621efSLai Jiangshan const cpumask_var_t unbound_cpumask) 52542d5f0764SLai Jiangshan { 52552d5f0764SLai Jiangshan struct apply_wqattrs_ctx *ctx; 52569546b29eSTejun Heo struct workqueue_attrs *new_attrs; 5257636b927eSTejun Heo int cpu; 52582d5f0764SLai Jiangshan 52592d5f0764SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 52602d5f0764SLai Jiangshan 526184193c07STejun Heo if (WARN_ON(attrs->affn_scope < 0 || 526284193c07STejun Heo attrs->affn_scope >= WQ_AFFN_NR_TYPES)) 526384193c07STejun Heo return ERR_PTR(-EINVAL); 526484193c07STejun Heo 5265636b927eSTejun Heo ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL); 52662d5f0764SLai Jiangshan 5267be69d00dSThomas Gleixner new_attrs = alloc_workqueue_attrs(); 52689546b29eSTejun Heo if (!ctx || !new_attrs) 52692d5f0764SLai Jiangshan goto out_free; 52702d5f0764SLai Jiangshan 5271042f7df1SLai Jiangshan /* 52722d5f0764SLai Jiangshan * If something goes wrong during CPU up/down, we'll fall back to 52732d5f0764SLai Jiangshan * the default pwq covering whole @attrs->cpumask. Always create 52742d5f0764SLai Jiangshan * it even if we don't use it immediately. 52752d5f0764SLai Jiangshan */ 52760f36ee24STejun Heo copy_workqueue_attrs(new_attrs, attrs); 52770f36ee24STejun Heo wqattrs_actualize_cpumask(new_attrs, unbound_cpumask); 52789546b29eSTejun Heo cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask); 52792d5f0764SLai Jiangshan ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs); 52802d5f0764SLai Jiangshan if (!ctx->dfl_pwq) 52812d5f0764SLai Jiangshan goto out_free; 52822d5f0764SLai Jiangshan 5283636b927eSTejun Heo for_each_possible_cpu(cpu) { 5284af73f5c9STejun Heo if (new_attrs->ordered) { 52852d5f0764SLai Jiangshan ctx->dfl_pwq->refcnt++; 5286636b927eSTejun Heo ctx->pwq_tbl[cpu] = ctx->dfl_pwq; 5287636b927eSTejun Heo } else { 528888a41b18SLai Jiangshan wq_calc_pod_cpumask(new_attrs, cpu); 52899546b29eSTejun Heo ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs); 5290636b927eSTejun Heo if (!ctx->pwq_tbl[cpu]) 5291636b927eSTejun Heo goto out_free; 52922d5f0764SLai Jiangshan } 52932d5f0764SLai Jiangshan } 52942d5f0764SLai Jiangshan 5295042f7df1SLai Jiangshan /* save the user configured attrs and sanitize it. */ 5296042f7df1SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 5297042f7df1SLai Jiangshan cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); 52989546b29eSTejun Heo cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask); 52992d5f0764SLai Jiangshan ctx->attrs = new_attrs; 5300042f7df1SLai Jiangshan 53014c065dbcSWaiman Long /* 53024c065dbcSWaiman Long * For initialized ordered workqueues, there should only be one pwq 53034c065dbcSWaiman Long * (dfl_pwq). Set the plugged flag of ctx->dfl_pwq to suspend execution 53044c065dbcSWaiman Long * of newly queued work items until execution of older work items in 53054c065dbcSWaiman Long * the old pwq's have completed. 53064c065dbcSWaiman Long */ 53074c065dbcSWaiman Long if ((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)) 53084c065dbcSWaiman Long ctx->dfl_pwq->plugged = true; 53094c065dbcSWaiman Long 53102d5f0764SLai Jiangshan ctx->wq = wq; 53112d5f0764SLai Jiangshan return ctx; 53122d5f0764SLai Jiangshan 53132d5f0764SLai Jiangshan out_free: 53142d5f0764SLai Jiangshan free_workqueue_attrs(new_attrs); 53152d5f0764SLai Jiangshan apply_wqattrs_cleanup(ctx); 531684193c07STejun Heo return ERR_PTR(-ENOMEM); 53172d5f0764SLai Jiangshan } 53182d5f0764SLai Jiangshan 53192d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */ 53202d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx) 53212d5f0764SLai Jiangshan { 5322636b927eSTejun Heo int cpu; 53232d5f0764SLai Jiangshan 53242d5f0764SLai Jiangshan /* all pwqs have been created successfully, let's install'em */ 53252d5f0764SLai Jiangshan mutex_lock(&ctx->wq->mutex); 53262d5f0764SLai Jiangshan 53272d5f0764SLai Jiangshan copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs); 53282d5f0764SLai Jiangshan 53299f66cff2STejun Heo /* save the previous pwqs and install the new ones */ 5330636b927eSTejun Heo for_each_possible_cpu(cpu) 5331636b927eSTejun Heo ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu, 5332636b927eSTejun Heo ctx->pwq_tbl[cpu]); 53339f66cff2STejun Heo ctx->dfl_pwq = install_unbound_pwq(ctx->wq, -1, ctx->dfl_pwq); 53342d5f0764SLai Jiangshan 53355797b1c1STejun Heo /* update node_nr_active->max */ 53365797b1c1STejun Heo wq_update_node_max_active(ctx->wq, -1); 53375797b1c1STejun Heo 5338d64f2fa0SJuri Lelli /* rescuer needs to respect wq cpumask changes */ 5339d64f2fa0SJuri Lelli if (ctx->wq->rescuer) 5340d64f2fa0SJuri Lelli set_cpus_allowed_ptr(ctx->wq->rescuer->task, 5341d64f2fa0SJuri Lelli unbound_effective_cpumask(ctx->wq)); 5342d64f2fa0SJuri Lelli 53432d5f0764SLai Jiangshan mutex_unlock(&ctx->wq->mutex); 53442d5f0764SLai Jiangshan } 53452d5f0764SLai Jiangshan 5346a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq, 5347a0111cf6SLai Jiangshan const struct workqueue_attrs *attrs) 5348a0111cf6SLai Jiangshan { 5349a0111cf6SLai Jiangshan struct apply_wqattrs_ctx *ctx; 5350a0111cf6SLai Jiangshan 5351a0111cf6SLai Jiangshan /* only unbound workqueues can change attributes */ 5352a0111cf6SLai Jiangshan if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 5353a0111cf6SLai Jiangshan return -EINVAL; 5354a0111cf6SLai Jiangshan 535599c621efSLai Jiangshan ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask); 535684193c07STejun Heo if (IS_ERR(ctx)) 535784193c07STejun Heo return PTR_ERR(ctx); 5358a0111cf6SLai Jiangshan 5359a0111cf6SLai Jiangshan /* the ctx has been prepared successfully, let's commit it */ 5360a0111cf6SLai Jiangshan apply_wqattrs_commit(ctx); 5361a0111cf6SLai Jiangshan apply_wqattrs_cleanup(ctx); 5362a0111cf6SLai Jiangshan 53636201171eSwanghaibin return 0; 5364a0111cf6SLai Jiangshan } 5365a0111cf6SLai Jiangshan 53669e8cd2f5STejun Heo /** 53679e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 53689e8cd2f5STejun Heo * @wq: the target workqueue 53699e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 53709e8cd2f5STejun Heo * 5371fef59c9cSTejun Heo * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps 5372fef59c9cSTejun Heo * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that 5373fef59c9cSTejun Heo * work items are affine to the pod it was issued on. Older pwqs are released as 5374fef59c9cSTejun Heo * in-flight work items finish. Note that a work item which repeatedly requeues 5375fef59c9cSTejun Heo * itself back-to-back will stay on its current pwq. 53769e8cd2f5STejun Heo * 5377d185af30SYacine Belkadi * Performs GFP_KERNEL allocations. 5378d185af30SYacine Belkadi * 5379d185af30SYacine Belkadi * Return: 0 on success and -errno on failure. 53809e8cd2f5STejun Heo */ 5381513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq, 53829e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 53839e8cd2f5STejun Heo { 5384a0111cf6SLai Jiangshan int ret; 53859e8cd2f5STejun Heo 5386509b3204SDaniel Jordan mutex_lock(&wq_pool_mutex); 5387a0111cf6SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 5388509b3204SDaniel Jordan mutex_unlock(&wq_pool_mutex); 53892d5f0764SLai Jiangshan 53902d5f0764SLai Jiangshan return ret; 53919e8cd2f5STejun Heo } 53929e8cd2f5STejun Heo 53934c16bd32STejun Heo /** 5394b2b1f933SLai Jiangshan * unbound_wq_update_pwq - update a pwq slot for CPU hot[un]plug 53954c16bd32STejun Heo * @wq: the target workqueue 5396b2b1f933SLai Jiangshan * @cpu: the CPU to update the pwq slot for 53974c16bd32STejun Heo * 53984c16bd32STejun Heo * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and 5399b2b1f933SLai Jiangshan * %CPU_DOWN_FAILED. @cpu is in the same pod of the CPU being hot[un]plugged. 54004c16bd32STejun Heo * 54014c16bd32STejun Heo * 5402fef59c9cSTejun Heo * If pod affinity can't be adjusted due to memory allocation failure, it falls 5403fef59c9cSTejun Heo * back to @wq->dfl_pwq which may not be optimal but is always correct. 5404fef59c9cSTejun Heo * 5405fef59c9cSTejun Heo * Note that when the last allowed CPU of a pod goes offline for a workqueue 5406fef59c9cSTejun Heo * with a cpumask spanning multiple pods, the workers which were already 5407fef59c9cSTejun Heo * executing the work items for the workqueue will lose their CPU affinity and 5408fef59c9cSTejun Heo * may execute on any CPU. This is similar to how per-cpu workqueues behave on 5409fef59c9cSTejun Heo * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's 5410fef59c9cSTejun Heo * responsibility to flush the work item from CPU_DOWN_PREPARE. 54114c16bd32STejun Heo */ 5412b2b1f933SLai Jiangshan static void unbound_wq_update_pwq(struct workqueue_struct *wq, int cpu) 54134c16bd32STejun Heo { 54144c16bd32STejun Heo struct pool_workqueue *old_pwq = NULL, *pwq; 54154c16bd32STejun Heo struct workqueue_attrs *target_attrs; 54164c16bd32STejun Heo 54174c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 54184c16bd32STejun Heo 541984193c07STejun Heo if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered) 54204c16bd32STejun Heo return; 54214c16bd32STejun Heo 54224c16bd32STejun Heo /* 54234c16bd32STejun Heo * We don't wanna alloc/free wq_attrs for each wq for each CPU. 54244c16bd32STejun Heo * Let's use a preallocated one. The following buf is protected by 54254c16bd32STejun Heo * CPU hotplug exclusion. 54264c16bd32STejun Heo */ 5427b2b1f933SLai Jiangshan target_attrs = unbound_wq_update_pwq_attrs_buf; 54284c16bd32STejun Heo 54294c16bd32STejun Heo copy_workqueue_attrs(target_attrs, wq->unbound_attrs); 54300f36ee24STejun Heo wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask); 54314c16bd32STejun Heo 5432636b927eSTejun Heo /* nothing to do if the target cpumask matches the current pwq */ 543388a41b18SLai Jiangshan wq_calc_pod_cpumask(target_attrs, cpu); 54349f66cff2STejun Heo if (wqattrs_equal(target_attrs, unbound_pwq(wq, cpu)->pool->attrs)) 5435f7142ed4SLai Jiangshan return; 54364c16bd32STejun Heo 54374c16bd32STejun Heo /* create a new pwq */ 54384c16bd32STejun Heo pwq = alloc_unbound_pwq(wq, target_attrs); 54394c16bd32STejun Heo if (!pwq) { 5440fef59c9cSTejun Heo pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n", 54414c16bd32STejun Heo wq->name); 544277f300b1SDaeseok Youn goto use_dfl_pwq; 54434c16bd32STejun Heo } 54444c16bd32STejun Heo 5445f7142ed4SLai Jiangshan /* Install the new pwq. */ 54464c16bd32STejun Heo mutex_lock(&wq->mutex); 5447636b927eSTejun Heo old_pwq = install_unbound_pwq(wq, cpu, pwq); 54484c16bd32STejun Heo goto out_unlock; 54494c16bd32STejun Heo 54504c16bd32STejun Heo use_dfl_pwq: 5451f7142ed4SLai Jiangshan mutex_lock(&wq->mutex); 54529f66cff2STejun Heo pwq = unbound_pwq(wq, -1); 54539f66cff2STejun Heo raw_spin_lock_irq(&pwq->pool->lock); 54549f66cff2STejun Heo get_pwq(pwq); 54559f66cff2STejun Heo raw_spin_unlock_irq(&pwq->pool->lock); 54569f66cff2STejun Heo old_pwq = install_unbound_pwq(wq, cpu, pwq); 54574c16bd32STejun Heo out_unlock: 54584c16bd32STejun Heo mutex_unlock(&wq->mutex); 54594c16bd32STejun Heo put_pwq_unlocked(old_pwq); 54604c16bd32STejun Heo } 54614c16bd32STejun Heo 546230cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 54631da177e4SLinus Torvalds { 546449e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 54658a2b7538STejun Heo int cpu, ret; 5466e1d8aa9fSFrederic Weisbecker 54671726a171SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 54681726a171SLai Jiangshan 5469687a9aa5STejun Heo wq->cpu_pwq = alloc_percpu(struct pool_workqueue *); 5470ee1ceef7STejun Heo if (!wq->cpu_pwq) 5471687a9aa5STejun Heo goto enomem; 547230cdf249STejun Heo 5473636b927eSTejun Heo if (!(wq->flags & WQ_UNBOUND)) { 54744cb1ef64STejun Heo struct worker_pool __percpu *pools; 54754cb1ef64STejun Heo 54764cb1ef64STejun Heo if (wq->flags & WQ_BH) 54774cb1ef64STejun Heo pools = bh_worker_pools; 54784cb1ef64STejun Heo else 54794cb1ef64STejun Heo pools = cpu_worker_pools; 54804cb1ef64STejun Heo 54817ccc2151SWenchao Hao for_each_possible_cpu(cpu) { 54827ccc2151SWenchao Hao struct pool_workqueue **pwq_p; 54837ccc2151SWenchao Hao struct worker_pool *pool; 54847ccc2151SWenchao Hao 54854cb1ef64STejun Heo pool = &(per_cpu_ptr(pools, cpu)[highpri]); 54864cb1ef64STejun Heo pwq_p = per_cpu_ptr(wq->cpu_pwq, cpu); 548730cdf249STejun Heo 5488687a9aa5STejun Heo *pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, 5489687a9aa5STejun Heo pool->node); 5490687a9aa5STejun Heo if (!*pwq_p) 5491687a9aa5STejun Heo goto enomem; 5492687a9aa5STejun Heo 5493687a9aa5STejun Heo init_pwq(*pwq_p, wq, pool); 5494f147f29eSTejun Heo 5495f147f29eSTejun Heo mutex_lock(&wq->mutex); 5496687a9aa5STejun Heo link_pwq(*pwq_p); 5497f147f29eSTejun Heo mutex_unlock(&wq->mutex); 549830cdf249STejun Heo } 549930cdf249STejun Heo return 0; 5500509b3204SDaniel Jordan } 5501509b3204SDaniel Jordan 5502509b3204SDaniel Jordan if (wq->flags & __WQ_ORDERED) { 55039f66cff2STejun Heo struct pool_workqueue *dfl_pwq; 55049f66cff2STejun Heo 55051726a171SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, ordered_wq_attrs[highpri]); 55068a2b7538STejun Heo /* there should only be single pwq for ordering guarantee */ 55079f66cff2STejun Heo dfl_pwq = rcu_access_pointer(wq->dfl_pwq); 55089f66cff2STejun Heo WARN(!ret && (wq->pwqs.next != &dfl_pwq->pwqs_node || 55099f66cff2STejun Heo wq->pwqs.prev != &dfl_pwq->pwqs_node), 55108a2b7538STejun Heo "ordering guarantee broken for workqueue %s\n", wq->name); 55119e8cd2f5STejun Heo } else { 55121726a171SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, unbound_std_wq_attrs[highpri]); 55139e8cd2f5STejun Heo } 551464344553SZqiang 5515509b3204SDaniel Jordan return ret; 5516687a9aa5STejun Heo 5517687a9aa5STejun Heo enomem: 5518687a9aa5STejun Heo if (wq->cpu_pwq) { 55197b42f401SZqiang for_each_possible_cpu(cpu) { 55207b42f401SZqiang struct pool_workqueue *pwq = *per_cpu_ptr(wq->cpu_pwq, cpu); 55217b42f401SZqiang 55227b42f401SZqiang if (pwq) 55237b42f401SZqiang kmem_cache_free(pwq_cache, pwq); 55247b42f401SZqiang } 5525687a9aa5STejun Heo free_percpu(wq->cpu_pwq); 5526687a9aa5STejun Heo wq->cpu_pwq = NULL; 5527687a9aa5STejun Heo } 5528687a9aa5STejun Heo return -ENOMEM; 55290f900049STejun Heo } 55300f900049STejun Heo 5531f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 5532f3421797STejun Heo const char *name) 5533b71ab8c2STejun Heo { 5534636b927eSTejun Heo if (max_active < 1 || max_active > WQ_MAX_ACTIVE) 5535044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 5536636b927eSTejun Heo max_active, name, 1, WQ_MAX_ACTIVE); 5537b71ab8c2STejun Heo 5538636b927eSTejun Heo return clamp_val(max_active, 1, WQ_MAX_ACTIVE); 5539b71ab8c2STejun Heo } 5540b71ab8c2STejun Heo 5541983c7515STejun Heo /* 5542983c7515STejun Heo * Workqueues which may be used during memory reclaim should have a rescuer 5543983c7515STejun Heo * to guarantee forward progress. 5544983c7515STejun Heo */ 5545983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq) 5546983c7515STejun Heo { 5547983c7515STejun Heo struct worker *rescuer; 55482a1b02bcSTejun Heo char id_buf[WORKER_ID_LEN]; 5549b92b36eaSDan Carpenter int ret; 5550983c7515STejun Heo 5551449b31adSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5552449b31adSLai Jiangshan 5553983c7515STejun Heo if (!(wq->flags & WQ_MEM_RECLAIM)) 5554983c7515STejun Heo return 0; 5555983c7515STejun Heo 5556983c7515STejun Heo rescuer = alloc_worker(NUMA_NO_NODE); 55574c0736a7SPetr Mladek if (!rescuer) { 55584c0736a7SPetr Mladek pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n", 55594c0736a7SPetr Mladek wq->name); 5560983c7515STejun Heo return -ENOMEM; 55614c0736a7SPetr Mladek } 5562983c7515STejun Heo 5563983c7515STejun Heo rescuer->rescue_wq = wq; 55642a1b02bcSTejun Heo format_worker_id(id_buf, sizeof(id_buf), rescuer, NULL); 55652a1b02bcSTejun Heo 55662a1b02bcSTejun Heo rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", id_buf); 5567f187b697SSean Fu if (IS_ERR(rescuer->task)) { 5568b92b36eaSDan Carpenter ret = PTR_ERR(rescuer->task); 55694c0736a7SPetr Mladek pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe", 55704c0736a7SPetr Mladek wq->name, ERR_PTR(ret)); 5571983c7515STejun Heo kfree(rescuer); 5572b92b36eaSDan Carpenter return ret; 5573983c7515STejun Heo } 5574983c7515STejun Heo 5575983c7515STejun Heo wq->rescuer = rescuer; 557685f0ab43SJuri Lelli if (wq->flags & WQ_UNBOUND) 5577449b31adSLai Jiangshan kthread_bind_mask(rescuer->task, unbound_effective_cpumask(wq)); 557885f0ab43SJuri Lelli else 5579983c7515STejun Heo kthread_bind_mask(rescuer->task, cpu_possible_mask); 5580983c7515STejun Heo wake_up_process(rescuer->task); 5581983c7515STejun Heo 5582983c7515STejun Heo return 0; 5583983c7515STejun Heo } 5584983c7515STejun Heo 5585a045a272STejun Heo /** 5586a045a272STejun Heo * wq_adjust_max_active - update a wq's max_active to the current setting 5587a045a272STejun Heo * @wq: target workqueue 5588a045a272STejun Heo * 5589a045a272STejun Heo * If @wq isn't freezing, set @wq->max_active to the saved_max_active and 5590a045a272STejun Heo * activate inactive work items accordingly. If @wq is freezing, clear 5591a045a272STejun Heo * @wq->max_active to zero. 5592a045a272STejun Heo */ 5593a045a272STejun Heo static void wq_adjust_max_active(struct workqueue_struct *wq) 5594a045a272STejun Heo { 5595c5404d4eSTejun Heo bool activated; 55965797b1c1STejun Heo int new_max, new_min; 5597a045a272STejun Heo 5598a045a272STejun Heo lockdep_assert_held(&wq->mutex); 5599a045a272STejun Heo 5600a045a272STejun Heo if ((wq->flags & WQ_FREEZABLE) && workqueue_freezing) { 56015797b1c1STejun Heo new_max = 0; 56025797b1c1STejun Heo new_min = 0; 56035797b1c1STejun Heo } else { 56045797b1c1STejun Heo new_max = wq->saved_max_active; 56055797b1c1STejun Heo new_min = wq->saved_min_active; 5606a045a272STejun Heo } 5607a045a272STejun Heo 56085797b1c1STejun Heo if (wq->max_active == new_max && wq->min_active == new_min) 5609a045a272STejun Heo return; 5610a045a272STejun Heo 5611a045a272STejun Heo /* 56125797b1c1STejun Heo * Update @wq->max/min_active and then kick inactive work items if more 5613a045a272STejun Heo * active work items are allowed. This doesn't break work item ordering 5614a045a272STejun Heo * because new work items are always queued behind existing inactive 5615a045a272STejun Heo * work items if there are any. 5616a045a272STejun Heo */ 56175797b1c1STejun Heo WRITE_ONCE(wq->max_active, new_max); 56185797b1c1STejun Heo WRITE_ONCE(wq->min_active, new_min); 56195797b1c1STejun Heo 56205797b1c1STejun Heo if (wq->flags & WQ_UNBOUND) 56215797b1c1STejun Heo wq_update_node_max_active(wq, -1); 56225797b1c1STejun Heo 56235797b1c1STejun Heo if (new_max == 0) 56245797b1c1STejun Heo return; 5625a045a272STejun Heo 5626c5404d4eSTejun Heo /* 5627c5404d4eSTejun Heo * Round-robin through pwq's activating the first inactive work item 5628c5404d4eSTejun Heo * until max_active is filled. 5629c5404d4eSTejun Heo */ 5630c5404d4eSTejun Heo do { 5631c5404d4eSTejun Heo struct pool_workqueue *pwq; 5632c5404d4eSTejun Heo 5633c5404d4eSTejun Heo activated = false; 5634a045a272STejun Heo for_each_pwq(pwq, wq) { 5635c26e2f2eSTejun Heo unsigned long irq_flags; 5636a045a272STejun Heo 5637c5404d4eSTejun Heo /* can be called during early boot w/ irq disabled */ 5638c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pwq->pool->lock, irq_flags); 56395797b1c1STejun Heo if (pwq_activate_first_inactive(pwq, true)) { 5640c5404d4eSTejun Heo activated = true; 5641a045a272STejun Heo kick_pool(pwq->pool); 5642c5404d4eSTejun Heo } 5643c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pwq->pool->lock, irq_flags); 5644a045a272STejun Heo } 5645c5404d4eSTejun Heo } while (activated); 5646a045a272STejun Heo } 5647a045a272STejun Heo 5648b188c57aSMatthew Brost static struct workqueue_struct *__alloc_workqueue(const char *fmt, 564997e37d7bSTejun Heo unsigned int flags, 56509b59a85aSMatthew Brost int max_active, va_list args) 56513af24433SOleg Nesterov { 56523af24433SOleg Nesterov struct workqueue_struct *wq; 565391ccc6e7STejun Heo size_t wq_size; 565491ccc6e7STejun Heo int name_len; 5655b196be89STejun Heo 56564cb1ef64STejun Heo if (flags & WQ_BH) { 56574cb1ef64STejun Heo if (WARN_ON_ONCE(flags & ~__WQ_BH_ALLOWS)) 56584cb1ef64STejun Heo return NULL; 56594cb1ef64STejun Heo if (WARN_ON_ONCE(max_active)) 56604cb1ef64STejun Heo return NULL; 56614cb1ef64STejun Heo } 56624cb1ef64STejun Heo 5663cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 5664cee22a15SViresh Kumar if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) 5665cee22a15SViresh Kumar flags |= WQ_UNBOUND; 5666cee22a15SViresh Kumar 5667ecf6881fSTejun Heo /* allocate wq and format name */ 566891ccc6e7STejun Heo if (flags & WQ_UNBOUND) 566991ccc6e7STejun Heo wq_size = struct_size(wq, node_nr_active, nr_node_ids + 1); 567091ccc6e7STejun Heo else 567191ccc6e7STejun Heo wq_size = sizeof(*wq); 567291ccc6e7STejun Heo 567391ccc6e7STejun Heo wq = kzalloc(wq_size, GFP_KERNEL); 5674b196be89STejun Heo if (!wq) 5675d2c1d404STejun Heo return NULL; 5676b196be89STejun Heo 56776029a918STejun Heo if (flags & WQ_UNBOUND) { 5678be69d00dSThomas Gleixner wq->unbound_attrs = alloc_workqueue_attrs(); 56796029a918STejun Heo if (!wq->unbound_attrs) 56806029a918STejun Heo goto err_free_wq; 56816029a918STejun Heo } 56826029a918STejun Heo 568391ccc6e7STejun Heo name_len = vsnprintf(wq->name, sizeof(wq->name), fmt, args); 56843af24433SOleg Nesterov 568591ccc6e7STejun Heo if (name_len >= WQ_NAME_LEN) 568691ccc6e7STejun Heo pr_warn_once("workqueue: name exceeds WQ_NAME_LEN. Truncating to: %s\n", 568791ccc6e7STejun Heo wq->name); 568831c89007SAudra Mitchell 56894cb1ef64STejun Heo if (flags & WQ_BH) { 56904cb1ef64STejun Heo /* 56914cb1ef64STejun Heo * BH workqueues always share a single execution context per CPU 56924cb1ef64STejun Heo * and don't impose any max_active limit. 56934cb1ef64STejun Heo */ 56944cb1ef64STejun Heo max_active = INT_MAX; 56954cb1ef64STejun Heo } else { 5696d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 5697b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 56984cb1ef64STejun Heo } 56993af24433SOleg Nesterov 5700b196be89STejun Heo /* init wq */ 570197e37d7bSTejun Heo wq->flags = flags; 5702a045a272STejun Heo wq->max_active = max_active; 57035797b1c1STejun Heo wq->min_active = min(max_active, WQ_DFL_MIN_ACTIVE); 57045797b1c1STejun Heo wq->saved_max_active = wq->max_active; 57055797b1c1STejun Heo wq->saved_min_active = wq->min_active; 57063c25a55dSLai Jiangshan mutex_init(&wq->mutex); 5707112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 570830cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 570973f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 571073f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 5711493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 57123af24433SOleg Nesterov 5713cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 57143af24433SOleg Nesterov 571591ccc6e7STejun Heo if (flags & WQ_UNBOUND) { 571691ccc6e7STejun Heo if (alloc_node_nr_active(wq->node_nr_active) < 0) 5717b188c57aSMatthew Brost goto err_free_wq; 571891ccc6e7STejun Heo } 571991ccc6e7STejun Heo 57206af8bf3dSOleg Nesterov /* 57211726a171SLai Jiangshan * wq_pool_mutex protects the workqueues list, allocations of PWQs, 5722aa868475SLai Jiangshan * and the global freeze state. 57236af8bf3dSOleg Nesterov */ 57241726a171SLai Jiangshan apply_wqattrs_lock(); 57251726a171SLai Jiangshan 57261726a171SLai Jiangshan if (alloc_and_link_pwqs(wq) < 0) 57271726a171SLai Jiangshan goto err_unlock_free_node_nr_active; 5728a0a1a5fdSTejun Heo 5729a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5730a045a272STejun Heo wq_adjust_max_active(wq); 5731a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5732a0a1a5fdSTejun Heo 5733e2dca7adSTejun Heo list_add_tail_rcu(&wq->list, &workqueues); 5734a0a1a5fdSTejun Heo 5735c5178e6cSLai Jiangshan if (wq_online && init_rescuer(wq) < 0) 5736449b31adSLai Jiangshan goto err_unlock_destroy; 5737449b31adSLai Jiangshan 5738449b31adSLai Jiangshan apply_wqattrs_unlock(); 5739c5178e6cSLai Jiangshan 5740c3138f38SLai Jiangshan if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 5741c3138f38SLai Jiangshan goto err_destroy; 57423af24433SOleg Nesterov 57433af24433SOleg Nesterov return wq; 5744d2c1d404STejun Heo 57451726a171SLai Jiangshan err_unlock_free_node_nr_active: 57461726a171SLai Jiangshan apply_wqattrs_unlock(); 57474e9a3738SLai Jiangshan /* 57484e9a3738SLai Jiangshan * Failed alloc_and_link_pwqs() may leave pending pwq->release_work, 57494e9a3738SLai Jiangshan * flushing the pwq_release_worker ensures that the pwq_release_workfn() 57504e9a3738SLai Jiangshan * completes before calling kfree(wq). 57514e9a3738SLai Jiangshan */ 57524e9a3738SLai Jiangshan if (wq->flags & WQ_UNBOUND) { 57534e9a3738SLai Jiangshan kthread_flush_worker(pwq_release_worker); 575491ccc6e7STejun Heo free_node_nr_active(wq->node_nr_active); 57554e9a3738SLai Jiangshan } 575682efcab3SBart Van Assche err_free_wq: 57576029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 57584690c4abSTejun Heo kfree(wq); 5759d2c1d404STejun Heo return NULL; 5760449b31adSLai Jiangshan err_unlock_destroy: 5761449b31adSLai Jiangshan apply_wqattrs_unlock(); 5762d2c1d404STejun Heo err_destroy: 5763d2c1d404STejun Heo destroy_workqueue(wq); 57644690c4abSTejun Heo return NULL; 57651da177e4SLinus Torvalds } 5766b188c57aSMatthew Brost 5767b188c57aSMatthew Brost __printf(1, 4) 5768b188c57aSMatthew Brost struct workqueue_struct *alloc_workqueue(const char *fmt, 5769b188c57aSMatthew Brost unsigned int flags, 5770b188c57aSMatthew Brost int max_active, ...) 5771b188c57aSMatthew Brost { 5772b188c57aSMatthew Brost struct workqueue_struct *wq; 5773b188c57aSMatthew Brost va_list args; 5774b188c57aSMatthew Brost 5775b188c57aSMatthew Brost va_start(args, max_active); 5776b188c57aSMatthew Brost wq = __alloc_workqueue(fmt, flags, max_active, args); 5777b188c57aSMatthew Brost va_end(args); 5778b188c57aSMatthew Brost if (!wq) 5779b188c57aSMatthew Brost return NULL; 5780b188c57aSMatthew Brost 5781b188c57aSMatthew Brost wq_init_lockdep(wq); 5782b188c57aSMatthew Brost 5783b188c57aSMatthew Brost return wq; 5784b188c57aSMatthew Brost } 5785669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue); 57861da177e4SLinus Torvalds 5787ec0a7d44SMatthew Brost #ifdef CONFIG_LOCKDEP 5788ec0a7d44SMatthew Brost __printf(1, 5) 5789ec0a7d44SMatthew Brost struct workqueue_struct * 5790ec0a7d44SMatthew Brost alloc_workqueue_lockdep_map(const char *fmt, unsigned int flags, 5791ec0a7d44SMatthew Brost int max_active, struct lockdep_map *lockdep_map, ...) 5792ec0a7d44SMatthew Brost { 5793ec0a7d44SMatthew Brost struct workqueue_struct *wq; 5794ec0a7d44SMatthew Brost va_list args; 5795ec0a7d44SMatthew Brost 5796ec0a7d44SMatthew Brost va_start(args, lockdep_map); 5797ec0a7d44SMatthew Brost wq = __alloc_workqueue(fmt, flags, max_active, args); 5798ec0a7d44SMatthew Brost va_end(args); 5799ec0a7d44SMatthew Brost if (!wq) 5800ec0a7d44SMatthew Brost return NULL; 5801ec0a7d44SMatthew Brost 5802ec0a7d44SMatthew Brost wq->lockdep_map = lockdep_map; 5803ec0a7d44SMatthew Brost 5804ec0a7d44SMatthew Brost return wq; 5805ec0a7d44SMatthew Brost } 5806ec0a7d44SMatthew Brost EXPORT_SYMBOL_GPL(alloc_workqueue_lockdep_map); 5807ec0a7d44SMatthew Brost #endif 5808ec0a7d44SMatthew Brost 5809c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq) 5810c29eb853STejun Heo { 5811c29eb853STejun Heo int i; 5812c29eb853STejun Heo 5813c29eb853STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 5814c29eb853STejun Heo if (pwq->nr_in_flight[i]) 5815c29eb853STejun Heo return true; 5816c29eb853STejun Heo 58179f66cff2STejun Heo if ((pwq != rcu_access_pointer(pwq->wq->dfl_pwq)) && (pwq->refcnt > 1)) 5818c29eb853STejun Heo return true; 5819afa87ce8STejun Heo if (!pwq_is_empty(pwq)) 5820c29eb853STejun Heo return true; 5821c29eb853STejun Heo 5822c29eb853STejun Heo return false; 5823c29eb853STejun Heo } 5824c29eb853STejun Heo 58253af24433SOleg Nesterov /** 58263af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 58273af24433SOleg Nesterov * @wq: target workqueue 58283af24433SOleg Nesterov * 58293af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 58303af24433SOleg Nesterov */ 58313af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 58323af24433SOleg Nesterov { 583349e3cf44STejun Heo struct pool_workqueue *pwq; 5834636b927eSTejun Heo int cpu; 58353af24433SOleg Nesterov 5836def98c84STejun Heo /* 5837def98c84STejun Heo * Remove it from sysfs first so that sanity check failure doesn't 5838def98c84STejun Heo * lead to sysfs name conflicts. 5839def98c84STejun Heo */ 5840def98c84STejun Heo workqueue_sysfs_unregister(wq); 5841def98c84STejun Heo 584233e3f0a3SRichard Clark /* mark the workqueue destruction is in progress */ 584333e3f0a3SRichard Clark mutex_lock(&wq->mutex); 584433e3f0a3SRichard Clark wq->flags |= __WQ_DESTROYING; 584533e3f0a3SRichard Clark mutex_unlock(&wq->mutex); 584633e3f0a3SRichard Clark 58479c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 58489c5a2ba7STejun Heo drain_workqueue(wq); 5849c8efcc25STejun Heo 5850def98c84STejun Heo /* kill rescuer, if sanity checks fail, leave it w/o rescuer */ 5851def98c84STejun Heo if (wq->rescuer) { 5852def98c84STejun Heo struct worker *rescuer = wq->rescuer; 5853def98c84STejun Heo 5854def98c84STejun Heo /* this prevents new queueing */ 5855a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 5856def98c84STejun Heo wq->rescuer = NULL; 5857a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 5858def98c84STejun Heo 5859def98c84STejun Heo /* rescuer will empty maydays list before exiting */ 5860def98c84STejun Heo kthread_stop(rescuer->task); 58618efe1223STejun Heo kfree(rescuer); 5862def98c84STejun Heo } 5863def98c84STejun Heo 5864c29eb853STejun Heo /* 5865c29eb853STejun Heo * Sanity checks - grab all the locks so that we wait for all 5866c29eb853STejun Heo * in-flight operations which may do put_pwq(). 5867c29eb853STejun Heo */ 5868c29eb853STejun Heo mutex_lock(&wq_pool_mutex); 5869b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 587049e3cf44STejun Heo for_each_pwq(pwq, wq) { 5871a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 5872c29eb853STejun Heo if (WARN_ON(pwq_busy(pwq))) { 58731d9a6159SKefeng Wang pr_warn("%s: %s has the following busy pwq\n", 5874e66b39afSTejun Heo __func__, wq->name); 5875c29eb853STejun Heo show_pwq(pwq); 5876a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 5877b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 5878c29eb853STejun Heo mutex_unlock(&wq_pool_mutex); 587955df0933SImran Khan show_one_workqueue(wq); 58806183c009STejun Heo return; 588176af4d93STejun Heo } 5882a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 588376af4d93STejun Heo } 5884b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 58856183c009STejun Heo 5886a0a1a5fdSTejun Heo /* 5887a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 5888a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 5889a0a1a5fdSTejun Heo */ 5890e2dca7adSTejun Heo list_del_rcu(&wq->list); 589168e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 58923af24433SOleg Nesterov 58938864b4e5STejun Heo /* 5894636b927eSTejun Heo * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq 5895636b927eSTejun Heo * to put the base refs. @wq will be auto-destroyed from the last 5896636b927eSTejun Heo * pwq_put. RCU read lock prevents @wq from going away from under us. 58978864b4e5STejun Heo */ 5898636b927eSTejun Heo rcu_read_lock(); 5899636b927eSTejun Heo 5900636b927eSTejun Heo for_each_possible_cpu(cpu) { 59019f66cff2STejun Heo put_pwq_unlocked(unbound_pwq(wq, cpu)); 59029f66cff2STejun Heo RCU_INIT_POINTER(*unbound_pwq_slot(wq, cpu), NULL); 59034c16bd32STejun Heo } 59044c16bd32STejun Heo 59059f66cff2STejun Heo put_pwq_unlocked(unbound_pwq(wq, -1)); 59069f66cff2STejun Heo RCU_INIT_POINTER(*unbound_pwq_slot(wq, -1), NULL); 5907636b927eSTejun Heo 5908636b927eSTejun Heo rcu_read_unlock(); 59093af24433SOleg Nesterov } 59103af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 59113af24433SOleg Nesterov 5912dcd989cbSTejun Heo /** 5913dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 5914dcd989cbSTejun Heo * @wq: target workqueue 5915dcd989cbSTejun Heo * @max_active: new max_active value. 5916dcd989cbSTejun Heo * 59175797b1c1STejun Heo * Set max_active of @wq to @max_active. See the alloc_workqueue() function 59185797b1c1STejun Heo * comment. 5919dcd989cbSTejun Heo * 5920dcd989cbSTejun Heo * CONTEXT: 5921dcd989cbSTejun Heo * Don't call from IRQ context. 5922dcd989cbSTejun Heo */ 5923dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 5924dcd989cbSTejun Heo { 59254cb1ef64STejun Heo /* max_active doesn't mean anything for BH workqueues */ 59264cb1ef64STejun Heo if (WARN_ON(wq->flags & WQ_BH)) 59274cb1ef64STejun Heo return; 59288719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 59293bc1e711STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 59308719dceaSTejun Heo return; 59318719dceaSTejun Heo 5932f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 5933dcd989cbSTejun Heo 5934a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5935dcd989cbSTejun Heo 5936dcd989cbSTejun Heo wq->saved_max_active = max_active; 59375797b1c1STejun Heo if (wq->flags & WQ_UNBOUND) 59385797b1c1STejun Heo wq->saved_min_active = min(wq->saved_min_active, max_active); 59395797b1c1STejun Heo 5940a045a272STejun Heo wq_adjust_max_active(wq); 5941dcd989cbSTejun Heo 5942a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5943dcd989cbSTejun Heo } 5944dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 5945dcd989cbSTejun Heo 5946dcd989cbSTejun Heo /** 59478f172181STejun Heo * workqueue_set_min_active - adjust min_active of an unbound workqueue 59488f172181STejun Heo * @wq: target unbound workqueue 59498f172181STejun Heo * @min_active: new min_active value 59508f172181STejun Heo * 59518f172181STejun Heo * Set min_active of an unbound workqueue. Unlike other types of workqueues, an 59528f172181STejun Heo * unbound workqueue is not guaranteed to be able to process max_active 59538f172181STejun Heo * interdependent work items. Instead, an unbound workqueue is guaranteed to be 59548f172181STejun Heo * able to process min_active number of interdependent work items which is 59558f172181STejun Heo * %WQ_DFL_MIN_ACTIVE by default. 59568f172181STejun Heo * 59578f172181STejun Heo * Use this function to adjust the min_active value between 0 and the current 59588f172181STejun Heo * max_active. 59598f172181STejun Heo */ 59608f172181STejun Heo void workqueue_set_min_active(struct workqueue_struct *wq, int min_active) 59618f172181STejun Heo { 59628f172181STejun Heo /* min_active is only meaningful for non-ordered unbound workqueues */ 59638f172181STejun Heo if (WARN_ON((wq->flags & (WQ_BH | WQ_UNBOUND | __WQ_ORDERED)) != 59648f172181STejun Heo WQ_UNBOUND)) 59658f172181STejun Heo return; 59668f172181STejun Heo 59678f172181STejun Heo mutex_lock(&wq->mutex); 59688f172181STejun Heo wq->saved_min_active = clamp(min_active, 0, wq->saved_max_active); 59698f172181STejun Heo wq_adjust_max_active(wq); 59708f172181STejun Heo mutex_unlock(&wq->mutex); 59718f172181STejun Heo } 59728f172181STejun Heo 59738f172181STejun Heo /** 597427d4ee03SLukas Wunner * current_work - retrieve %current task's work struct 597527d4ee03SLukas Wunner * 597627d4ee03SLukas Wunner * Determine if %current task is a workqueue worker and what it's working on. 597727d4ee03SLukas Wunner * Useful to find out the context that the %current task is running in. 597827d4ee03SLukas Wunner * 597927d4ee03SLukas Wunner * Return: work struct if %current task is a workqueue worker, %NULL otherwise. 598027d4ee03SLukas Wunner */ 598127d4ee03SLukas Wunner struct work_struct *current_work(void) 598227d4ee03SLukas Wunner { 598327d4ee03SLukas Wunner struct worker *worker = current_wq_worker(); 598427d4ee03SLukas Wunner 598527d4ee03SLukas Wunner return worker ? worker->current_work : NULL; 598627d4ee03SLukas Wunner } 598727d4ee03SLukas Wunner EXPORT_SYMBOL(current_work); 598827d4ee03SLukas Wunner 598927d4ee03SLukas Wunner /** 5990e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 5991e6267616STejun Heo * 5992e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 5993e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 5994d185af30SYacine Belkadi * 5995d185af30SYacine Belkadi * Return: %true if %current is a workqueue rescuer. %false otherwise. 5996e6267616STejun Heo */ 5997e6267616STejun Heo bool current_is_workqueue_rescuer(void) 5998e6267616STejun Heo { 5999e6267616STejun Heo struct worker *worker = current_wq_worker(); 6000e6267616STejun Heo 60016a092dfdSLai Jiangshan return worker && worker->rescue_wq; 6002e6267616STejun Heo } 6003e6267616STejun Heo 6004e6267616STejun Heo /** 6005dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 6006dcd989cbSTejun Heo * @cpu: CPU in question 6007dcd989cbSTejun Heo * @wq: target workqueue 6008dcd989cbSTejun Heo * 6009dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 6010dcd989cbSTejun Heo * no synchronization around this function and the test result is 6011dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 6012dcd989cbSTejun Heo * 6013d3251859STejun Heo * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. 6014636b927eSTejun Heo * 6015636b927eSTejun Heo * With the exception of ordered workqueues, all workqueues have per-cpu 6016636b927eSTejun Heo * pool_workqueues, each with its own congested state. A workqueue being 6017636b927eSTejun Heo * congested on one CPU doesn't mean that the workqueue is contested on any 6018636b927eSTejun Heo * other CPUs. 6019d3251859STejun Heo * 6020d185af30SYacine Belkadi * Return: 6021dcd989cbSTejun Heo * %true if congested, %false otherwise. 6022dcd989cbSTejun Heo */ 6023d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 6024dcd989cbSTejun Heo { 60257fb98ea7STejun Heo struct pool_workqueue *pwq; 602676af4d93STejun Heo bool ret; 602776af4d93STejun Heo 602824acfb71SThomas Gleixner rcu_read_lock(); 602924acfb71SThomas Gleixner preempt_disable(); 60307fb98ea7STejun Heo 6031d3251859STejun Heo if (cpu == WORK_CPU_UNBOUND) 6032d3251859STejun Heo cpu = smp_processor_id(); 6033d3251859STejun Heo 6034687a9aa5STejun Heo pwq = *per_cpu_ptr(wq->cpu_pwq, cpu); 6035f97a4a1aSLai Jiangshan ret = !list_empty(&pwq->inactive_works); 6036636b927eSTejun Heo 603724acfb71SThomas Gleixner preempt_enable(); 603824acfb71SThomas Gleixner rcu_read_unlock(); 603976af4d93STejun Heo 604076af4d93STejun Heo return ret; 6041dcd989cbSTejun Heo } 6042dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 6043dcd989cbSTejun Heo 6044dcd989cbSTejun Heo /** 6045dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 6046dcd989cbSTejun Heo * @work: the work to be tested 6047dcd989cbSTejun Heo * 6048dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 6049dcd989cbSTejun Heo * synchronization around this function and the test result is 6050dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 6051dcd989cbSTejun Heo * 6052d185af30SYacine Belkadi * Return: 6053dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 6054dcd989cbSTejun Heo */ 6055dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 6056dcd989cbSTejun Heo { 6057fa1b54e6STejun Heo struct worker_pool *pool; 6058c26e2f2eSTejun Heo unsigned long irq_flags; 6059dcd989cbSTejun Heo unsigned int ret = 0; 6060dcd989cbSTejun Heo 6061dcd989cbSTejun Heo if (work_pending(work)) 6062dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 6063038366c5SLai Jiangshan 606424acfb71SThomas Gleixner rcu_read_lock(); 6065fa1b54e6STejun Heo pool = get_work_pool(work); 6066038366c5SLai Jiangshan if (pool) { 6067c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pool->lock, irq_flags); 6068c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 6069dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 6070c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pool->lock, irq_flags); 6071038366c5SLai Jiangshan } 607224acfb71SThomas Gleixner rcu_read_unlock(); 6073dcd989cbSTejun Heo 6074dcd989cbSTejun Heo return ret; 6075dcd989cbSTejun Heo } 6076dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 6077dcd989cbSTejun Heo 60783d1cb205STejun Heo /** 60793d1cb205STejun Heo * set_worker_desc - set description for the current work item 60803d1cb205STejun Heo * @fmt: printf-style format string 60813d1cb205STejun Heo * @...: arguments for the format string 60823d1cb205STejun Heo * 60833d1cb205STejun Heo * This function can be called by a running work function to describe what 60843d1cb205STejun Heo * the work item is about. If the worker task gets dumped, this 60853d1cb205STejun Heo * information will be printed out together to help debugging. The 60863d1cb205STejun Heo * description can be at most WORKER_DESC_LEN including the trailing '\0'. 60873d1cb205STejun Heo */ 60883d1cb205STejun Heo void set_worker_desc(const char *fmt, ...) 60893d1cb205STejun Heo { 60903d1cb205STejun Heo struct worker *worker = current_wq_worker(); 60913d1cb205STejun Heo va_list args; 60923d1cb205STejun Heo 60933d1cb205STejun Heo if (worker) { 60943d1cb205STejun Heo va_start(args, fmt); 60953d1cb205STejun Heo vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); 60963d1cb205STejun Heo va_end(args); 60973d1cb205STejun Heo } 60983d1cb205STejun Heo } 60995c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc); 61003d1cb205STejun Heo 61013d1cb205STejun Heo /** 61023d1cb205STejun Heo * print_worker_info - print out worker information and description 61033d1cb205STejun Heo * @log_lvl: the log level to use when printing 61043d1cb205STejun Heo * @task: target task 61053d1cb205STejun Heo * 61063d1cb205STejun Heo * If @task is a worker and currently executing a work item, print out the 61073d1cb205STejun Heo * name of the workqueue being serviced and worker description set with 61083d1cb205STejun Heo * set_worker_desc() by the currently executing work item. 61093d1cb205STejun Heo * 61103d1cb205STejun Heo * This function can be safely called on any task as long as the 61113d1cb205STejun Heo * task_struct itself is accessible. While safe, this function isn't 61123d1cb205STejun Heo * synchronized and may print out mixups or garbages of limited length. 61133d1cb205STejun Heo */ 61143d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task) 61153d1cb205STejun Heo { 61163d1cb205STejun Heo work_func_t *fn = NULL; 61173d1cb205STejun Heo char name[WQ_NAME_LEN] = { }; 61183d1cb205STejun Heo char desc[WORKER_DESC_LEN] = { }; 61193d1cb205STejun Heo struct pool_workqueue *pwq = NULL; 61203d1cb205STejun Heo struct workqueue_struct *wq = NULL; 61213d1cb205STejun Heo struct worker *worker; 61223d1cb205STejun Heo 61233d1cb205STejun Heo if (!(task->flags & PF_WQ_WORKER)) 61243d1cb205STejun Heo return; 61253d1cb205STejun Heo 61263d1cb205STejun Heo /* 61273d1cb205STejun Heo * This function is called without any synchronization and @task 61283d1cb205STejun Heo * could be in any state. Be careful with dereferences. 61293d1cb205STejun Heo */ 6130e700591aSPetr Mladek worker = kthread_probe_data(task); 61313d1cb205STejun Heo 61323d1cb205STejun Heo /* 61338bf89593STejun Heo * Carefully copy the associated workqueue's workfn, name and desc. 61348bf89593STejun Heo * Keep the original last '\0' in case the original is garbage. 61353d1cb205STejun Heo */ 6136fe557319SChristoph Hellwig copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn)); 6137fe557319SChristoph Hellwig copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq)); 6138fe557319SChristoph Hellwig copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq)); 6139fe557319SChristoph Hellwig copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1); 6140fe557319SChristoph Hellwig copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1); 61413d1cb205STejun Heo 61423d1cb205STejun Heo if (fn || name[0] || desc[0]) { 6143d75f773cSSakari Ailus printk("%sWorkqueue: %s %ps", log_lvl, name, fn); 61448bf89593STejun Heo if (strcmp(name, desc)) 61453d1cb205STejun Heo pr_cont(" (%s)", desc); 61463d1cb205STejun Heo pr_cont("\n"); 61473d1cb205STejun Heo } 61483d1cb205STejun Heo } 61493d1cb205STejun Heo 61503494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool) 61513494fc30STejun Heo { 61523494fc30STejun Heo pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask); 61533494fc30STejun Heo if (pool->node != NUMA_NO_NODE) 61543494fc30STejun Heo pr_cont(" node=%d", pool->node); 61554cb1ef64STejun Heo pr_cont(" flags=0x%x", pool->flags); 61564cb1ef64STejun Heo if (pool->flags & POOL_BH) 61574cb1ef64STejun Heo pr_cont(" bh%s", 61584cb1ef64STejun Heo pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : ""); 61594cb1ef64STejun Heo else 61604cb1ef64STejun Heo pr_cont(" nice=%d", pool->attrs->nice); 61614cb1ef64STejun Heo } 61624cb1ef64STejun Heo 61634cb1ef64STejun Heo static void pr_cont_worker_id(struct worker *worker) 61644cb1ef64STejun Heo { 61654cb1ef64STejun Heo struct worker_pool *pool = worker->pool; 61664cb1ef64STejun Heo 61674cb1ef64STejun Heo if (pool->flags & WQ_BH) 61684cb1ef64STejun Heo pr_cont("bh%s", 61694cb1ef64STejun Heo pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : ""); 61704cb1ef64STejun Heo else 61714cb1ef64STejun Heo pr_cont("%d%s", task_pid_nr(worker->task), 61724cb1ef64STejun Heo worker->rescue_wq ? "(RESCUER)" : ""); 61733494fc30STejun Heo } 61743494fc30STejun Heo 6175c76feb0dSPaul E. McKenney struct pr_cont_work_struct { 6176c76feb0dSPaul E. McKenney bool comma; 6177c76feb0dSPaul E. McKenney work_func_t func; 6178c76feb0dSPaul E. McKenney long ctr; 6179c76feb0dSPaul E. McKenney }; 6180c76feb0dSPaul E. McKenney 6181c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp) 6182c76feb0dSPaul E. McKenney { 6183c76feb0dSPaul E. McKenney if (!pcwsp->ctr) 6184c76feb0dSPaul E. McKenney goto out_record; 6185c76feb0dSPaul E. McKenney if (func == pcwsp->func) { 6186c76feb0dSPaul E. McKenney pcwsp->ctr++; 6187c76feb0dSPaul E. McKenney return; 6188c76feb0dSPaul E. McKenney } 6189c76feb0dSPaul E. McKenney if (pcwsp->ctr == 1) 6190c76feb0dSPaul E. McKenney pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func); 6191c76feb0dSPaul E. McKenney else 6192c76feb0dSPaul E. McKenney pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func); 6193c76feb0dSPaul E. McKenney pcwsp->ctr = 0; 6194c76feb0dSPaul E. McKenney out_record: 6195c76feb0dSPaul E. McKenney if ((long)func == -1L) 6196c76feb0dSPaul E. McKenney return; 6197c76feb0dSPaul E. McKenney pcwsp->comma = comma; 6198c76feb0dSPaul E. McKenney pcwsp->func = func; 6199c76feb0dSPaul E. McKenney pcwsp->ctr = 1; 6200c76feb0dSPaul E. McKenney } 6201c76feb0dSPaul E. McKenney 6202c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp) 62033494fc30STejun Heo { 62043494fc30STejun Heo if (work->func == wq_barrier_func) { 62053494fc30STejun Heo struct wq_barrier *barr; 62063494fc30STejun Heo 62073494fc30STejun Heo barr = container_of(work, struct wq_barrier, work); 62083494fc30STejun Heo 6209c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1, pcwsp); 62103494fc30STejun Heo pr_cont("%s BAR(%d)", comma ? "," : "", 62113494fc30STejun Heo task_pid_nr(barr->task)); 62123494fc30STejun Heo } else { 6213c76feb0dSPaul E. McKenney if (!comma) 6214c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1, pcwsp); 6215c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, work->func, pcwsp); 62163494fc30STejun Heo } 62173494fc30STejun Heo } 62183494fc30STejun Heo 62193494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq) 62203494fc30STejun Heo { 6221c76feb0dSPaul E. McKenney struct pr_cont_work_struct pcws = { .ctr = 0, }; 62223494fc30STejun Heo struct worker_pool *pool = pwq->pool; 62233494fc30STejun Heo struct work_struct *work; 62243494fc30STejun Heo struct worker *worker; 62253494fc30STejun Heo bool has_in_flight = false, has_pending = false; 62263494fc30STejun Heo int bkt; 62273494fc30STejun Heo 62283494fc30STejun Heo pr_info(" pwq %d:", pool->id); 62293494fc30STejun Heo pr_cont_pool_info(pool); 62303494fc30STejun Heo 6231a045a272STejun Heo pr_cont(" active=%d refcnt=%d%s\n", 6232a045a272STejun Heo pwq->nr_active, pwq->refcnt, 62333494fc30STejun Heo !list_empty(&pwq->mayday_node) ? " MAYDAY" : ""); 62343494fc30STejun Heo 62353494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 62363494fc30STejun Heo if (worker->current_pwq == pwq) { 62373494fc30STejun Heo has_in_flight = true; 62383494fc30STejun Heo break; 62393494fc30STejun Heo } 62403494fc30STejun Heo } 62413494fc30STejun Heo if (has_in_flight) { 62423494fc30STejun Heo bool comma = false; 62433494fc30STejun Heo 62443494fc30STejun Heo pr_info(" in-flight:"); 62453494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 62463494fc30STejun Heo if (worker->current_pwq != pwq) 62473494fc30STejun Heo continue; 62483494fc30STejun Heo 62494cb1ef64STejun Heo pr_cont(" %s", comma ? "," : ""); 62504cb1ef64STejun Heo pr_cont_worker_id(worker); 62514cb1ef64STejun Heo pr_cont(":%ps", worker->current_func); 62523494fc30STejun Heo list_for_each_entry(work, &worker->scheduled, entry) 6253c76feb0dSPaul E. McKenney pr_cont_work(false, work, &pcws); 6254c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 62553494fc30STejun Heo comma = true; 62563494fc30STejun Heo } 62573494fc30STejun Heo pr_cont("\n"); 62583494fc30STejun Heo } 62593494fc30STejun Heo 62603494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 62613494fc30STejun Heo if (get_work_pwq(work) == pwq) { 62623494fc30STejun Heo has_pending = true; 62633494fc30STejun Heo break; 62643494fc30STejun Heo } 62653494fc30STejun Heo } 62663494fc30STejun Heo if (has_pending) { 62673494fc30STejun Heo bool comma = false; 62683494fc30STejun Heo 62693494fc30STejun Heo pr_info(" pending:"); 62703494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 62713494fc30STejun Heo if (get_work_pwq(work) != pwq) 62723494fc30STejun Heo continue; 62733494fc30STejun Heo 6274c76feb0dSPaul E. McKenney pr_cont_work(comma, work, &pcws); 62753494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 62763494fc30STejun Heo } 6277c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 62783494fc30STejun Heo pr_cont("\n"); 62793494fc30STejun Heo } 62803494fc30STejun Heo 6281f97a4a1aSLai Jiangshan if (!list_empty(&pwq->inactive_works)) { 62823494fc30STejun Heo bool comma = false; 62833494fc30STejun Heo 6284f97a4a1aSLai Jiangshan pr_info(" inactive:"); 6285f97a4a1aSLai Jiangshan list_for_each_entry(work, &pwq->inactive_works, entry) { 6286c76feb0dSPaul E. McKenney pr_cont_work(comma, work, &pcws); 62873494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 62883494fc30STejun Heo } 6289c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 62903494fc30STejun Heo pr_cont("\n"); 62913494fc30STejun Heo } 62923494fc30STejun Heo } 62933494fc30STejun Heo 62943494fc30STejun Heo /** 629555df0933SImran Khan * show_one_workqueue - dump state of specified workqueue 629655df0933SImran Khan * @wq: workqueue whose state will be printed 62973494fc30STejun Heo */ 629855df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq) 62993494fc30STejun Heo { 63003494fc30STejun Heo struct pool_workqueue *pwq; 63013494fc30STejun Heo bool idle = true; 6302c26e2f2eSTejun Heo unsigned long irq_flags; 63033494fc30STejun Heo 63043494fc30STejun Heo for_each_pwq(pwq, wq) { 6305afa87ce8STejun Heo if (!pwq_is_empty(pwq)) { 63063494fc30STejun Heo idle = false; 63073494fc30STejun Heo break; 63083494fc30STejun Heo } 63093494fc30STejun Heo } 631055df0933SImran Khan if (idle) /* Nothing to print for idle workqueue */ 631155df0933SImran Khan return; 63123494fc30STejun Heo 63133494fc30STejun Heo pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags); 63143494fc30STejun Heo 63153494fc30STejun Heo for_each_pwq(pwq, wq) { 6316c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pwq->pool->lock, irq_flags); 6317afa87ce8STejun Heo if (!pwq_is_empty(pwq)) { 631857116ce1SJohan Hovold /* 631957116ce1SJohan Hovold * Defer printing to avoid deadlocks in console 632057116ce1SJohan Hovold * drivers that queue work while holding locks 632157116ce1SJohan Hovold * also taken in their write paths. 632257116ce1SJohan Hovold */ 632357116ce1SJohan Hovold printk_deferred_enter(); 63243494fc30STejun Heo show_pwq(pwq); 632557116ce1SJohan Hovold printk_deferred_exit(); 632657116ce1SJohan Hovold } 6327c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pwq->pool->lock, irq_flags); 632862635ea8SSergey Senozhatsky /* 632962635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 633055df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 633162635ea8SSergey Senozhatsky * hard lockup. 633262635ea8SSergey Senozhatsky */ 633362635ea8SSergey Senozhatsky touch_nmi_watchdog(); 63343494fc30STejun Heo } 633555df0933SImran Khan 63363494fc30STejun Heo } 63373494fc30STejun Heo 633855df0933SImran Khan /** 633955df0933SImran Khan * show_one_worker_pool - dump state of specified worker pool 634055df0933SImran Khan * @pool: worker pool whose state will be printed 634155df0933SImran Khan */ 634255df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool) 634355df0933SImran Khan { 63443494fc30STejun Heo struct worker *worker; 63453494fc30STejun Heo bool first = true; 6346c26e2f2eSTejun Heo unsigned long irq_flags; 6347335a42ebSPetr Mladek unsigned long hung = 0; 63483494fc30STejun Heo 6349c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pool->lock, irq_flags); 63503494fc30STejun Heo if (pool->nr_workers == pool->nr_idle) 63513494fc30STejun Heo goto next_pool; 6352335a42ebSPetr Mladek 6353335a42ebSPetr Mladek /* How long the first pending work is waiting for a worker. */ 6354335a42ebSPetr Mladek if (!list_empty(&pool->worklist)) 6355335a42ebSPetr Mladek hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000; 6356335a42ebSPetr Mladek 635757116ce1SJohan Hovold /* 635857116ce1SJohan Hovold * Defer printing to avoid deadlocks in console drivers that 635957116ce1SJohan Hovold * queue work while holding locks also taken in their write 636057116ce1SJohan Hovold * paths. 636157116ce1SJohan Hovold */ 636257116ce1SJohan Hovold printk_deferred_enter(); 63633494fc30STejun Heo pr_info("pool %d:", pool->id); 63643494fc30STejun Heo pr_cont_pool_info(pool); 6365335a42ebSPetr Mladek pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers); 63663494fc30STejun Heo if (pool->manager) 63673494fc30STejun Heo pr_cont(" manager: %d", 63683494fc30STejun Heo task_pid_nr(pool->manager->task)); 63693494fc30STejun Heo list_for_each_entry(worker, &pool->idle_list, entry) { 63704cb1ef64STejun Heo pr_cont(" %s", first ? "idle: " : ""); 63714cb1ef64STejun Heo pr_cont_worker_id(worker); 63723494fc30STejun Heo first = false; 63733494fc30STejun Heo } 63743494fc30STejun Heo pr_cont("\n"); 637557116ce1SJohan Hovold printk_deferred_exit(); 63763494fc30STejun Heo next_pool: 6377c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pool->lock, irq_flags); 637862635ea8SSergey Senozhatsky /* 637962635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 638055df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 638162635ea8SSergey Senozhatsky * hard lockup. 638262635ea8SSergey Senozhatsky */ 638362635ea8SSergey Senozhatsky touch_nmi_watchdog(); 638455df0933SImran Khan 63853494fc30STejun Heo } 63863494fc30STejun Heo 638755df0933SImran Khan /** 638855df0933SImran Khan * show_all_workqueues - dump workqueue state 638955df0933SImran Khan * 6390704bc669SJungseung Lee * Called from a sysrq handler and prints out all busy workqueues and pools. 639155df0933SImran Khan */ 639255df0933SImran Khan void show_all_workqueues(void) 639355df0933SImran Khan { 639455df0933SImran Khan struct workqueue_struct *wq; 639555df0933SImran Khan struct worker_pool *pool; 639655df0933SImran Khan int pi; 639755df0933SImran Khan 639855df0933SImran Khan rcu_read_lock(); 639955df0933SImran Khan 640055df0933SImran Khan pr_info("Showing busy workqueues and worker pools:\n"); 640155df0933SImran Khan 640255df0933SImran Khan list_for_each_entry_rcu(wq, &workqueues, list) 640355df0933SImran Khan show_one_workqueue(wq); 640455df0933SImran Khan 640555df0933SImran Khan for_each_pool(pool, pi) 640655df0933SImran Khan show_one_worker_pool(pool); 640755df0933SImran Khan 640824acfb71SThomas Gleixner rcu_read_unlock(); 64093494fc30STejun Heo } 64103494fc30STejun Heo 6411704bc669SJungseung Lee /** 6412704bc669SJungseung Lee * show_freezable_workqueues - dump freezable workqueue state 6413704bc669SJungseung Lee * 6414704bc669SJungseung Lee * Called from try_to_freeze_tasks() and prints out all freezable workqueues 6415704bc669SJungseung Lee * still busy. 6416704bc669SJungseung Lee */ 6417704bc669SJungseung Lee void show_freezable_workqueues(void) 6418704bc669SJungseung Lee { 6419704bc669SJungseung Lee struct workqueue_struct *wq; 6420704bc669SJungseung Lee 6421704bc669SJungseung Lee rcu_read_lock(); 6422704bc669SJungseung Lee 6423704bc669SJungseung Lee pr_info("Showing freezable workqueues that are still busy:\n"); 6424704bc669SJungseung Lee 6425704bc669SJungseung Lee list_for_each_entry_rcu(wq, &workqueues, list) { 6426704bc669SJungseung Lee if (!(wq->flags & WQ_FREEZABLE)) 6427704bc669SJungseung Lee continue; 6428704bc669SJungseung Lee show_one_workqueue(wq); 6429704bc669SJungseung Lee } 6430704bc669SJungseung Lee 6431704bc669SJungseung Lee rcu_read_unlock(); 6432704bc669SJungseung Lee } 6433704bc669SJungseung Lee 64346b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */ 64356b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task) 64366b59808bSTejun Heo { 6437197f6accSTejun Heo /* stabilize PF_WQ_WORKER and worker pool association */ 64386b59808bSTejun Heo mutex_lock(&wq_pool_attach_mutex); 64396b59808bSTejun Heo 6440197f6accSTejun Heo if (task->flags & PF_WQ_WORKER) { 6441197f6accSTejun Heo struct worker *worker = kthread_data(task); 6442197f6accSTejun Heo struct worker_pool *pool = worker->pool; 64432a1b02bcSTejun Heo int off; 64442a1b02bcSTejun Heo 64452a1b02bcSTejun Heo off = format_worker_id(buf, size, worker, pool); 64466b59808bSTejun Heo 64476b59808bSTejun Heo if (pool) { 6448a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 64496b59808bSTejun Heo /* 6450197f6accSTejun Heo * ->desc tracks information (wq name or 6451197f6accSTejun Heo * set_worker_desc()) for the latest execution. If 6452197f6accSTejun Heo * current, prepend '+', otherwise '-'. 64536b59808bSTejun Heo */ 64546b59808bSTejun Heo if (worker->desc[0] != '\0') { 64556b59808bSTejun Heo if (worker->current_work) 64566b59808bSTejun Heo scnprintf(buf + off, size - off, "+%s", 64576b59808bSTejun Heo worker->desc); 64586b59808bSTejun Heo else 64596b59808bSTejun Heo scnprintf(buf + off, size - off, "-%s", 64606b59808bSTejun Heo worker->desc); 64616b59808bSTejun Heo } 6462a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 64636b59808bSTejun Heo } 64642a1b02bcSTejun Heo } else { 64652a1b02bcSTejun Heo strscpy(buf, task->comm, size); 6466197f6accSTejun Heo } 64676b59808bSTejun Heo 64686b59808bSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 64696b59808bSTejun Heo } 64706b59808bSTejun Heo 647166448bc2SMathieu Malaterre #ifdef CONFIG_SMP 647266448bc2SMathieu Malaterre 6473db7bccf4STejun Heo /* 6474db7bccf4STejun Heo * CPU hotplug. 6475db7bccf4STejun Heo * 6476e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 6477112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 6478706026c2STejun Heo * pool which make migrating pending and scheduled works very 6479e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 648094cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 6481e22bee78STejun Heo * blocked draining impractical. 6482e22bee78STejun Heo * 648324647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 6484628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 6485628c78e7STejun Heo * cpu comes back online. 6486db7bccf4STejun Heo */ 6487db7bccf4STejun Heo 6488e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu) 6489db7bccf4STejun Heo { 64904ce62e9eSTejun Heo struct worker_pool *pool; 6491db7bccf4STejun Heo struct worker *worker; 6492db7bccf4STejun Heo 6493f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 64941258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 6495a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 6496e22bee78STejun Heo 6497f2d5a0eeSTejun Heo /* 649892f9c5c4SLai Jiangshan * We've blocked all attach/detach operations. Make all workers 649994cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 650011b45b0bSLai Jiangshan * must be on the cpu. After this, they may become diasporas. 6501b4ac9384SLai Jiangshan * And the preemption disabled section in their sched callbacks 6502b4ac9384SLai Jiangshan * are guaranteed to see WORKER_UNBOUND since the code here 6503b4ac9384SLai Jiangshan * is on the same cpu. 6504f2d5a0eeSTejun Heo */ 6505da028469SLai Jiangshan for_each_pool_worker(worker, pool) 6506403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 6507db7bccf4STejun Heo 650824647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 6509f2d5a0eeSTejun Heo 6510e22bee78STejun Heo /* 6511989442d7SLai Jiangshan * The handling of nr_running in sched callbacks are disabled 6512989442d7SLai Jiangshan * now. Zap nr_running. After this, nr_running stays zero and 6513989442d7SLai Jiangshan * need_more_worker() and keep_working() are always true as 6514989442d7SLai Jiangshan * long as the worklist is not empty. This pool now behaves as 6515989442d7SLai Jiangshan * an unbound (in terms of concurrency management) pool which 6516eb283428SLai Jiangshan * are served by workers tied to the pool. 6517e22bee78STejun Heo */ 6518bc35f7efSLai Jiangshan pool->nr_running = 0; 6519eb283428SLai Jiangshan 6520eb283428SLai Jiangshan /* 6521eb283428SLai Jiangshan * With concurrency management just turned off, a busy 6522eb283428SLai Jiangshan * worker blocking could lead to lengthy stalls. Kick off 6523eb283428SLai Jiangshan * unbound chain execution of currently pending work items. 6524eb283428SLai Jiangshan */ 65250219a352STejun Heo kick_pool(pool); 6526989442d7SLai Jiangshan 6527a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 6528989442d7SLai Jiangshan 6529793777bcSValentin Schneider for_each_pool_worker(worker, pool) 6530793777bcSValentin Schneider unbind_worker(worker); 6531989442d7SLai Jiangshan 6532989442d7SLai Jiangshan mutex_unlock(&wq_pool_attach_mutex); 6533eb283428SLai Jiangshan } 6534db7bccf4STejun Heo } 6535db7bccf4STejun Heo 6536bd7c089eSTejun Heo /** 6537bd7c089eSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 6538bd7c089eSTejun Heo * @pool: pool of interest 6539bd7c089eSTejun Heo * 6540a9ab775bSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. 6541bd7c089eSTejun Heo */ 6542bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool) 6543bd7c089eSTejun Heo { 6544a9ab775bSTejun Heo struct worker *worker; 6545bd7c089eSTejun Heo 65461258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 6547bd7c089eSTejun Heo 6548bd7c089eSTejun Heo /* 6549a9ab775bSTejun Heo * Restore CPU affinity of all workers. As all idle workers should 6550a9ab775bSTejun Heo * be on the run-queue of the associated CPU before any local 6551402dd89dSShailendra Verma * wake-ups for concurrency management happen, restore CPU affinity 6552a9ab775bSTejun Heo * of all workers first and then clear UNBOUND. As we're called 6553a9ab775bSTejun Heo * from CPU_ONLINE, the following shouldn't fail. 6554bd7c089eSTejun Heo */ 6555c63a2e52SValentin Schneider for_each_pool_worker(worker, pool) { 6556c63a2e52SValentin Schneider kthread_set_per_cpu(worker->task, pool->cpu); 6557c63a2e52SValentin Schneider WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 65589546b29eSTejun Heo pool_allowed_cpus(pool)) < 0); 6559c63a2e52SValentin Schneider } 6560a9ab775bSTejun Heo 6561a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 6562f7c17d26SWanpeng Li 65633de5e884SLai Jiangshan pool->flags &= ~POOL_DISASSOCIATED; 6564a9ab775bSTejun Heo 6565da028469SLai Jiangshan for_each_pool_worker(worker, pool) { 6566a9ab775bSTejun Heo unsigned int worker_flags = worker->flags; 6567a9ab775bSTejun Heo 6568a9ab775bSTejun Heo /* 6569a9ab775bSTejun Heo * We want to clear UNBOUND but can't directly call 6570a9ab775bSTejun Heo * worker_clr_flags() or adjust nr_running. Atomically 6571a9ab775bSTejun Heo * replace UNBOUND with another NOT_RUNNING flag REBOUND. 6572a9ab775bSTejun Heo * @worker will clear REBOUND using worker_clr_flags() when 6573a9ab775bSTejun Heo * it initiates the next execution cycle thus restoring 6574a9ab775bSTejun Heo * concurrency management. Note that when or whether 6575a9ab775bSTejun Heo * @worker clears REBOUND doesn't affect correctness. 6576a9ab775bSTejun Heo * 6577c95491edSMark Rutland * WRITE_ONCE() is necessary because @worker->flags may be 6578a9ab775bSTejun Heo * tested without holding any lock in 65796d25be57SThomas Gleixner * wq_worker_running(). Without it, NOT_RUNNING test may 6580a9ab775bSTejun Heo * fail incorrectly leading to premature concurrency 6581a9ab775bSTejun Heo * management operations. 6582bd7c089eSTejun Heo */ 6583a9ab775bSTejun Heo WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); 6584a9ab775bSTejun Heo worker_flags |= WORKER_REBOUND; 6585a9ab775bSTejun Heo worker_flags &= ~WORKER_UNBOUND; 6586c95491edSMark Rutland WRITE_ONCE(worker->flags, worker_flags); 6587bd7c089eSTejun Heo } 6588a9ab775bSTejun Heo 6589a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 6590bd7c089eSTejun Heo } 6591bd7c089eSTejun Heo 65927dbc725eSTejun Heo /** 65937dbc725eSTejun Heo * restore_unbound_workers_cpumask - restore cpumask of unbound workers 65947dbc725eSTejun Heo * @pool: unbound pool of interest 65957dbc725eSTejun Heo * @cpu: the CPU which is coming up 65967dbc725eSTejun Heo * 65977dbc725eSTejun Heo * An unbound pool may end up with a cpumask which doesn't have any online 65987dbc725eSTejun Heo * CPUs. When a worker of such pool get scheduled, the scheduler resets 65997dbc725eSTejun Heo * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any 66007dbc725eSTejun Heo * online CPU before, cpus_allowed of all its workers should be restored. 66017dbc725eSTejun Heo */ 66027dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) 66037dbc725eSTejun Heo { 66047dbc725eSTejun Heo static cpumask_t cpumask; 66057dbc725eSTejun Heo struct worker *worker; 66067dbc725eSTejun Heo 66071258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 66087dbc725eSTejun Heo 66097dbc725eSTejun Heo /* is @cpu allowed for @pool? */ 66107dbc725eSTejun Heo if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) 66117dbc725eSTejun Heo return; 66127dbc725eSTejun Heo 66137dbc725eSTejun Heo cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); 66147dbc725eSTejun Heo 66157dbc725eSTejun Heo /* as we're called from CPU_ONLINE, the following shouldn't fail */ 6616da028469SLai Jiangshan for_each_pool_worker(worker, pool) 6617d945b5e9SPeter Zijlstra WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0); 66187dbc725eSTejun Heo } 66197dbc725eSTejun Heo 66207ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu) 66211da177e4SLinus Torvalds { 66224ce62e9eSTejun Heo struct worker_pool *pool; 66231da177e4SLinus Torvalds 6624f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 66253ce63377STejun Heo if (pool->nr_workers) 66263ce63377STejun Heo continue; 6627051e1850SLai Jiangshan if (!create_worker(pool)) 66287ee681b2SThomas Gleixner return -ENOMEM; 66293af24433SOleg Nesterov } 66307ee681b2SThomas Gleixner return 0; 66317ee681b2SThomas Gleixner } 66321da177e4SLinus Torvalds 66337ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu) 66347ee681b2SThomas Gleixner { 66357ee681b2SThomas Gleixner struct worker_pool *pool; 66367ee681b2SThomas Gleixner struct workqueue_struct *wq; 66377ee681b2SThomas Gleixner int pi; 66387ee681b2SThomas Gleixner 663968e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 66407dbc725eSTejun Heo 66418d84baf7SLai Jiangshan cpumask_set_cpu(cpu, wq_online_cpumask); 66428d84baf7SLai Jiangshan 66437dbc725eSTejun Heo for_each_pool(pool, pi) { 66444cb1ef64STejun Heo /* BH pools aren't affected by hotplug */ 66454cb1ef64STejun Heo if (pool->flags & POOL_BH) 66464cb1ef64STejun Heo continue; 664794cf58bbSTejun Heo 66484cb1ef64STejun Heo mutex_lock(&wq_pool_attach_mutex); 6649f05b558dSLai Jiangshan if (pool->cpu == cpu) 665094cf58bbSTejun Heo rebind_workers(pool); 6651f05b558dSLai Jiangshan else if (pool->cpu < 0) 66527dbc725eSTejun Heo restore_unbound_workers_cpumask(pool, cpu); 66531258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 665494cf58bbSTejun Heo } 66557dbc725eSTejun Heo 6656fef59c9cSTejun Heo /* update pod affinity of unbound workqueues */ 66574cbfd3deSTejun Heo list_for_each_entry(wq, &workqueues, list) { 665884193c07STejun Heo struct workqueue_attrs *attrs = wq->unbound_attrs; 665984193c07STejun Heo 666084193c07STejun Heo if (attrs) { 666184193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 66624cbfd3deSTejun Heo int tcpu; 66634cbfd3deSTejun Heo 666484193c07STejun Heo for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]]) 6665b2b1f933SLai Jiangshan unbound_wq_update_pwq(wq, tcpu); 66665797b1c1STejun Heo 66675797b1c1STejun Heo mutex_lock(&wq->mutex); 66685797b1c1STejun Heo wq_update_node_max_active(wq, -1); 66695797b1c1STejun Heo mutex_unlock(&wq->mutex); 66704cbfd3deSTejun Heo } 66714cbfd3deSTejun Heo } 66724c16bd32STejun Heo 667368e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 66747ee681b2SThomas Gleixner return 0; 667565758202STejun Heo } 667665758202STejun Heo 66777ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu) 667865758202STejun Heo { 66794c16bd32STejun Heo struct workqueue_struct *wq; 66808db25e78STejun Heo 66814c16bd32STejun Heo /* unbinding per-cpu workers should happen on the local CPU */ 6682e8b3f8dbSLai Jiangshan if (WARN_ON(cpu != smp_processor_id())) 6683e8b3f8dbSLai Jiangshan return -1; 6684e8b3f8dbSLai Jiangshan 6685e8b3f8dbSLai Jiangshan unbind_workers(cpu); 66864c16bd32STejun Heo 6687fef59c9cSTejun Heo /* update pod affinity of unbound workqueues */ 66884c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 66898d84baf7SLai Jiangshan 66908d84baf7SLai Jiangshan cpumask_clear_cpu(cpu, wq_online_cpumask); 66918d84baf7SLai Jiangshan 66924cbfd3deSTejun Heo list_for_each_entry(wq, &workqueues, list) { 669384193c07STejun Heo struct workqueue_attrs *attrs = wq->unbound_attrs; 669484193c07STejun Heo 669584193c07STejun Heo if (attrs) { 669684193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 66974cbfd3deSTejun Heo int tcpu; 66984cbfd3deSTejun Heo 669984193c07STejun Heo for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]]) 6700b2b1f933SLai Jiangshan unbound_wq_update_pwq(wq, tcpu); 67015797b1c1STejun Heo 67025797b1c1STejun Heo mutex_lock(&wq->mutex); 67035797b1c1STejun Heo wq_update_node_max_active(wq, cpu); 67045797b1c1STejun Heo mutex_unlock(&wq->mutex); 67054cbfd3deSTejun Heo } 67064cbfd3deSTejun Heo } 67074c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 67084c16bd32STejun Heo 67097ee681b2SThomas Gleixner return 0; 671065758202STejun Heo } 671165758202STejun Heo 67122d3854a3SRusty Russell struct work_for_cpu { 6713ed48ece2STejun Heo struct work_struct work; 67142d3854a3SRusty Russell long (*fn)(void *); 67152d3854a3SRusty Russell void *arg; 67162d3854a3SRusty Russell long ret; 67172d3854a3SRusty Russell }; 67182d3854a3SRusty Russell 6719ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 67202d3854a3SRusty Russell { 6721ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 6722ed48ece2STejun Heo 67232d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 67242d3854a3SRusty Russell } 67252d3854a3SRusty Russell 67262d3854a3SRusty Russell /** 6727265f3ed0SFrederic Weisbecker * work_on_cpu_key - run a function in thread context on a particular cpu 67282d3854a3SRusty Russell * @cpu: the cpu to run on 67292d3854a3SRusty Russell * @fn: the function to run 67302d3854a3SRusty Russell * @arg: the function arg 6731265f3ed0SFrederic Weisbecker * @key: The lock class key for lock debugging purposes 67322d3854a3SRusty Russell * 673331ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 67346b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 6735d185af30SYacine Belkadi * 6736d185af30SYacine Belkadi * Return: The value @fn returns. 67372d3854a3SRusty Russell */ 6738265f3ed0SFrederic Weisbecker long work_on_cpu_key(int cpu, long (*fn)(void *), 6739265f3ed0SFrederic Weisbecker void *arg, struct lock_class_key *key) 67402d3854a3SRusty Russell { 6741ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 67422d3854a3SRusty Russell 6743265f3ed0SFrederic Weisbecker INIT_WORK_ONSTACK_KEY(&wfc.work, work_for_cpu_fn, key); 6744ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 674512997d1aSBjorn Helgaas flush_work(&wfc.work); 6746440a1136SChuansheng Liu destroy_work_on_stack(&wfc.work); 67472d3854a3SRusty Russell return wfc.ret; 67482d3854a3SRusty Russell } 6749265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_key); 67500e8d6a93SThomas Gleixner 67510e8d6a93SThomas Gleixner /** 6752265f3ed0SFrederic Weisbecker * work_on_cpu_safe_key - run a function in thread context on a particular cpu 67530e8d6a93SThomas Gleixner * @cpu: the cpu to run on 67540e8d6a93SThomas Gleixner * @fn: the function to run 67550e8d6a93SThomas Gleixner * @arg: the function argument 6756265f3ed0SFrederic Weisbecker * @key: The lock class key for lock debugging purposes 67570e8d6a93SThomas Gleixner * 67580e8d6a93SThomas Gleixner * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold 67590e8d6a93SThomas Gleixner * any locks which would prevent @fn from completing. 67600e8d6a93SThomas Gleixner * 67610e8d6a93SThomas Gleixner * Return: The value @fn returns. 67620e8d6a93SThomas Gleixner */ 6763265f3ed0SFrederic Weisbecker long work_on_cpu_safe_key(int cpu, long (*fn)(void *), 6764265f3ed0SFrederic Weisbecker void *arg, struct lock_class_key *key) 67650e8d6a93SThomas Gleixner { 67660e8d6a93SThomas Gleixner long ret = -ENODEV; 67670e8d6a93SThomas Gleixner 6768ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 67690e8d6a93SThomas Gleixner if (cpu_online(cpu)) 6770265f3ed0SFrederic Weisbecker ret = work_on_cpu_key(cpu, fn, arg, key); 6771ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 67720e8d6a93SThomas Gleixner return ret; 67730e8d6a93SThomas Gleixner } 6774265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_safe_key); 67752d3854a3SRusty Russell #endif /* CONFIG_SMP */ 67762d3854a3SRusty Russell 6777a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 6778e7577c50SRusty Russell 6779a0a1a5fdSTejun Heo /** 6780a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 6781a0a1a5fdSTejun Heo * 678258a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 6783f97a4a1aSLai Jiangshan * workqueues will queue new works to their inactive_works list instead of 6784706026c2STejun Heo * pool->worklist. 6785a0a1a5fdSTejun Heo * 6786a0a1a5fdSTejun Heo * CONTEXT: 6787a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 6788a0a1a5fdSTejun Heo */ 6789a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 6790a0a1a5fdSTejun Heo { 679124b8a847STejun Heo struct workqueue_struct *wq; 6792a0a1a5fdSTejun Heo 679368e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 6794a0a1a5fdSTejun Heo 67956183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 6796a0a1a5fdSTejun Heo workqueue_freezing = true; 6797a0a1a5fdSTejun Heo 679824b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 6799a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 6800a045a272STejun Heo wq_adjust_max_active(wq); 6801a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 6802a1056305STejun Heo } 68035bcab335STejun Heo 680468e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 6805a0a1a5fdSTejun Heo } 6806a0a1a5fdSTejun Heo 6807a0a1a5fdSTejun Heo /** 680858a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 6809a0a1a5fdSTejun Heo * 6810a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 6811a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 6812a0a1a5fdSTejun Heo * 6813a0a1a5fdSTejun Heo * CONTEXT: 681468e13a67SLai Jiangshan * Grabs and releases wq_pool_mutex. 6815a0a1a5fdSTejun Heo * 6816d185af30SYacine Belkadi * Return: 681758a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 681858a69cb4STejun Heo * is complete. 6819a0a1a5fdSTejun Heo */ 6820a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 6821a0a1a5fdSTejun Heo { 6822a0a1a5fdSTejun Heo bool busy = false; 682324b8a847STejun Heo struct workqueue_struct *wq; 682424b8a847STejun Heo struct pool_workqueue *pwq; 6825a0a1a5fdSTejun Heo 682668e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 6827a0a1a5fdSTejun Heo 68286183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 6829a0a1a5fdSTejun Heo 683024b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 683124b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 683224b8a847STejun Heo continue; 6833a0a1a5fdSTejun Heo /* 6834a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 6835a0a1a5fdSTejun Heo * to peek without lock. 6836a0a1a5fdSTejun Heo */ 683724acfb71SThomas Gleixner rcu_read_lock(); 683824b8a847STejun Heo for_each_pwq(pwq, wq) { 68396183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 6840112202d9STejun Heo if (pwq->nr_active) { 6841a0a1a5fdSTejun Heo busy = true; 684224acfb71SThomas Gleixner rcu_read_unlock(); 6843a0a1a5fdSTejun Heo goto out_unlock; 6844a0a1a5fdSTejun Heo } 6845a0a1a5fdSTejun Heo } 684624acfb71SThomas Gleixner rcu_read_unlock(); 6847a0a1a5fdSTejun Heo } 6848a0a1a5fdSTejun Heo out_unlock: 684968e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 6850a0a1a5fdSTejun Heo return busy; 6851a0a1a5fdSTejun Heo } 6852a0a1a5fdSTejun Heo 6853a0a1a5fdSTejun Heo /** 6854a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 6855a0a1a5fdSTejun Heo * 6856a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 6857706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 6858a0a1a5fdSTejun Heo * 6859a0a1a5fdSTejun Heo * CONTEXT: 6860a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 6861a0a1a5fdSTejun Heo */ 6862a0a1a5fdSTejun Heo void thaw_workqueues(void) 6863a0a1a5fdSTejun Heo { 686424b8a847STejun Heo struct workqueue_struct *wq; 6865a0a1a5fdSTejun Heo 686668e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 6867a0a1a5fdSTejun Heo 6868a0a1a5fdSTejun Heo if (!workqueue_freezing) 6869a0a1a5fdSTejun Heo goto out_unlock; 6870a0a1a5fdSTejun Heo 687174b414eaSLai Jiangshan workqueue_freezing = false; 687224b8a847STejun Heo 687324b8a847STejun Heo /* restore max_active and repopulate worklist */ 687424b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 6875a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 6876a045a272STejun Heo wq_adjust_max_active(wq); 6877a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 687824b8a847STejun Heo } 687924b8a847STejun Heo 6880a0a1a5fdSTejun Heo out_unlock: 688168e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 6882a0a1a5fdSTejun Heo } 6883a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 6884a0a1a5fdSTejun Heo 688599c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask) 6886042f7df1SLai Jiangshan { 6887042f7df1SLai Jiangshan LIST_HEAD(ctxs); 6888042f7df1SLai Jiangshan int ret = 0; 6889042f7df1SLai Jiangshan struct workqueue_struct *wq; 6890042f7df1SLai Jiangshan struct apply_wqattrs_ctx *ctx, *n; 6891042f7df1SLai Jiangshan 6892042f7df1SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 6893042f7df1SLai Jiangshan 6894042f7df1SLai Jiangshan list_for_each_entry(wq, &workqueues, list) { 68958eb17dc1SWaiman Long if (!(wq->flags & WQ_UNBOUND) || (wq->flags & __WQ_DESTROYING)) 6896042f7df1SLai Jiangshan continue; 6897042f7df1SLai Jiangshan 689899c621efSLai Jiangshan ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask); 689984193c07STejun Heo if (IS_ERR(ctx)) { 690084193c07STejun Heo ret = PTR_ERR(ctx); 6901042f7df1SLai Jiangshan break; 6902042f7df1SLai Jiangshan } 6903042f7df1SLai Jiangshan 6904042f7df1SLai Jiangshan list_add_tail(&ctx->list, &ctxs); 6905042f7df1SLai Jiangshan } 6906042f7df1SLai Jiangshan 6907042f7df1SLai Jiangshan list_for_each_entry_safe(ctx, n, &ctxs, list) { 6908042f7df1SLai Jiangshan if (!ret) 6909042f7df1SLai Jiangshan apply_wqattrs_commit(ctx); 6910042f7df1SLai Jiangshan apply_wqattrs_cleanup(ctx); 6911042f7df1SLai Jiangshan } 6912042f7df1SLai Jiangshan 691399c621efSLai Jiangshan if (!ret) { 691499c621efSLai Jiangshan mutex_lock(&wq_pool_attach_mutex); 691599c621efSLai Jiangshan cpumask_copy(wq_unbound_cpumask, unbound_cpumask); 691699c621efSLai Jiangshan mutex_unlock(&wq_pool_attach_mutex); 691799c621efSLai Jiangshan } 6918042f7df1SLai Jiangshan return ret; 6919042f7df1SLai Jiangshan } 6920042f7df1SLai Jiangshan 6921042f7df1SLai Jiangshan /** 6922fe28f631SWaiman Long * workqueue_unbound_exclude_cpumask - Exclude given CPUs from unbound cpumask 6923fe28f631SWaiman Long * @exclude_cpumask: the cpumask to be excluded from wq_unbound_cpumask 6924fe28f631SWaiman Long * 6925fe28f631SWaiman Long * This function can be called from cpuset code to provide a set of isolated 6926aa868475SLai Jiangshan * CPUs that should be excluded from wq_unbound_cpumask. 6927fe28f631SWaiman Long */ 6928fe28f631SWaiman Long int workqueue_unbound_exclude_cpumask(cpumask_var_t exclude_cpumask) 6929fe28f631SWaiman Long { 6930fe28f631SWaiman Long cpumask_var_t cpumask; 6931fe28f631SWaiman Long int ret = 0; 6932fe28f631SWaiman Long 6933fe28f631SWaiman Long if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 6934fe28f631SWaiman Long return -ENOMEM; 6935fe28f631SWaiman Long 6936fe28f631SWaiman Long mutex_lock(&wq_pool_mutex); 6937fe28f631SWaiman Long 6938fe28f631SWaiman Long /* 6939fe28f631SWaiman Long * If the operation fails, it will fall back to 6940fe28f631SWaiman Long * wq_requested_unbound_cpumask which is initially set to 6941fe28f631SWaiman Long * (HK_TYPE_WQ ∩ HK_TYPE_DOMAIN) house keeping mask and rewritten 6942fe28f631SWaiman Long * by any subsequent write to workqueue/cpumask sysfs file. 6943fe28f631SWaiman Long */ 6944fe28f631SWaiman Long if (!cpumask_andnot(cpumask, wq_requested_unbound_cpumask, exclude_cpumask)) 6945fe28f631SWaiman Long cpumask_copy(cpumask, wq_requested_unbound_cpumask); 6946fe28f631SWaiman Long if (!cpumask_equal(cpumask, wq_unbound_cpumask)) 6947fe28f631SWaiman Long ret = workqueue_apply_unbound_cpumask(cpumask); 6948fe28f631SWaiman Long 694984165883SLai Jiangshan /* Save the current isolated cpumask & export it via sysfs */ 695084165883SLai Jiangshan if (!ret) 695184165883SLai Jiangshan cpumask_copy(wq_isolated_cpumask, exclude_cpumask); 695284165883SLai Jiangshan 6953fe28f631SWaiman Long mutex_unlock(&wq_pool_mutex); 6954fe28f631SWaiman Long free_cpumask_var(cpumask); 6955fe28f631SWaiman Long return ret; 6956fe28f631SWaiman Long } 6957fe28f631SWaiman Long 695863c5484eSTejun Heo static int parse_affn_scope(const char *val) 695963c5484eSTejun Heo { 696063c5484eSTejun Heo int i; 696163c5484eSTejun Heo 696263c5484eSTejun Heo for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) { 696363c5484eSTejun Heo if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i]))) 696463c5484eSTejun Heo return i; 696563c5484eSTejun Heo } 696663c5484eSTejun Heo return -EINVAL; 696763c5484eSTejun Heo } 696863c5484eSTejun Heo 696963c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp) 697063c5484eSTejun Heo { 6971523a301eSTejun Heo struct workqueue_struct *wq; 6972523a301eSTejun Heo int affn, cpu; 697363c5484eSTejun Heo 697463c5484eSTejun Heo affn = parse_affn_scope(val); 697563c5484eSTejun Heo if (affn < 0) 697663c5484eSTejun Heo return affn; 6977523a301eSTejun Heo if (affn == WQ_AFFN_DFL) 6978523a301eSTejun Heo return -EINVAL; 6979523a301eSTejun Heo 6980523a301eSTejun Heo cpus_read_lock(); 6981523a301eSTejun Heo mutex_lock(&wq_pool_mutex); 698263c5484eSTejun Heo 698363c5484eSTejun Heo wq_affn_dfl = affn; 6984523a301eSTejun Heo 6985523a301eSTejun Heo list_for_each_entry(wq, &workqueues, list) { 6986b2b1f933SLai Jiangshan for_each_online_cpu(cpu) 6987b2b1f933SLai Jiangshan unbound_wq_update_pwq(wq, cpu); 6988523a301eSTejun Heo } 6989523a301eSTejun Heo 6990523a301eSTejun Heo mutex_unlock(&wq_pool_mutex); 6991523a301eSTejun Heo cpus_read_unlock(); 6992523a301eSTejun Heo 699363c5484eSTejun Heo return 0; 699463c5484eSTejun Heo } 699563c5484eSTejun Heo 699663c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp) 699763c5484eSTejun Heo { 699863c5484eSTejun Heo return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]); 699963c5484eSTejun Heo } 700063c5484eSTejun Heo 700163c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = { 700263c5484eSTejun Heo .set = wq_affn_dfl_set, 700363c5484eSTejun Heo .get = wq_affn_dfl_get, 700463c5484eSTejun Heo }; 700563c5484eSTejun Heo 700663c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644); 700763c5484eSTejun Heo 70086ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS 70096ba94429SFrederic Weisbecker /* 70106ba94429SFrederic Weisbecker * Workqueues with WQ_SYSFS flag set is visible to userland via 70116ba94429SFrederic Weisbecker * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 70126ba94429SFrederic Weisbecker * following attributes. 70136ba94429SFrederic Weisbecker * 70146ba94429SFrederic Weisbecker * per_cpu RO bool : whether the workqueue is per-cpu or unbound 70156ba94429SFrederic Weisbecker * max_active RW int : maximum number of in-flight work items 70166ba94429SFrederic Weisbecker * 70176ba94429SFrederic Weisbecker * Unbound workqueues have the following extra attributes. 70186ba94429SFrederic Weisbecker * 70196ba94429SFrederic Weisbecker * nice RW int : nice value of the workers 70206ba94429SFrederic Weisbecker * cpumask RW mask : bitmask of allowed CPUs for the workers 702163c5484eSTejun Heo * affinity_scope RW str : worker CPU affinity scope (cache, numa, none) 70228639ecebSTejun Heo * affinity_strict RW bool : worker CPU affinity is strict 70236ba94429SFrederic Weisbecker */ 70246ba94429SFrederic Weisbecker struct wq_device { 70256ba94429SFrederic Weisbecker struct workqueue_struct *wq; 70266ba94429SFrederic Weisbecker struct device dev; 70276ba94429SFrederic Weisbecker }; 70286ba94429SFrederic Weisbecker 70296ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev) 70306ba94429SFrederic Weisbecker { 70316ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 70326ba94429SFrederic Weisbecker 70336ba94429SFrederic Weisbecker return wq_dev->wq; 70346ba94429SFrederic Weisbecker } 70356ba94429SFrederic Weisbecker 70366ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, 70376ba94429SFrederic Weisbecker char *buf) 70386ba94429SFrederic Weisbecker { 70396ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 70406ba94429SFrederic Weisbecker 70416ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 70426ba94429SFrederic Weisbecker } 70436ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu); 70446ba94429SFrederic Weisbecker 70456ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev, 70466ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 70476ba94429SFrederic Weisbecker { 70486ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 70496ba94429SFrederic Weisbecker 70506ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 70516ba94429SFrederic Weisbecker } 70526ba94429SFrederic Weisbecker 70536ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev, 70546ba94429SFrederic Weisbecker struct device_attribute *attr, const char *buf, 70556ba94429SFrederic Weisbecker size_t count) 70566ba94429SFrederic Weisbecker { 70576ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 70586ba94429SFrederic Weisbecker int val; 70596ba94429SFrederic Weisbecker 70606ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &val) != 1 || val <= 0) 70616ba94429SFrederic Weisbecker return -EINVAL; 70626ba94429SFrederic Weisbecker 70636ba94429SFrederic Weisbecker workqueue_set_max_active(wq, val); 70646ba94429SFrederic Weisbecker return count; 70656ba94429SFrederic Weisbecker } 70666ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active); 70676ba94429SFrederic Weisbecker 70686ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = { 70696ba94429SFrederic Weisbecker &dev_attr_per_cpu.attr, 70706ba94429SFrederic Weisbecker &dev_attr_max_active.attr, 70716ba94429SFrederic Weisbecker NULL, 70726ba94429SFrederic Weisbecker }; 70736ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs); 70746ba94429SFrederic Weisbecker 70756ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 70766ba94429SFrederic Weisbecker char *buf) 70776ba94429SFrederic Weisbecker { 70786ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 70796ba94429SFrederic Weisbecker int written; 70806ba94429SFrederic Weisbecker 70816ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 70826ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); 70836ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 70846ba94429SFrederic Weisbecker 70856ba94429SFrederic Weisbecker return written; 70866ba94429SFrederic Weisbecker } 70876ba94429SFrederic Weisbecker 70886ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */ 70896ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 70906ba94429SFrederic Weisbecker { 70916ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 70926ba94429SFrederic Weisbecker 7093899a94feSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 7094899a94feSLai Jiangshan 7095be69d00dSThomas Gleixner attrs = alloc_workqueue_attrs(); 70966ba94429SFrederic Weisbecker if (!attrs) 70976ba94429SFrederic Weisbecker return NULL; 70986ba94429SFrederic Weisbecker 70996ba94429SFrederic Weisbecker copy_workqueue_attrs(attrs, wq->unbound_attrs); 71006ba94429SFrederic Weisbecker return attrs; 71016ba94429SFrederic Weisbecker } 71026ba94429SFrederic Weisbecker 71036ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 71046ba94429SFrederic Weisbecker const char *buf, size_t count) 71056ba94429SFrederic Weisbecker { 71066ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 71076ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 7108d4d3e257SLai Jiangshan int ret = -ENOMEM; 7109d4d3e257SLai Jiangshan 7110d4d3e257SLai Jiangshan apply_wqattrs_lock(); 71116ba94429SFrederic Weisbecker 71126ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 71136ba94429SFrederic Weisbecker if (!attrs) 7114d4d3e257SLai Jiangshan goto out_unlock; 71156ba94429SFrederic Weisbecker 71166ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &attrs->nice) == 1 && 71176ba94429SFrederic Weisbecker attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) 7118d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 71196ba94429SFrederic Weisbecker else 71206ba94429SFrederic Weisbecker ret = -EINVAL; 71216ba94429SFrederic Weisbecker 7122d4d3e257SLai Jiangshan out_unlock: 7123d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 71246ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 71256ba94429SFrederic Weisbecker return ret ?: count; 71266ba94429SFrederic Weisbecker } 71276ba94429SFrederic Weisbecker 71286ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev, 71296ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 71306ba94429SFrederic Weisbecker { 71316ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 71326ba94429SFrederic Weisbecker int written; 71336ba94429SFrederic Weisbecker 71346ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 71356ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 71366ba94429SFrederic Weisbecker cpumask_pr_args(wq->unbound_attrs->cpumask)); 71376ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 71386ba94429SFrederic Weisbecker return written; 71396ba94429SFrederic Weisbecker } 71406ba94429SFrederic Weisbecker 71416ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev, 71426ba94429SFrederic Weisbecker struct device_attribute *attr, 71436ba94429SFrederic Weisbecker const char *buf, size_t count) 71446ba94429SFrederic Weisbecker { 71456ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 71466ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 7147d4d3e257SLai Jiangshan int ret = -ENOMEM; 7148d4d3e257SLai Jiangshan 7149d4d3e257SLai Jiangshan apply_wqattrs_lock(); 71506ba94429SFrederic Weisbecker 71516ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 71526ba94429SFrederic Weisbecker if (!attrs) 7153d4d3e257SLai Jiangshan goto out_unlock; 71546ba94429SFrederic Weisbecker 71556ba94429SFrederic Weisbecker ret = cpumask_parse(buf, attrs->cpumask); 71566ba94429SFrederic Weisbecker if (!ret) 7157d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 71586ba94429SFrederic Weisbecker 7159d4d3e257SLai Jiangshan out_unlock: 7160d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 71616ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 71626ba94429SFrederic Weisbecker return ret ?: count; 71636ba94429SFrederic Weisbecker } 71646ba94429SFrederic Weisbecker 716563c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev, 716663c5484eSTejun Heo struct device_attribute *attr, char *buf) 716763c5484eSTejun Heo { 716863c5484eSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 716963c5484eSTejun Heo int written; 717063c5484eSTejun Heo 717163c5484eSTejun Heo mutex_lock(&wq->mutex); 7172523a301eSTejun Heo if (wq->unbound_attrs->affn_scope == WQ_AFFN_DFL) 7173523a301eSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%s (%s)\n", 7174523a301eSTejun Heo wq_affn_names[WQ_AFFN_DFL], 7175523a301eSTejun Heo wq_affn_names[wq_affn_dfl]); 7176523a301eSTejun Heo else 717763c5484eSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%s\n", 717863c5484eSTejun Heo wq_affn_names[wq->unbound_attrs->affn_scope]); 717963c5484eSTejun Heo mutex_unlock(&wq->mutex); 718063c5484eSTejun Heo 718163c5484eSTejun Heo return written; 718263c5484eSTejun Heo } 718363c5484eSTejun Heo 718463c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev, 718563c5484eSTejun Heo struct device_attribute *attr, 718663c5484eSTejun Heo const char *buf, size_t count) 718763c5484eSTejun Heo { 718863c5484eSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 718963c5484eSTejun Heo struct workqueue_attrs *attrs; 719063c5484eSTejun Heo int affn, ret = -ENOMEM; 719163c5484eSTejun Heo 719263c5484eSTejun Heo affn = parse_affn_scope(buf); 719363c5484eSTejun Heo if (affn < 0) 719463c5484eSTejun Heo return affn; 719563c5484eSTejun Heo 719663c5484eSTejun Heo apply_wqattrs_lock(); 719763c5484eSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 719863c5484eSTejun Heo if (attrs) { 719963c5484eSTejun Heo attrs->affn_scope = affn; 720063c5484eSTejun Heo ret = apply_workqueue_attrs_locked(wq, attrs); 720163c5484eSTejun Heo } 720263c5484eSTejun Heo apply_wqattrs_unlock(); 720363c5484eSTejun Heo free_workqueue_attrs(attrs); 720463c5484eSTejun Heo return ret ?: count; 720563c5484eSTejun Heo } 720663c5484eSTejun Heo 72078639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev, 72088639ecebSTejun Heo struct device_attribute *attr, char *buf) 72098639ecebSTejun Heo { 72108639ecebSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 72118639ecebSTejun Heo 72128639ecebSTejun Heo return scnprintf(buf, PAGE_SIZE, "%d\n", 72138639ecebSTejun Heo wq->unbound_attrs->affn_strict); 72148639ecebSTejun Heo } 72158639ecebSTejun Heo 72168639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev, 72178639ecebSTejun Heo struct device_attribute *attr, 72188639ecebSTejun Heo const char *buf, size_t count) 72198639ecebSTejun Heo { 72208639ecebSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 72218639ecebSTejun Heo struct workqueue_attrs *attrs; 72228639ecebSTejun Heo int v, ret = -ENOMEM; 72238639ecebSTejun Heo 72248639ecebSTejun Heo if (sscanf(buf, "%d", &v) != 1) 72258639ecebSTejun Heo return -EINVAL; 72268639ecebSTejun Heo 72278639ecebSTejun Heo apply_wqattrs_lock(); 72288639ecebSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 72298639ecebSTejun Heo if (attrs) { 72308639ecebSTejun Heo attrs->affn_strict = (bool)v; 72318639ecebSTejun Heo ret = apply_workqueue_attrs_locked(wq, attrs); 72328639ecebSTejun Heo } 72338639ecebSTejun Heo apply_wqattrs_unlock(); 72348639ecebSTejun Heo free_workqueue_attrs(attrs); 72358639ecebSTejun Heo return ret ?: count; 72368639ecebSTejun Heo } 72378639ecebSTejun Heo 72386ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = { 72396ba94429SFrederic Weisbecker __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 72406ba94429SFrederic Weisbecker __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 724163c5484eSTejun Heo __ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store), 72428639ecebSTejun Heo __ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store), 72436ba94429SFrederic Weisbecker __ATTR_NULL, 72446ba94429SFrederic Weisbecker }; 72456ba94429SFrederic Weisbecker 72465df9197eSRicardo B. Marliere static const struct bus_type wq_subsys = { 72476ba94429SFrederic Weisbecker .name = "workqueue", 72486ba94429SFrederic Weisbecker .dev_groups = wq_sysfs_groups, 72496ba94429SFrederic Weisbecker }; 72506ba94429SFrederic Weisbecker 725149277a5bSWaiman Long /** 725249277a5bSWaiman Long * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask 725349277a5bSWaiman Long * @cpumask: the cpumask to set 725449277a5bSWaiman Long * 725549277a5bSWaiman Long * The low-level workqueues cpumask is a global cpumask that limits 725649277a5bSWaiman Long * the affinity of all unbound workqueues. This function check the @cpumask 725749277a5bSWaiman Long * and apply it to all unbound workqueues and updates all pwqs of them. 725849277a5bSWaiman Long * 725949277a5bSWaiman Long * Return: 0 - Success 726049277a5bSWaiman Long * -EINVAL - Invalid @cpumask 726149277a5bSWaiman Long * -ENOMEM - Failed to allocate memory for attrs or pwqs. 726249277a5bSWaiman Long */ 726349277a5bSWaiman Long static int workqueue_set_unbound_cpumask(cpumask_var_t cpumask) 726449277a5bSWaiman Long { 726549277a5bSWaiman Long int ret = -EINVAL; 726649277a5bSWaiman Long 726749277a5bSWaiman Long /* 726849277a5bSWaiman Long * Not excluding isolated cpus on purpose. 726949277a5bSWaiman Long * If the user wishes to include them, we allow that. 727049277a5bSWaiman Long */ 727149277a5bSWaiman Long cpumask_and(cpumask, cpumask, cpu_possible_mask); 727249277a5bSWaiman Long if (!cpumask_empty(cpumask)) { 727349277a5bSWaiman Long ret = 0; 7274b3d20916SLai Jiangshan apply_wqattrs_lock(); 7275b3d20916SLai Jiangshan if (!cpumask_equal(cpumask, wq_unbound_cpumask)) 727649277a5bSWaiman Long ret = workqueue_apply_unbound_cpumask(cpumask); 727784165883SLai Jiangshan if (!ret) 727884165883SLai Jiangshan cpumask_copy(wq_requested_unbound_cpumask, cpumask); 727949277a5bSWaiman Long apply_wqattrs_unlock(); 728049277a5bSWaiman Long } 728149277a5bSWaiman Long 728249277a5bSWaiman Long return ret; 728349277a5bSWaiman Long } 728449277a5bSWaiman Long 7285fe28f631SWaiman Long static ssize_t __wq_cpumask_show(struct device *dev, 7286fe28f631SWaiman Long struct device_attribute *attr, char *buf, cpumask_var_t mask) 7287b05a7928SFrederic Weisbecker { 7288b05a7928SFrederic Weisbecker int written; 7289b05a7928SFrederic Weisbecker 7290042f7df1SLai Jiangshan mutex_lock(&wq_pool_mutex); 7291fe28f631SWaiman Long written = scnprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask)); 7292042f7df1SLai Jiangshan mutex_unlock(&wq_pool_mutex); 7293b05a7928SFrederic Weisbecker 7294b05a7928SFrederic Weisbecker return written; 7295b05a7928SFrederic Weisbecker } 7296b05a7928SFrederic Weisbecker 729779202591SDan Williams static ssize_t cpumask_requested_show(struct device *dev, 729879202591SDan Williams struct device_attribute *attr, char *buf) 729979202591SDan Williams { 730079202591SDan Williams return __wq_cpumask_show(dev, attr, buf, wq_requested_unbound_cpumask); 730179202591SDan Williams } 730279202591SDan Williams static DEVICE_ATTR_RO(cpumask_requested); 730379202591SDan Williams 730479202591SDan Williams static ssize_t cpumask_isolated_show(struct device *dev, 730579202591SDan Williams struct device_attribute *attr, char *buf) 730679202591SDan Williams { 730779202591SDan Williams return __wq_cpumask_show(dev, attr, buf, wq_isolated_cpumask); 730879202591SDan Williams } 730979202591SDan Williams static DEVICE_ATTR_RO(cpumask_isolated); 731079202591SDan Williams 731179202591SDan Williams static ssize_t cpumask_show(struct device *dev, 7312fe28f631SWaiman Long struct device_attribute *attr, char *buf) 7313fe28f631SWaiman Long { 7314fe28f631SWaiman Long return __wq_cpumask_show(dev, attr, buf, wq_unbound_cpumask); 7315fe28f631SWaiman Long } 7316fe28f631SWaiman Long 731779202591SDan Williams static ssize_t cpumask_store(struct device *dev, 7318042f7df1SLai Jiangshan struct device_attribute *attr, const char *buf, size_t count) 7319042f7df1SLai Jiangshan { 7320042f7df1SLai Jiangshan cpumask_var_t cpumask; 7321042f7df1SLai Jiangshan int ret; 7322042f7df1SLai Jiangshan 7323042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 7324042f7df1SLai Jiangshan return -ENOMEM; 7325042f7df1SLai Jiangshan 7326042f7df1SLai Jiangshan ret = cpumask_parse(buf, cpumask); 7327042f7df1SLai Jiangshan if (!ret) 7328042f7df1SLai Jiangshan ret = workqueue_set_unbound_cpumask(cpumask); 7329042f7df1SLai Jiangshan 7330042f7df1SLai Jiangshan free_cpumask_var(cpumask); 7331042f7df1SLai Jiangshan return ret ? ret : count; 7332042f7df1SLai Jiangshan } 733379202591SDan Williams static DEVICE_ATTR_RW(cpumask); 7334042f7df1SLai Jiangshan 733579202591SDan Williams static struct attribute *wq_sysfs_cpumask_attrs[] = { 733679202591SDan Williams &dev_attr_cpumask.attr, 733779202591SDan Williams &dev_attr_cpumask_requested.attr, 733879202591SDan Williams &dev_attr_cpumask_isolated.attr, 733979202591SDan Williams NULL, 7340fe28f631SWaiman Long }; 734179202591SDan Williams ATTRIBUTE_GROUPS(wq_sysfs_cpumask); 7342b05a7928SFrederic Weisbecker 73436ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void) 73446ba94429SFrederic Weisbecker { 734579202591SDan Williams return subsys_virtual_register(&wq_subsys, wq_sysfs_cpumask_groups); 73466ba94429SFrederic Weisbecker } 73476ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init); 73486ba94429SFrederic Weisbecker 73496ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev) 73506ba94429SFrederic Weisbecker { 73516ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 73526ba94429SFrederic Weisbecker 73536ba94429SFrederic Weisbecker kfree(wq_dev); 73546ba94429SFrederic Weisbecker } 73556ba94429SFrederic Weisbecker 73566ba94429SFrederic Weisbecker /** 73576ba94429SFrederic Weisbecker * workqueue_sysfs_register - make a workqueue visible in sysfs 73586ba94429SFrederic Weisbecker * @wq: the workqueue to register 73596ba94429SFrederic Weisbecker * 73606ba94429SFrederic Weisbecker * Expose @wq in sysfs under /sys/bus/workqueue/devices. 73616ba94429SFrederic Weisbecker * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 73626ba94429SFrederic Weisbecker * which is the preferred method. 73636ba94429SFrederic Weisbecker * 73646ba94429SFrederic Weisbecker * Workqueue user should use this function directly iff it wants to apply 73656ba94429SFrederic Weisbecker * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 73666ba94429SFrederic Weisbecker * apply_workqueue_attrs() may race against userland updating the 73676ba94429SFrederic Weisbecker * attributes. 73686ba94429SFrederic Weisbecker * 73696ba94429SFrederic Weisbecker * Return: 0 on success, -errno on failure. 73706ba94429SFrederic Weisbecker */ 73716ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq) 73726ba94429SFrederic Weisbecker { 73736ba94429SFrederic Weisbecker struct wq_device *wq_dev; 73746ba94429SFrederic Weisbecker int ret; 73756ba94429SFrederic Weisbecker 73766ba94429SFrederic Weisbecker /* 73774c065dbcSWaiman Long * Adjusting max_active breaks ordering guarantee. Disallow exposing 73784c065dbcSWaiman Long * ordered workqueues. 73796ba94429SFrederic Weisbecker */ 73803bc1e711STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 73816ba94429SFrederic Weisbecker return -EINVAL; 73826ba94429SFrederic Weisbecker 73836ba94429SFrederic Weisbecker wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 73846ba94429SFrederic Weisbecker if (!wq_dev) 73856ba94429SFrederic Weisbecker return -ENOMEM; 73866ba94429SFrederic Weisbecker 73876ba94429SFrederic Weisbecker wq_dev->wq = wq; 73886ba94429SFrederic Weisbecker wq_dev->dev.bus = &wq_subsys; 73896ba94429SFrederic Weisbecker wq_dev->dev.release = wq_device_release; 739023217b44SLars-Peter Clausen dev_set_name(&wq_dev->dev, "%s", wq->name); 73916ba94429SFrederic Weisbecker 73926ba94429SFrederic Weisbecker /* 73936ba94429SFrederic Weisbecker * unbound_attrs are created separately. Suppress uevent until 73946ba94429SFrederic Weisbecker * everything is ready. 73956ba94429SFrederic Weisbecker */ 73966ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, true); 73976ba94429SFrederic Weisbecker 73986ba94429SFrederic Weisbecker ret = device_register(&wq_dev->dev); 73996ba94429SFrederic Weisbecker if (ret) { 7400537f4146SArvind Yadav put_device(&wq_dev->dev); 74016ba94429SFrederic Weisbecker wq->wq_dev = NULL; 74026ba94429SFrederic Weisbecker return ret; 74036ba94429SFrederic Weisbecker } 74046ba94429SFrederic Weisbecker 74056ba94429SFrederic Weisbecker if (wq->flags & WQ_UNBOUND) { 74066ba94429SFrederic Weisbecker struct device_attribute *attr; 74076ba94429SFrederic Weisbecker 74086ba94429SFrederic Weisbecker for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 74096ba94429SFrederic Weisbecker ret = device_create_file(&wq_dev->dev, attr); 74106ba94429SFrederic Weisbecker if (ret) { 74116ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 74126ba94429SFrederic Weisbecker wq->wq_dev = NULL; 74136ba94429SFrederic Weisbecker return ret; 74146ba94429SFrederic Weisbecker } 74156ba94429SFrederic Weisbecker } 74166ba94429SFrederic Weisbecker } 74176ba94429SFrederic Weisbecker 74186ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, false); 74196ba94429SFrederic Weisbecker kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 74206ba94429SFrederic Weisbecker return 0; 74216ba94429SFrederic Weisbecker } 74226ba94429SFrederic Weisbecker 74236ba94429SFrederic Weisbecker /** 74246ba94429SFrederic Weisbecker * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 74256ba94429SFrederic Weisbecker * @wq: the workqueue to unregister 74266ba94429SFrederic Weisbecker * 74276ba94429SFrederic Weisbecker * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 74286ba94429SFrederic Weisbecker */ 74296ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 74306ba94429SFrederic Weisbecker { 74316ba94429SFrederic Weisbecker struct wq_device *wq_dev = wq->wq_dev; 74326ba94429SFrederic Weisbecker 74336ba94429SFrederic Weisbecker if (!wq->wq_dev) 74346ba94429SFrederic Weisbecker return; 74356ba94429SFrederic Weisbecker 74366ba94429SFrederic Weisbecker wq->wq_dev = NULL; 74376ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 74386ba94429SFrederic Weisbecker } 74396ba94429SFrederic Weisbecker #else /* CONFIG_SYSFS */ 74406ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 74416ba94429SFrederic Weisbecker #endif /* CONFIG_SYSFS */ 74426ba94429SFrederic Weisbecker 744382607adcSTejun Heo /* 744482607adcSTejun Heo * Workqueue watchdog. 744582607adcSTejun Heo * 744682607adcSTejun Heo * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal 744782607adcSTejun Heo * flush dependency, a concurrency managed work item which stays RUNNING 744882607adcSTejun Heo * indefinitely. Workqueue stalls can be very difficult to debug as the 744982607adcSTejun Heo * usual warning mechanisms don't trigger and internal workqueue state is 745082607adcSTejun Heo * largely opaque. 745182607adcSTejun Heo * 745282607adcSTejun Heo * Workqueue watchdog monitors all worker pools periodically and dumps 745382607adcSTejun Heo * state if some pools failed to make forward progress for a while where 745482607adcSTejun Heo * forward progress is defined as the first item on ->worklist changing. 745582607adcSTejun Heo * 745682607adcSTejun Heo * This mechanism is controlled through the kernel parameter 745782607adcSTejun Heo * "workqueue.watchdog_thresh" which can be updated at runtime through the 745882607adcSTejun Heo * corresponding sysfs parameter file. 745982607adcSTejun Heo */ 746082607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG 746182607adcSTejun Heo 746282607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30; 74635cd79d6aSKees Cook static struct timer_list wq_watchdog_timer; 746482607adcSTejun Heo 746582607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES; 746682607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES; 746782607adcSTejun Heo 7468073107b3SSangmoon Kim static unsigned int wq_panic_on_stall; 7469073107b3SSangmoon Kim module_param_named(panic_on_stall, wq_panic_on_stall, uint, 0644); 7470073107b3SSangmoon Kim 7471cd2440d6SPetr Mladek /* 7472cd2440d6SPetr Mladek * Show workers that might prevent the processing of pending work items. 7473cd2440d6SPetr Mladek * The only candidates are CPU-bound workers in the running state. 7474cd2440d6SPetr Mladek * Pending work items should be handled by another idle worker 7475cd2440d6SPetr Mladek * in all other situations. 7476cd2440d6SPetr Mladek */ 7477cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool) 7478cd2440d6SPetr Mladek { 7479cd2440d6SPetr Mladek struct worker *worker; 7480c26e2f2eSTejun Heo unsigned long irq_flags; 7481cd2440d6SPetr Mladek int bkt; 7482cd2440d6SPetr Mladek 7483c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pool->lock, irq_flags); 7484cd2440d6SPetr Mladek 7485cd2440d6SPetr Mladek hash_for_each(pool->busy_hash, bkt, worker, hentry) { 7486cd2440d6SPetr Mladek if (task_is_running(worker->task)) { 7487cd2440d6SPetr Mladek /* 7488cd2440d6SPetr Mladek * Defer printing to avoid deadlocks in console 7489cd2440d6SPetr Mladek * drivers that queue work while holding locks 7490cd2440d6SPetr Mladek * also taken in their write paths. 7491cd2440d6SPetr Mladek */ 7492cd2440d6SPetr Mladek printk_deferred_enter(); 7493cd2440d6SPetr Mladek 7494cd2440d6SPetr Mladek pr_info("pool %d:\n", pool->id); 7495cd2440d6SPetr Mladek sched_show_task(worker->task); 7496cd2440d6SPetr Mladek 7497cd2440d6SPetr Mladek printk_deferred_exit(); 7498cd2440d6SPetr Mladek } 7499cd2440d6SPetr Mladek } 7500cd2440d6SPetr Mladek 7501c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pool->lock, irq_flags); 7502cd2440d6SPetr Mladek } 7503cd2440d6SPetr Mladek 7504cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void) 7505cd2440d6SPetr Mladek { 7506cd2440d6SPetr Mladek struct worker_pool *pool; 7507cd2440d6SPetr Mladek int pi; 7508cd2440d6SPetr Mladek 7509cd2440d6SPetr Mladek pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n"); 7510cd2440d6SPetr Mladek 7511cd2440d6SPetr Mladek rcu_read_lock(); 7512cd2440d6SPetr Mladek 7513cd2440d6SPetr Mladek for_each_pool(pool, pi) { 7514cd2440d6SPetr Mladek if (pool->cpu_stall) 7515cd2440d6SPetr Mladek show_cpu_pool_hog(pool); 7516cd2440d6SPetr Mladek 7517cd2440d6SPetr Mladek } 7518cd2440d6SPetr Mladek 7519cd2440d6SPetr Mladek rcu_read_unlock(); 7520cd2440d6SPetr Mladek } 7521cd2440d6SPetr Mladek 7522073107b3SSangmoon Kim static void panic_on_wq_watchdog(void) 7523073107b3SSangmoon Kim { 7524073107b3SSangmoon Kim static unsigned int wq_stall; 7525073107b3SSangmoon Kim 7526073107b3SSangmoon Kim if (wq_panic_on_stall) { 7527073107b3SSangmoon Kim wq_stall++; 7528073107b3SSangmoon Kim BUG_ON(wq_stall >= wq_panic_on_stall); 7529073107b3SSangmoon Kim } 7530073107b3SSangmoon Kim } 7531073107b3SSangmoon Kim 753282607adcSTejun Heo static void wq_watchdog_reset_touched(void) 753382607adcSTejun Heo { 753482607adcSTejun Heo int cpu; 753582607adcSTejun Heo 753682607adcSTejun Heo wq_watchdog_touched = jiffies; 753782607adcSTejun Heo for_each_possible_cpu(cpu) 753882607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 753982607adcSTejun Heo } 754082607adcSTejun Heo 75415cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused) 754282607adcSTejun Heo { 754382607adcSTejun Heo unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; 754482607adcSTejun Heo bool lockup_detected = false; 7545cd2440d6SPetr Mladek bool cpu_pool_stall = false; 7546940d71c6SSergey Senozhatsky unsigned long now = jiffies; 754782607adcSTejun Heo struct worker_pool *pool; 754882607adcSTejun Heo int pi; 754982607adcSTejun Heo 755082607adcSTejun Heo if (!thresh) 755182607adcSTejun Heo return; 755282607adcSTejun Heo 755382607adcSTejun Heo rcu_read_lock(); 755482607adcSTejun Heo 755582607adcSTejun Heo for_each_pool(pool, pi) { 755682607adcSTejun Heo unsigned long pool_ts, touched, ts; 755782607adcSTejun Heo 7558cd2440d6SPetr Mladek pool->cpu_stall = false; 755982607adcSTejun Heo if (list_empty(&pool->worklist)) 756082607adcSTejun Heo continue; 756182607adcSTejun Heo 7562940d71c6SSergey Senozhatsky /* 7563940d71c6SSergey Senozhatsky * If a virtual machine is stopped by the host it can look to 7564940d71c6SSergey Senozhatsky * the watchdog like a stall. 7565940d71c6SSergey Senozhatsky */ 7566940d71c6SSergey Senozhatsky kvm_check_and_clear_guest_paused(); 7567940d71c6SSergey Senozhatsky 756882607adcSTejun Heo /* get the latest of pool and touched timestamps */ 756989e28ce6SWang Qing if (pool->cpu >= 0) 757089e28ce6SWang Qing touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu)); 757189e28ce6SWang Qing else 757282607adcSTejun Heo touched = READ_ONCE(wq_watchdog_touched); 757389e28ce6SWang Qing pool_ts = READ_ONCE(pool->watchdog_ts); 757482607adcSTejun Heo 757582607adcSTejun Heo if (time_after(pool_ts, touched)) 757682607adcSTejun Heo ts = pool_ts; 757782607adcSTejun Heo else 757882607adcSTejun Heo ts = touched; 757982607adcSTejun Heo 758082607adcSTejun Heo /* did we stall? */ 7581940d71c6SSergey Senozhatsky if (time_after(now, ts + thresh)) { 758282607adcSTejun Heo lockup_detected = true; 75834cb1ef64STejun Heo if (pool->cpu >= 0 && !(pool->flags & POOL_BH)) { 7584cd2440d6SPetr Mladek pool->cpu_stall = true; 7585cd2440d6SPetr Mladek cpu_pool_stall = true; 7586cd2440d6SPetr Mladek } 758782607adcSTejun Heo pr_emerg("BUG: workqueue lockup - pool"); 758882607adcSTejun Heo pr_cont_pool_info(pool); 758982607adcSTejun Heo pr_cont(" stuck for %us!\n", 7590940d71c6SSergey Senozhatsky jiffies_to_msecs(now - pool_ts) / 1000); 759182607adcSTejun Heo } 7592cd2440d6SPetr Mladek 7593cd2440d6SPetr Mladek 759482607adcSTejun Heo } 759582607adcSTejun Heo 759682607adcSTejun Heo rcu_read_unlock(); 759782607adcSTejun Heo 759882607adcSTejun Heo if (lockup_detected) 759955df0933SImran Khan show_all_workqueues(); 760082607adcSTejun Heo 7601cd2440d6SPetr Mladek if (cpu_pool_stall) 7602cd2440d6SPetr Mladek show_cpu_pools_hogs(); 7603cd2440d6SPetr Mladek 7604073107b3SSangmoon Kim if (lockup_detected) 7605073107b3SSangmoon Kim panic_on_wq_watchdog(); 7606073107b3SSangmoon Kim 760782607adcSTejun Heo wq_watchdog_reset_touched(); 760882607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh); 760982607adcSTejun Heo } 761082607adcSTejun Heo 7611cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu) 761282607adcSTejun Heo { 761398f887f8SNicholas Piggin unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; 761498f887f8SNicholas Piggin unsigned long touch_ts = READ_ONCE(wq_watchdog_touched); 761598f887f8SNicholas Piggin unsigned long now = jiffies; 761689e28ce6SWang Qing 761782607adcSTejun Heo if (cpu >= 0) 761898f887f8SNicholas Piggin per_cpu(wq_watchdog_touched_cpu, cpu) = now; 761918e24debSNicholas Piggin else 762018e24debSNicholas Piggin WARN_ONCE(1, "%s should be called with valid CPU", __func__); 762182607adcSTejun Heo 762298f887f8SNicholas Piggin /* Don't unnecessarily store to global cacheline */ 762398f887f8SNicholas Piggin if (time_after(now, touch_ts + thresh / 4)) 762498f887f8SNicholas Piggin WRITE_ONCE(wq_watchdog_touched, jiffies); 762582607adcSTejun Heo } 762682607adcSTejun Heo 762782607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh) 762882607adcSTejun Heo { 762982607adcSTejun Heo wq_watchdog_thresh = 0; 763082607adcSTejun Heo del_timer_sync(&wq_watchdog_timer); 763182607adcSTejun Heo 763282607adcSTejun Heo if (thresh) { 763382607adcSTejun Heo wq_watchdog_thresh = thresh; 763482607adcSTejun Heo wq_watchdog_reset_touched(); 763582607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ); 763682607adcSTejun Heo } 763782607adcSTejun Heo } 763882607adcSTejun Heo 763982607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val, 764082607adcSTejun Heo const struct kernel_param *kp) 764182607adcSTejun Heo { 764282607adcSTejun Heo unsigned long thresh; 764382607adcSTejun Heo int ret; 764482607adcSTejun Heo 764582607adcSTejun Heo ret = kstrtoul(val, 0, &thresh); 764682607adcSTejun Heo if (ret) 764782607adcSTejun Heo return ret; 764882607adcSTejun Heo 764982607adcSTejun Heo if (system_wq) 765082607adcSTejun Heo wq_watchdog_set_thresh(thresh); 765182607adcSTejun Heo else 765282607adcSTejun Heo wq_watchdog_thresh = thresh; 765382607adcSTejun Heo 765482607adcSTejun Heo return 0; 765582607adcSTejun Heo } 765682607adcSTejun Heo 765782607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = { 765882607adcSTejun Heo .set = wq_watchdog_param_set_thresh, 765982607adcSTejun Heo .get = param_get_ulong, 766082607adcSTejun Heo }; 766182607adcSTejun Heo 766282607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh, 766382607adcSTejun Heo 0644); 766482607adcSTejun Heo 766582607adcSTejun Heo static void wq_watchdog_init(void) 766682607adcSTejun Heo { 76675cd79d6aSKees Cook timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE); 766882607adcSTejun Heo wq_watchdog_set_thresh(wq_watchdog_thresh); 766982607adcSTejun Heo } 767082607adcSTejun Heo 767182607adcSTejun Heo #else /* CONFIG_WQ_WATCHDOG */ 767282607adcSTejun Heo 767382607adcSTejun Heo static inline void wq_watchdog_init(void) { } 767482607adcSTejun Heo 767582607adcSTejun Heo #endif /* CONFIG_WQ_WATCHDOG */ 767682607adcSTejun Heo 76772f34d733STejun Heo static void bh_pool_kick_normal(struct irq_work *irq_work) 76782f34d733STejun Heo { 76792f34d733STejun Heo raise_softirq_irqoff(TASKLET_SOFTIRQ); 76802f34d733STejun Heo } 76812f34d733STejun Heo 76822f34d733STejun Heo static void bh_pool_kick_highpri(struct irq_work *irq_work) 76832f34d733STejun Heo { 76842f34d733STejun Heo raise_softirq_irqoff(HI_SOFTIRQ); 76852f34d733STejun Heo } 76862f34d733STejun Heo 76874a6c5607STejun Heo static void __init restrict_unbound_cpumask(const char *name, const struct cpumask *mask) 76884a6c5607STejun Heo { 76894a6c5607STejun Heo if (!cpumask_intersects(wq_unbound_cpumask, mask)) { 76904a6c5607STejun Heo pr_warn("workqueue: Restricting unbound_cpumask (%*pb) with %s (%*pb) leaves no CPU, ignoring\n", 76914a6c5607STejun Heo cpumask_pr_args(wq_unbound_cpumask), name, cpumask_pr_args(mask)); 76924a6c5607STejun Heo return; 76934a6c5607STejun Heo } 76944a6c5607STejun Heo 76954a6c5607STejun Heo cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, mask); 76964a6c5607STejun Heo } 76974a6c5607STejun Heo 76982fcdb1b4STejun Heo static void __init init_cpu_worker_pool(struct worker_pool *pool, int cpu, int nice) 76992fcdb1b4STejun Heo { 77002fcdb1b4STejun Heo BUG_ON(init_worker_pool(pool)); 77012fcdb1b4STejun Heo pool->cpu = cpu; 77022fcdb1b4STejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 77032fcdb1b4STejun Heo cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu)); 77042fcdb1b4STejun Heo pool->attrs->nice = nice; 77052fcdb1b4STejun Heo pool->attrs->affn_strict = true; 77062fcdb1b4STejun Heo pool->node = cpu_to_node(cpu); 77072fcdb1b4STejun Heo 77082fcdb1b4STejun Heo /* alloc pool ID */ 77092fcdb1b4STejun Heo mutex_lock(&wq_pool_mutex); 77102fcdb1b4STejun Heo BUG_ON(worker_pool_assign_id(pool)); 77112fcdb1b4STejun Heo mutex_unlock(&wq_pool_mutex); 77122fcdb1b4STejun Heo } 77132fcdb1b4STejun Heo 77143347fa09STejun Heo /** 77153347fa09STejun Heo * workqueue_init_early - early init for workqueue subsystem 77163347fa09STejun Heo * 77172930155bSTejun Heo * This is the first step of three-staged workqueue subsystem initialization and 77182930155bSTejun Heo * invoked as soon as the bare basics - memory allocation, cpumasks and idr are 77192930155bSTejun Heo * up. It sets up all the data structures and system workqueues and allows early 77202930155bSTejun Heo * boot code to create workqueues and queue/cancel work items. Actual work item 77212930155bSTejun Heo * execution starts only after kthreads can be created and scheduled right 77222930155bSTejun Heo * before early initcalls. 77233347fa09STejun Heo */ 77242333e829SYu Chen void __init workqueue_init_early(void) 77251da177e4SLinus Torvalds { 772684193c07STejun Heo struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM]; 77277a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 77282f34d733STejun Heo void (*irq_work_fns[2])(struct irq_work *) = { bh_pool_kick_normal, 77292f34d733STejun Heo bh_pool_kick_highpri }; 77307a4e344cSTejun Heo int i, cpu; 7731c34056a3STejun Heo 773210cdb157SLai Jiangshan BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 7733e904e6c2STejun Heo 77348d84baf7SLai Jiangshan BUG_ON(!alloc_cpumask_var(&wq_online_cpumask, GFP_KERNEL)); 7735b05a7928SFrederic Weisbecker BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL)); 7736fe28f631SWaiman Long BUG_ON(!alloc_cpumask_var(&wq_requested_unbound_cpumask, GFP_KERNEL)); 7737fe28f631SWaiman Long BUG_ON(!zalloc_cpumask_var(&wq_isolated_cpumask, GFP_KERNEL)); 7738b05a7928SFrederic Weisbecker 77398d84baf7SLai Jiangshan cpumask_copy(wq_online_cpumask, cpu_online_mask); 77404a6c5607STejun Heo cpumask_copy(wq_unbound_cpumask, cpu_possible_mask); 77414a6c5607STejun Heo restrict_unbound_cpumask("HK_TYPE_WQ", housekeeping_cpumask(HK_TYPE_WQ)); 77424a6c5607STejun Heo restrict_unbound_cpumask("HK_TYPE_DOMAIN", housekeeping_cpumask(HK_TYPE_DOMAIN)); 7743ace3c549Stiozhang if (!cpumask_empty(&wq_cmdline_cpumask)) 77444a6c5607STejun Heo restrict_unbound_cpumask("workqueue.unbound_cpus", &wq_cmdline_cpumask); 7745ace3c549Stiozhang 7746fe28f631SWaiman Long cpumask_copy(wq_requested_unbound_cpumask, wq_unbound_cpumask); 77478b03ae3cSTejun Heo 77488b03ae3cSTejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 7749e22bee78STejun Heo 7750b2b1f933SLai Jiangshan unbound_wq_update_pwq_attrs_buf = alloc_workqueue_attrs(); 7751b2b1f933SLai Jiangshan BUG_ON(!unbound_wq_update_pwq_attrs_buf); 77522930155bSTejun Heo 77537bd20b6bSMarcelo Tosatti /* 77547bd20b6bSMarcelo Tosatti * If nohz_full is enabled, set power efficient workqueue as unbound. 77557bd20b6bSMarcelo Tosatti * This allows workqueue items to be moved to HK CPUs. 77567bd20b6bSMarcelo Tosatti */ 77577bd20b6bSMarcelo Tosatti if (housekeeping_enabled(HK_TYPE_TICK)) 77587bd20b6bSMarcelo Tosatti wq_power_efficient = true; 77597bd20b6bSMarcelo Tosatti 776084193c07STejun Heo /* initialize WQ_AFFN_SYSTEM pods */ 776184193c07STejun Heo pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL); 776284193c07STejun Heo pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL); 776384193c07STejun Heo pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL); 776484193c07STejun Heo BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod); 776584193c07STejun Heo 776684193c07STejun Heo BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE)); 776784193c07STejun Heo 776884193c07STejun Heo pt->nr_pods = 1; 776984193c07STejun Heo cpumask_copy(pt->pod_cpus[0], cpu_possible_mask); 777084193c07STejun Heo pt->pod_node[0] = NUMA_NO_NODE; 777184193c07STejun Heo pt->cpu_pod[0] = 0; 777284193c07STejun Heo 77734cb1ef64STejun Heo /* initialize BH and CPU pools */ 77741da177e4SLinus Torvalds for_each_possible_cpu(cpu) { 77751da177e4SLinus Torvalds struct worker_pool *pool; 77761da177e4SLinus Torvalds 77771da177e4SLinus Torvalds i = 0; 77784cb1ef64STejun Heo for_each_bh_worker_pool(pool, cpu) { 77792f34d733STejun Heo init_cpu_worker_pool(pool, cpu, std_nice[i]); 77804cb1ef64STejun Heo pool->flags |= POOL_BH; 77812f34d733STejun Heo init_irq_work(bh_pool_irq_work(pool), irq_work_fns[i]); 77822f34d733STejun Heo i++; 77834cb1ef64STejun Heo } 77844cb1ef64STejun Heo 77854cb1ef64STejun Heo i = 0; 77862fcdb1b4STejun Heo for_each_cpu_worker_pool(pool, cpu) 77872fcdb1b4STejun Heo init_cpu_worker_pool(pool, cpu, std_nice[i++]); 77881da177e4SLinus Torvalds } 77891da177e4SLinus Torvalds 77908a2b7538STejun Heo /* create default unbound and ordered wq attrs */ 779129c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 779229c91e99STejun Heo struct workqueue_attrs *attrs; 779329c91e99STejun Heo 7794be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 779529c91e99STejun Heo attrs->nice = std_nice[i]; 779629c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 77978a2b7538STejun Heo 77988a2b7538STejun Heo /* 77998a2b7538STejun Heo * An ordered wq should have only one pwq as ordering is 78008a2b7538STejun Heo * guaranteed by max_active which is enforced by pwqs. 78018a2b7538STejun Heo */ 7802be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 78038a2b7538STejun Heo attrs->nice = std_nice[i]; 7804af73f5c9STejun Heo attrs->ordered = true; 78058a2b7538STejun Heo ordered_wq_attrs[i] = attrs; 780629c91e99STejun Heo } 780729c91e99STejun Heo 7808d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 78091aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 7810d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 7811f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 7812636b927eSTejun Heo WQ_MAX_ACTIVE); 781324d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 781424d51addSTejun Heo WQ_FREEZABLE, 0); 78150668106cSViresh Kumar system_power_efficient_wq = alloc_workqueue("events_power_efficient", 78160668106cSViresh Kumar WQ_POWER_EFFICIENT, 0); 78178318d6a6SAudra Mitchell system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_pwr_efficient", 78180668106cSViresh Kumar WQ_FREEZABLE | WQ_POWER_EFFICIENT, 78190668106cSViresh Kumar 0); 78204cb1ef64STejun Heo system_bh_wq = alloc_workqueue("events_bh", WQ_BH, 0); 78214cb1ef64STejun Heo system_bh_highpri_wq = alloc_workqueue("events_bh_highpri", 78224cb1ef64STejun Heo WQ_BH | WQ_HIGHPRI, 0); 78231aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 78240668106cSViresh Kumar !system_unbound_wq || !system_freezable_wq || 78250668106cSViresh Kumar !system_power_efficient_wq || 78264cb1ef64STejun Heo !system_freezable_power_efficient_wq || 78274cb1ef64STejun Heo !system_bh_wq || !system_bh_highpri_wq); 78283347fa09STejun Heo } 78293347fa09STejun Heo 7830aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void) 7831aa6fde93STejun Heo { 7832aa6fde93STejun Heo unsigned long thresh; 7833aa6fde93STejun Heo unsigned long bogo; 7834aa6fde93STejun Heo 7835dd64c873SZqiang pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release"); 7836dd64c873SZqiang BUG_ON(IS_ERR(pwq_release_worker)); 7837dd64c873SZqiang 7838aa6fde93STejun Heo /* if the user set it to a specific value, keep it */ 7839aa6fde93STejun Heo if (wq_cpu_intensive_thresh_us != ULONG_MAX) 7840aa6fde93STejun Heo return; 7841aa6fde93STejun Heo 7842aa6fde93STejun Heo /* 7843aa6fde93STejun Heo * The default of 10ms is derived from the fact that most modern (as of 7844aa6fde93STejun Heo * 2023) processors can do a lot in 10ms and that it's just below what 7845aa6fde93STejun Heo * most consider human-perceivable. However, the kernel also runs on a 7846aa6fde93STejun Heo * lot slower CPUs including microcontrollers where the threshold is way 7847aa6fde93STejun Heo * too low. 7848aa6fde93STejun Heo * 7849aa6fde93STejun Heo * Let's scale up the threshold upto 1 second if BogoMips is below 4000. 7850aa6fde93STejun Heo * This is by no means accurate but it doesn't have to be. The mechanism 7851aa6fde93STejun Heo * is still useful even when the threshold is fully scaled up. Also, as 7852aa6fde93STejun Heo * the reports would usually be applicable to everyone, some machines 7853aa6fde93STejun Heo * operating on longer thresholds won't significantly diminish their 7854aa6fde93STejun Heo * usefulness. 7855aa6fde93STejun Heo */ 7856aa6fde93STejun Heo thresh = 10 * USEC_PER_MSEC; 7857aa6fde93STejun Heo 7858aa6fde93STejun Heo /* see init/calibrate.c for lpj -> BogoMIPS calculation */ 7859aa6fde93STejun Heo bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1); 7860aa6fde93STejun Heo if (bogo < 4000) 7861aa6fde93STejun Heo thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC); 7862aa6fde93STejun Heo 7863aa6fde93STejun Heo pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n", 7864aa6fde93STejun Heo loops_per_jiffy, bogo, thresh); 7865aa6fde93STejun Heo 7866aa6fde93STejun Heo wq_cpu_intensive_thresh_us = thresh; 7867aa6fde93STejun Heo } 7868aa6fde93STejun Heo 78693347fa09STejun Heo /** 78703347fa09STejun Heo * workqueue_init - bring workqueue subsystem fully online 78713347fa09STejun Heo * 78722930155bSTejun Heo * This is the second step of three-staged workqueue subsystem initialization 78732930155bSTejun Heo * and invoked as soon as kthreads can be created and scheduled. Workqueues have 78742930155bSTejun Heo * been created and work items queued on them, but there are no kworkers 78752930155bSTejun Heo * executing the work items yet. Populate the worker pools with the initial 78762930155bSTejun Heo * workers and enable future kworker creations. 78773347fa09STejun Heo */ 78782333e829SYu Chen void __init workqueue_init(void) 78793347fa09STejun Heo { 78802186d9f9STejun Heo struct workqueue_struct *wq; 78813347fa09STejun Heo struct worker_pool *pool; 78823347fa09STejun Heo int cpu, bkt; 78833347fa09STejun Heo 7884aa6fde93STejun Heo wq_cpu_intensive_thresh_init(); 7885aa6fde93STejun Heo 78862186d9f9STejun Heo mutex_lock(&wq_pool_mutex); 78872186d9f9STejun Heo 78882930155bSTejun Heo /* 78892930155bSTejun Heo * Per-cpu pools created earlier could be missing node hint. Fix them 78902930155bSTejun Heo * up. Also, create a rescuer for workqueues that requested it. 78912930155bSTejun Heo */ 78922186d9f9STejun Heo for_each_possible_cpu(cpu) { 78934cb1ef64STejun Heo for_each_bh_worker_pool(pool, cpu) 78942186d9f9STejun Heo pool->node = cpu_to_node(cpu); 78954cb1ef64STejun Heo for_each_cpu_worker_pool(pool, cpu) 78964cb1ef64STejun Heo pool->node = cpu_to_node(cpu); 78972186d9f9STejun Heo } 78982186d9f9STejun Heo 789940c17f75STejun Heo list_for_each_entry(wq, &workqueues, list) { 790040c17f75STejun Heo WARN(init_rescuer(wq), 790140c17f75STejun Heo "workqueue: failed to create early rescuer for %s", 790240c17f75STejun Heo wq->name); 790340c17f75STejun Heo } 79042186d9f9STejun Heo 79052186d9f9STejun Heo mutex_unlock(&wq_pool_mutex); 79062186d9f9STejun Heo 79074cb1ef64STejun Heo /* 79084cb1ef64STejun Heo * Create the initial workers. A BH pool has one pseudo worker that 79094cb1ef64STejun Heo * represents the shared BH execution context and thus doesn't get 79104cb1ef64STejun Heo * affected by hotplug events. Create the BH pseudo workers for all 79114cb1ef64STejun Heo * possible CPUs here. 79124cb1ef64STejun Heo */ 79134cb1ef64STejun Heo for_each_possible_cpu(cpu) 79144cb1ef64STejun Heo for_each_bh_worker_pool(pool, cpu) 79154cb1ef64STejun Heo BUG_ON(!create_worker(pool)); 79164cb1ef64STejun Heo 79173347fa09STejun Heo for_each_online_cpu(cpu) { 79183347fa09STejun Heo for_each_cpu_worker_pool(pool, cpu) { 79193347fa09STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 79203347fa09STejun Heo BUG_ON(!create_worker(pool)); 79213347fa09STejun Heo } 79223347fa09STejun Heo } 79233347fa09STejun Heo 79243347fa09STejun Heo hash_for_each(unbound_pool_hash, bkt, pool, hash_node) 79253347fa09STejun Heo BUG_ON(!create_worker(pool)); 79263347fa09STejun Heo 79273347fa09STejun Heo wq_online = true; 792882607adcSTejun Heo wq_watchdog_init(); 79291da177e4SLinus Torvalds } 7930c4f135d6STetsuo Handa 7931025e1684STejun Heo /* 7932025e1684STejun Heo * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to 7933025e1684STejun Heo * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique 7934025e1684STejun Heo * and consecutive pod ID. The rest of @pt is initialized accordingly. 7935025e1684STejun Heo */ 7936025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt, 7937025e1684STejun Heo bool (*cpus_share_pod)(int, int)) 7938025e1684STejun Heo { 7939025e1684STejun Heo int cur, pre, cpu, pod; 7940025e1684STejun Heo 7941025e1684STejun Heo pt->nr_pods = 0; 7942025e1684STejun Heo 7943025e1684STejun Heo /* init @pt->cpu_pod[] according to @cpus_share_pod() */ 7944025e1684STejun Heo pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL); 7945025e1684STejun Heo BUG_ON(!pt->cpu_pod); 7946025e1684STejun Heo 7947025e1684STejun Heo for_each_possible_cpu(cur) { 7948025e1684STejun Heo for_each_possible_cpu(pre) { 7949025e1684STejun Heo if (pre >= cur) { 7950025e1684STejun Heo pt->cpu_pod[cur] = pt->nr_pods++; 7951025e1684STejun Heo break; 7952025e1684STejun Heo } 7953025e1684STejun Heo if (cpus_share_pod(cur, pre)) { 7954025e1684STejun Heo pt->cpu_pod[cur] = pt->cpu_pod[pre]; 7955025e1684STejun Heo break; 7956025e1684STejun Heo } 7957025e1684STejun Heo } 7958025e1684STejun Heo } 7959025e1684STejun Heo 7960025e1684STejun Heo /* init the rest to match @pt->cpu_pod[] */ 7961025e1684STejun Heo pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL); 7962025e1684STejun Heo pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL); 7963025e1684STejun Heo BUG_ON(!pt->pod_cpus || !pt->pod_node); 7964025e1684STejun Heo 7965025e1684STejun Heo for (pod = 0; pod < pt->nr_pods; pod++) 7966025e1684STejun Heo BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL)); 7967025e1684STejun Heo 7968025e1684STejun Heo for_each_possible_cpu(cpu) { 7969025e1684STejun Heo cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]); 7970025e1684STejun Heo pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu); 7971025e1684STejun Heo } 7972025e1684STejun Heo } 7973025e1684STejun Heo 797463c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1) 797563c5484eSTejun Heo { 797663c5484eSTejun Heo return false; 797763c5484eSTejun Heo } 797863c5484eSTejun Heo 797963c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1) 798063c5484eSTejun Heo { 798163c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT 798263c5484eSTejun Heo return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1)); 798363c5484eSTejun Heo #else 798463c5484eSTejun Heo return false; 798563c5484eSTejun Heo #endif 798663c5484eSTejun Heo } 798763c5484eSTejun Heo 7988025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1) 7989025e1684STejun Heo { 7990025e1684STejun Heo return cpu_to_node(cpu0) == cpu_to_node(cpu1); 7991025e1684STejun Heo } 7992025e1684STejun Heo 79932930155bSTejun Heo /** 79942930155bSTejun Heo * workqueue_init_topology - initialize CPU pods for unbound workqueues 79952930155bSTejun Heo * 799696068b60SWang Jinchao * This is the third step of three-staged workqueue subsystem initialization and 79972930155bSTejun Heo * invoked after SMP and topology information are fully initialized. It 79982930155bSTejun Heo * initializes the unbound CPU pods accordingly. 79992930155bSTejun Heo */ 80002930155bSTejun Heo void __init workqueue_init_topology(void) 8001a86feae6STejun Heo { 80022930155bSTejun Heo struct workqueue_struct *wq; 8003025e1684STejun Heo int cpu; 8004a86feae6STejun Heo 800563c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share); 800663c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt); 800763c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache); 8008025e1684STejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa); 8009a86feae6STejun Heo 8010c5f8cd6cSTejun Heo wq_topo_initialized = true; 8011c5f8cd6cSTejun Heo 80122930155bSTejun Heo mutex_lock(&wq_pool_mutex); 8013a86feae6STejun Heo 8014a86feae6STejun Heo /* 80152930155bSTejun Heo * Workqueues allocated earlier would have all CPUs sharing the default 8016b2b1f933SLai Jiangshan * worker pool. Explicitly call unbound_wq_update_pwq() on all workqueue 8017b2b1f933SLai Jiangshan * and CPU combinations to apply per-pod sharing. 80182930155bSTejun Heo */ 80192930155bSTejun Heo list_for_each_entry(wq, &workqueues, list) { 80205797b1c1STejun Heo for_each_online_cpu(cpu) 8021b2b1f933SLai Jiangshan unbound_wq_update_pwq(wq, cpu); 80225797b1c1STejun Heo if (wq->flags & WQ_UNBOUND) { 80235797b1c1STejun Heo mutex_lock(&wq->mutex); 80245797b1c1STejun Heo wq_update_node_max_active(wq, -1); 80255797b1c1STejun Heo mutex_unlock(&wq->mutex); 80262930155bSTejun Heo } 80272930155bSTejun Heo } 80282930155bSTejun Heo 80292930155bSTejun Heo mutex_unlock(&wq_pool_mutex); 8030a86feae6STejun Heo } 8031a86feae6STejun Heo 803220bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void) 803320bdedafSTetsuo Handa { 803420bdedafSTetsuo Handa pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n"); 803520bdedafSTetsuo Handa dump_stack(); 803620bdedafSTetsuo Handa } 8037c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq); 8038ace3c549Stiozhang 8039ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str) 8040ace3c549Stiozhang { 8041ace3c549Stiozhang if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) { 8042ace3c549Stiozhang cpumask_clear(&wq_cmdline_cpumask); 8043ace3c549Stiozhang pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n"); 8044ace3c549Stiozhang } 8045ace3c549Stiozhang 8046ace3c549Stiozhang return 1; 8047ace3c549Stiozhang } 8048ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup); 8049