1457c8996SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 21da177e4SLinus Torvalds /* 3c54fce6eSTejun Heo * kernel/workqueue.c - generic async execution with shared worker pool 41da177e4SLinus Torvalds * 5c54fce6eSTejun Heo * Copyright (C) 2002 Ingo Molnar 61da177e4SLinus Torvalds * 71da177e4SLinus Torvalds * Derived from the taskqueue/keventd code by: 81da177e4SLinus Torvalds * David Woodhouse <[email protected]> 9e1f8e874SFrancois Cami * Andrew Morton 101da177e4SLinus Torvalds * Kai Petzke <[email protected]> 111da177e4SLinus Torvalds * Theodore Ts'o <[email protected]> 1289ada679SChristoph Lameter * 13cde53535SChristoph Lameter * Made to use alloc_percpu by Christoph Lameter. 14c54fce6eSTejun Heo * 15c54fce6eSTejun Heo * Copyright (C) 2010 SUSE Linux Products GmbH 16c54fce6eSTejun Heo * Copyright (C) 2010 Tejun Heo <[email protected]> 17c54fce6eSTejun Heo * 18c54fce6eSTejun Heo * This is the generic async execution mechanism. Work items as are 19c54fce6eSTejun Heo * executed in process context. The worker pool is shared and 20b11895c4SLibin * automatically managed. There are two worker pools for each CPU (one for 21b11895c4SLibin * normal work items and the other for high priority ones) and some extra 22b11895c4SLibin * pools for workqueues which are not bound to any specific CPU - the 23b11895c4SLibin * number of these backing pools is dynamic. 24c54fce6eSTejun Heo * 259a261491SBenjamin Peterson * Please read Documentation/core-api/workqueue.rst for details. 261da177e4SLinus Torvalds */ 271da177e4SLinus Torvalds 289984de1aSPaul Gortmaker #include <linux/export.h> 291da177e4SLinus Torvalds #include <linux/kernel.h> 301da177e4SLinus Torvalds #include <linux/sched.h> 311da177e4SLinus Torvalds #include <linux/init.h> 321da177e4SLinus Torvalds #include <linux/signal.h> 331da177e4SLinus Torvalds #include <linux/completion.h> 341da177e4SLinus Torvalds #include <linux/workqueue.h> 351da177e4SLinus Torvalds #include <linux/slab.h> 361da177e4SLinus Torvalds #include <linux/cpu.h> 371da177e4SLinus Torvalds #include <linux/notifier.h> 381da177e4SLinus Torvalds #include <linux/kthread.h> 391fa44ecaSJames Bottomley #include <linux/hardirq.h> 4046934023SChristoph Lameter #include <linux/mempolicy.h> 41341a5958SRafael J. Wysocki #include <linux/freezer.h> 42d5abe669SPeter Zijlstra #include <linux/debug_locks.h> 434e6045f1SJohannes Berg #include <linux/lockdep.h> 44c34056a3STejun Heo #include <linux/idr.h> 4529c91e99STejun Heo #include <linux/jhash.h> 4642f8570fSSasha Levin #include <linux/hashtable.h> 4776af4d93STejun Heo #include <linux/rculist.h> 48bce90380STejun Heo #include <linux/nodemask.h> 494c16bd32STejun Heo #include <linux/moduleparam.h> 503d1cb205STejun Heo #include <linux/uaccess.h> 51c98a9805STal Shorer #include <linux/sched/isolation.h> 5262635ea8SSergey Senozhatsky #include <linux/nmi.h> 53e22bee78STejun Heo 54ea138446STejun Heo #include "workqueue_internal.h" 551da177e4SLinus Torvalds 56c8e55f36STejun Heo enum { 57bc2ae0f5STejun Heo /* 5824647570STejun Heo * worker_pool flags 59bc2ae0f5STejun Heo * 6024647570STejun Heo * A bound pool is either associated or disassociated with its CPU. 61bc2ae0f5STejun Heo * While associated (!DISASSOCIATED), all workers are bound to the 62bc2ae0f5STejun Heo * CPU and none has %WORKER_UNBOUND set and concurrency management 63bc2ae0f5STejun Heo * is in effect. 64bc2ae0f5STejun Heo * 65bc2ae0f5STejun Heo * While DISASSOCIATED, the cpu may be offline and all workers have 66bc2ae0f5STejun Heo * %WORKER_UNBOUND set and concurrency management disabled, and may 6724647570STejun Heo * be executing on any CPU. The pool behaves as an unbound one. 68bc2ae0f5STejun Heo * 69bc3a1afcSTejun Heo * Note that DISASSOCIATED should be flipped only while holding 701258fae7STejun Heo * wq_pool_attach_mutex to avoid changing binding state while 714736cbf7SLai Jiangshan * worker_attach_to_pool() is in progress. 72bc2ae0f5STejun Heo */ 73692b4825STejun Heo POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */ 7424647570STejun Heo POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 75db7bccf4STejun Heo 76c8e55f36STejun Heo /* worker flags */ 77c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 78c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 79e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 80fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 81f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 82a9ab775bSTejun Heo WORKER_REBOUND = 1 << 8, /* worker was rebound */ 83e22bee78STejun Heo 84a9ab775bSTejun Heo WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE | 85a9ab775bSTejun Heo WORKER_UNBOUND | WORKER_REBOUND, 86db7bccf4STejun Heo 87e34cdddbSTejun Heo NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ 884ce62e9eSTejun Heo 8929c91e99STejun Heo UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ 90c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 91db7bccf4STejun Heo 92e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 93e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 94e22bee78STejun Heo 953233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 963233cdbdSTejun Heo /* call for help after 10ms 973233cdbdSTejun Heo (min two ticks) */ 98e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 99e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 1001da177e4SLinus Torvalds 1011da177e4SLinus Torvalds /* 102e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 1038698a745SDongsheng Yang * all cpus. Give MIN_NICE. 104e22bee78STejun Heo */ 1058698a745SDongsheng Yang RESCUER_NICE_LEVEL = MIN_NICE, 1068698a745SDongsheng Yang HIGHPRI_NICE_LEVEL = MIN_NICE, 107ecf6881fSTejun Heo 108ecf6881fSTejun Heo WQ_NAME_LEN = 24, 109c8e55f36STejun Heo }; 110c8e55f36STejun Heo 1111da177e4SLinus Torvalds /* 1124690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1134690c4abSTejun Heo * 114e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 115e41e704bSTejun Heo * everyone else. 1164690c4abSTejun Heo * 117e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 118e22bee78STejun Heo * only be modified and accessed from the local cpu. 119e22bee78STejun Heo * 120d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1214690c4abSTejun Heo * 122d565ed63STejun Heo * X: During normal operation, modification requires pool->lock and should 123d565ed63STejun Heo * be done only from local cpu. Either disabling preemption on local 124d565ed63STejun Heo * cpu or grabbing pool->lock is enough for read access. If 125d565ed63STejun Heo * POOL_DISASSOCIATED is set, it's identical to L. 126e22bee78STejun Heo * 1271258fae7STejun Heo * A: wq_pool_attach_mutex protected. 128822d8405STejun Heo * 12968e13a67SLai Jiangshan * PL: wq_pool_mutex protected. 13076af4d93STejun Heo * 13124acfb71SThomas Gleixner * PR: wq_pool_mutex protected for writes. RCU protected for reads. 1325bcab335STejun Heo * 1335b95e1afSLai Jiangshan * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads. 1345b95e1afSLai Jiangshan * 1355b95e1afSLai Jiangshan * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or 13624acfb71SThomas Gleixner * RCU for reads. 1375b95e1afSLai Jiangshan * 1383c25a55dSLai Jiangshan * WQ: wq->mutex protected. 1393c25a55dSLai Jiangshan * 14024acfb71SThomas Gleixner * WR: wq->mutex protected for writes. RCU protected for reads. 1412e109a28STejun Heo * 1422e109a28STejun Heo * MD: wq_mayday_lock protected. 1434690c4abSTejun Heo */ 1444690c4abSTejun Heo 1452eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 146c34056a3STejun Heo 147bd7bdd43STejun Heo struct worker_pool { 148d565ed63STejun Heo spinlock_t lock; /* the pool lock */ 149d84ff051STejun Heo int cpu; /* I: the associated cpu */ 150f3f90ad4STejun Heo int node; /* I: the associated node ID */ 1519daf9e67STejun Heo int id; /* I: pool ID */ 15211ebea50STejun Heo unsigned int flags; /* X: flags */ 153bd7bdd43STejun Heo 15482607adcSTejun Heo unsigned long watchdog_ts; /* L: watchdog timestamp */ 15582607adcSTejun Heo 156bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 157ea1abd61SLai Jiangshan 1585826cc8fSLai Jiangshan int nr_workers; /* L: total number of workers */ 1595826cc8fSLai Jiangshan int nr_idle; /* L: currently idle workers */ 160bd7bdd43STejun Heo 161bd7bdd43STejun Heo struct list_head idle_list; /* X: list of idle workers */ 162bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 163bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 164bd7bdd43STejun Heo 165c5aa87bbSTejun Heo /* a workers is either on busy_hash or idle_list, or the manager */ 166c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 167c9e7cf27STejun Heo /* L: hash of busy workers */ 168c9e7cf27STejun Heo 1692607d7a6STejun Heo struct worker *manager; /* L: purely informational */ 17092f9c5c4SLai Jiangshan struct list_head workers; /* A: attached workers */ 17160f5a4bcSLai Jiangshan struct completion *detach_completion; /* all workers detached */ 172e19e397aSTejun Heo 1737cda9aaeSLai Jiangshan struct ida worker_ida; /* worker IDs for task name */ 174e19e397aSTejun Heo 1757a4e344cSTejun Heo struct workqueue_attrs *attrs; /* I: worker attributes */ 17668e13a67SLai Jiangshan struct hlist_node hash_node; /* PL: unbound_pool_hash node */ 17768e13a67SLai Jiangshan int refcnt; /* PL: refcnt for unbound pools */ 1787a4e344cSTejun Heo 179e19e397aSTejun Heo /* 180e19e397aSTejun Heo * The current concurrency level. As it's likely to be accessed 181e19e397aSTejun Heo * from other CPUs during try_to_wake_up(), put it in a separate 182e19e397aSTejun Heo * cacheline. 183e19e397aSTejun Heo */ 184e19e397aSTejun Heo atomic_t nr_running ____cacheline_aligned_in_smp; 18529c91e99STejun Heo 18629c91e99STejun Heo /* 18724acfb71SThomas Gleixner * Destruction of pool is RCU protected to allow dereferences 18829c91e99STejun Heo * from get_work_pool(). 18929c91e99STejun Heo */ 19029c91e99STejun Heo struct rcu_head rcu; 1918b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1928b03ae3cSTejun Heo 1938b03ae3cSTejun Heo /* 194112202d9STejun Heo * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS 195112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 196112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 197112202d9STejun Heo * number of flag bits. 1981da177e4SLinus Torvalds */ 199112202d9STejun Heo struct pool_workqueue { 200bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 2014690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 20273f53c4aSTejun Heo int work_color; /* L: current color */ 20373f53c4aSTejun Heo int flush_color; /* L: flushing color */ 2048864b4e5STejun Heo int refcnt; /* L: reference count */ 20573f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 20673f53c4aSTejun Heo /* L: nr of in_flight works */ 2071e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 208a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 2091e19ffc6STejun Heo struct list_head delayed_works; /* L: delayed works */ 2103c25a55dSLai Jiangshan struct list_head pwqs_node; /* WR: node on wq->pwqs */ 2112e109a28STejun Heo struct list_head mayday_node; /* MD: node on wq->maydays */ 2128864b4e5STejun Heo 2138864b4e5STejun Heo /* 2148864b4e5STejun Heo * Release of unbound pwq is punted to system_wq. See put_pwq() 2158864b4e5STejun Heo * and pwq_unbound_release_workfn() for details. pool_workqueue 21624acfb71SThomas Gleixner * itself is also RCU protected so that the first pwq can be 217b09f4fd3SLai Jiangshan * determined without grabbing wq->mutex. 2188864b4e5STejun Heo */ 2198864b4e5STejun Heo struct work_struct unbound_release_work; 2208864b4e5STejun Heo struct rcu_head rcu; 221e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS); 2221da177e4SLinus Torvalds 2231da177e4SLinus Torvalds /* 22473f53c4aSTejun Heo * Structure used to wait for workqueue flush. 22573f53c4aSTejun Heo */ 22673f53c4aSTejun Heo struct wq_flusher { 2273c25a55dSLai Jiangshan struct list_head list; /* WQ: list of flushers */ 2283c25a55dSLai Jiangshan int flush_color; /* WQ: flush color waiting for */ 22973f53c4aSTejun Heo struct completion done; /* flush completion */ 23073f53c4aSTejun Heo }; 2311da177e4SLinus Torvalds 232226223abSTejun Heo struct wq_device; 233226223abSTejun Heo 23473f53c4aSTejun Heo /* 235c5aa87bbSTejun Heo * The externally visible workqueue. It relays the issued work items to 236c5aa87bbSTejun Heo * the appropriate worker_pool through its pool_workqueues. 2371da177e4SLinus Torvalds */ 2381da177e4SLinus Torvalds struct workqueue_struct { 2393c25a55dSLai Jiangshan struct list_head pwqs; /* WR: all pwqs of this wq */ 240e2dca7adSTejun Heo struct list_head list; /* PR: list of all workqueues */ 24173f53c4aSTejun Heo 2423c25a55dSLai Jiangshan struct mutex mutex; /* protects this wq */ 2433c25a55dSLai Jiangshan int work_color; /* WQ: current work color */ 2443c25a55dSLai Jiangshan int flush_color; /* WQ: current flush color */ 245112202d9STejun Heo atomic_t nr_pwqs_to_flush; /* flush in progress */ 2463c25a55dSLai Jiangshan struct wq_flusher *first_flusher; /* WQ: first flusher */ 2473c25a55dSLai Jiangshan struct list_head flusher_queue; /* WQ: flush waiters */ 2483c25a55dSLai Jiangshan struct list_head flusher_overflow; /* WQ: flush overflow list */ 24973f53c4aSTejun Heo 2502e109a28STejun Heo struct list_head maydays; /* MD: pwqs requesting rescue */ 25130ae2fc0STejun Heo struct worker *rescuer; /* MD: rescue worker */ 252e22bee78STejun Heo 25387fc741eSLai Jiangshan int nr_drainers; /* WQ: drain in progress */ 254a357fc03SLai Jiangshan int saved_max_active; /* WQ: saved pwq max_active */ 255226223abSTejun Heo 2565b95e1afSLai Jiangshan struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */ 2575b95e1afSLai Jiangshan struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */ 2586029a918STejun Heo 259226223abSTejun Heo #ifdef CONFIG_SYSFS 260226223abSTejun Heo struct wq_device *wq_dev; /* I: for sysfs interface */ 261226223abSTejun Heo #endif 2624e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 263669de8bdSBart Van Assche char *lock_name; 264669de8bdSBart Van Assche struct lock_class_key key; 2654e6045f1SJohannes Berg struct lockdep_map lockdep_map; 2664e6045f1SJohannes Berg #endif 267ecf6881fSTejun Heo char name[WQ_NAME_LEN]; /* I: workqueue name */ 2682728fd2fSTejun Heo 269e2dca7adSTejun Heo /* 27024acfb71SThomas Gleixner * Destruction of workqueue_struct is RCU protected to allow walking 27124acfb71SThomas Gleixner * the workqueues list without grabbing wq_pool_mutex. 272e2dca7adSTejun Heo * This is used to dump all workqueues from sysrq. 273e2dca7adSTejun Heo */ 274e2dca7adSTejun Heo struct rcu_head rcu; 275e2dca7adSTejun Heo 2762728fd2fSTejun Heo /* hot fields used during command issue, aligned to cacheline */ 2772728fd2fSTejun Heo unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ 2782728fd2fSTejun Heo struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */ 2795b95e1afSLai Jiangshan struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */ 2801da177e4SLinus Torvalds }; 2811da177e4SLinus Torvalds 282e904e6c2STejun Heo static struct kmem_cache *pwq_cache; 283e904e6c2STejun Heo 284bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask; 285bce90380STejun Heo /* possible CPUs of each node */ 286bce90380STejun Heo 287d55262c4STejun Heo static bool wq_disable_numa; 288d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444); 289d55262c4STejun Heo 290cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 291552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT); 292cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444); 293cee22a15SViresh Kumar 294863b710bSTejun Heo static bool wq_online; /* can kworkers be created yet? */ 2953347fa09STejun Heo 296bce90380STejun Heo static bool wq_numa_enabled; /* unbound NUMA affinity enabled */ 297bce90380STejun Heo 2984c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */ 2994c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf; 3004c16bd32STejun Heo 30168e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ 3021258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */ 3032e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ 304692b4825STejun Heo static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */ 3055bcab335STejun Heo 306e2dca7adSTejun Heo static LIST_HEAD(workqueues); /* PR: list of all workqueues */ 30768e13a67SLai Jiangshan static bool workqueue_freezing; /* PL: have wqs started freezing? */ 3087d19c5ceSTejun Heo 309ef557180SMike Galbraith /* PL: allowable cpus for unbound wqs and work items */ 310ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask; 311ef557180SMike Galbraith 312ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */ 313ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last); 314b05a7928SFrederic Weisbecker 315f303fccbSTejun Heo /* 316f303fccbSTejun Heo * Local execution of unbound work items is no longer guaranteed. The 317f303fccbSTejun Heo * following always forces round-robin CPU selection on unbound work items 318f303fccbSTejun Heo * to uncover usages which depend on it. 319f303fccbSTejun Heo */ 320f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU 321f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true; 322f303fccbSTejun Heo #else 323f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false; 324f303fccbSTejun Heo #endif 325f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644); 326f303fccbSTejun Heo 3277d19c5ceSTejun Heo /* the per-cpu worker pools */ 32825528213SPeter Zijlstra static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools); 3297d19c5ceSTejun Heo 33068e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ 3317d19c5ceSTejun Heo 33268e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */ 33329c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); 33429c91e99STejun Heo 335c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */ 33629c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; 33729c91e99STejun Heo 3388a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */ 3398a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS]; 3408a2b7538STejun Heo 341d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 342ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq); 343044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly; 3441aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 345044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly; 346d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 347044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly; 348f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 349044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly; 35024d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 3510668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly; 3520668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq); 3530668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly; 3540668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq); 355d320c038STejun Heo 3567d19c5ceSTejun Heo static int worker_thread(void *__worker); 3576ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq); 358c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq); 3597d19c5ceSTejun Heo 36097bd2347STejun Heo #define CREATE_TRACE_POINTS 36197bd2347STejun Heo #include <trace/events/workqueue.h> 36297bd2347STejun Heo 36368e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex() \ 36424acfb71SThomas Gleixner RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ 365f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 36624acfb71SThomas Gleixner "RCU or wq_pool_mutex should be held") 3675bcab335STejun Heo 368b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq) \ 36924acfb71SThomas Gleixner RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ 370f78f5b90SPaul E. McKenney !lockdep_is_held(&wq->mutex), \ 37124acfb71SThomas Gleixner "RCU or wq->mutex should be held") 37276af4d93STejun Heo 3735b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \ 37424acfb71SThomas Gleixner RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ 375f78f5b90SPaul E. McKenney !lockdep_is_held(&wq->mutex) && \ 376f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 37724acfb71SThomas Gleixner "RCU, wq->mutex or wq_pool_mutex should be held") 3785b95e1afSLai Jiangshan 379f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu) \ 380f02ae73aSTejun Heo for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ 381f02ae73aSTejun Heo (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 3827a62c2c8STejun Heo (pool)++) 3834ce62e9eSTejun Heo 38449e3cf44STejun Heo /** 38517116969STejun Heo * for_each_pool - iterate through all worker_pools in the system 38617116969STejun Heo * @pool: iteration cursor 387611c92a0STejun Heo * @pi: integer used for iteration 388fa1b54e6STejun Heo * 38924acfb71SThomas Gleixner * This must be called either with wq_pool_mutex held or RCU read 39068e13a67SLai Jiangshan * locked. If the pool needs to be used beyond the locking in effect, the 39168e13a67SLai Jiangshan * caller is responsible for guaranteeing that the pool stays online. 392fa1b54e6STejun Heo * 393fa1b54e6STejun Heo * The if/else clause exists only for the lockdep assertion and can be 394fa1b54e6STejun Heo * ignored. 39517116969STejun Heo */ 396611c92a0STejun Heo #define for_each_pool(pool, pi) \ 397611c92a0STejun Heo idr_for_each_entry(&worker_pool_idr, pool, pi) \ 39868e13a67SLai Jiangshan if (({ assert_rcu_or_pool_mutex(); false; })) { } \ 399fa1b54e6STejun Heo else 40017116969STejun Heo 40117116969STejun Heo /** 402822d8405STejun Heo * for_each_pool_worker - iterate through all workers of a worker_pool 403822d8405STejun Heo * @worker: iteration cursor 404822d8405STejun Heo * @pool: worker_pool to iterate workers of 405822d8405STejun Heo * 4061258fae7STejun Heo * This must be called with wq_pool_attach_mutex. 407822d8405STejun Heo * 408822d8405STejun Heo * The if/else clause exists only for the lockdep assertion and can be 409822d8405STejun Heo * ignored. 410822d8405STejun Heo */ 411da028469SLai Jiangshan #define for_each_pool_worker(worker, pool) \ 412da028469SLai Jiangshan list_for_each_entry((worker), &(pool)->workers, node) \ 4131258fae7STejun Heo if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \ 414822d8405STejun Heo else 415822d8405STejun Heo 416822d8405STejun Heo /** 41749e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 41849e3cf44STejun Heo * @pwq: iteration cursor 41949e3cf44STejun Heo * @wq: the target workqueue 42076af4d93STejun Heo * 42124acfb71SThomas Gleixner * This must be called either with wq->mutex held or RCU read locked. 422794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 423794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 42476af4d93STejun Heo * 42576af4d93STejun Heo * The if/else clause exists only for the lockdep assertion and can be 42676af4d93STejun Heo * ignored. 42749e3cf44STejun Heo */ 42849e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 429*49e9d1a9SSebastian Andrzej Siewior list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \ 430*49e9d1a9SSebastian Andrzej Siewior lockdep_is_held(&wq->mutex)) \ 431b09f4fd3SLai Jiangshan if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \ 43276af4d93STejun Heo else 433f3421797STejun Heo 434dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 435dc186ad7SThomas Gleixner 436dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr; 437dc186ad7SThomas Gleixner 43899777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 43999777288SStanislaw Gruszka { 44099777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 44199777288SStanislaw Gruszka } 44299777288SStanislaw Gruszka 443b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr) 444b9fdac7fSDu, Changbin { 445b9fdac7fSDu, Changbin struct work_struct *work = addr; 446b9fdac7fSDu, Changbin 447b9fdac7fSDu, Changbin return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work)); 448b9fdac7fSDu, Changbin } 449b9fdac7fSDu, Changbin 450dc186ad7SThomas Gleixner /* 451dc186ad7SThomas Gleixner * fixup_init is called when: 452dc186ad7SThomas Gleixner * - an active object is initialized 453dc186ad7SThomas Gleixner */ 45402a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state) 455dc186ad7SThomas Gleixner { 456dc186ad7SThomas Gleixner struct work_struct *work = addr; 457dc186ad7SThomas Gleixner 458dc186ad7SThomas Gleixner switch (state) { 459dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 460dc186ad7SThomas Gleixner cancel_work_sync(work); 461dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 46202a982a6SDu, Changbin return true; 463dc186ad7SThomas Gleixner default: 46402a982a6SDu, Changbin return false; 465dc186ad7SThomas Gleixner } 466dc186ad7SThomas Gleixner } 467dc186ad7SThomas Gleixner 468dc186ad7SThomas Gleixner /* 469dc186ad7SThomas Gleixner * fixup_free is called when: 470dc186ad7SThomas Gleixner * - an active object is freed 471dc186ad7SThomas Gleixner */ 47202a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state) 473dc186ad7SThomas Gleixner { 474dc186ad7SThomas Gleixner struct work_struct *work = addr; 475dc186ad7SThomas Gleixner 476dc186ad7SThomas Gleixner switch (state) { 477dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 478dc186ad7SThomas Gleixner cancel_work_sync(work); 479dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 48002a982a6SDu, Changbin return true; 481dc186ad7SThomas Gleixner default: 48202a982a6SDu, Changbin return false; 483dc186ad7SThomas Gleixner } 484dc186ad7SThomas Gleixner } 485dc186ad7SThomas Gleixner 486dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = { 487dc186ad7SThomas Gleixner .name = "work_struct", 48899777288SStanislaw Gruszka .debug_hint = work_debug_hint, 489b9fdac7fSDu, Changbin .is_static_object = work_is_static_object, 490dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 491dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 492dc186ad7SThomas Gleixner }; 493dc186ad7SThomas Gleixner 494dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 495dc186ad7SThomas Gleixner { 496dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 497dc186ad7SThomas Gleixner } 498dc186ad7SThomas Gleixner 499dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 500dc186ad7SThomas Gleixner { 501dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 502dc186ad7SThomas Gleixner } 503dc186ad7SThomas Gleixner 504dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 505dc186ad7SThomas Gleixner { 506dc186ad7SThomas Gleixner if (onstack) 507dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 508dc186ad7SThomas Gleixner else 509dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 510dc186ad7SThomas Gleixner } 511dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 512dc186ad7SThomas Gleixner 513dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 514dc186ad7SThomas Gleixner { 515dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 516dc186ad7SThomas Gleixner } 517dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 518dc186ad7SThomas Gleixner 519ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work) 520ea2e64f2SThomas Gleixner { 521ea2e64f2SThomas Gleixner destroy_timer_on_stack(&work->timer); 522ea2e64f2SThomas Gleixner debug_object_free(&work->work, &work_debug_descr); 523ea2e64f2SThomas Gleixner } 524ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack); 525ea2e64f2SThomas Gleixner 526dc186ad7SThomas Gleixner #else 527dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 528dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 529dc186ad7SThomas Gleixner #endif 530dc186ad7SThomas Gleixner 5314e8b22bdSLi Bin /** 5324e8b22bdSLi Bin * worker_pool_assign_id - allocate ID and assing it to @pool 5334e8b22bdSLi Bin * @pool: the pool pointer of interest 5344e8b22bdSLi Bin * 5354e8b22bdSLi Bin * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned 5364e8b22bdSLi Bin * successfully, -errno on failure. 5374e8b22bdSLi Bin */ 5389daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 5399daf9e67STejun Heo { 5409daf9e67STejun Heo int ret; 5419daf9e67STejun Heo 54268e13a67SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5435bcab335STejun Heo 5444e8b22bdSLi Bin ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE, 5454e8b22bdSLi Bin GFP_KERNEL); 546229641a6STejun Heo if (ret >= 0) { 547e68035fbSTejun Heo pool->id = ret; 548229641a6STejun Heo return 0; 549229641a6STejun Heo } 5509daf9e67STejun Heo return ret; 5519daf9e67STejun Heo } 5529daf9e67STejun Heo 55376af4d93STejun Heo /** 554df2d5ae4STejun Heo * unbound_pwq_by_node - return the unbound pool_workqueue for the given node 555df2d5ae4STejun Heo * @wq: the target workqueue 556df2d5ae4STejun Heo * @node: the node ID 557df2d5ae4STejun Heo * 55824acfb71SThomas Gleixner * This must be called with any of wq_pool_mutex, wq->mutex or RCU 5595b95e1afSLai Jiangshan * read locked. 560df2d5ae4STejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 561df2d5ae4STejun Heo * responsible for guaranteeing that the pwq stays online. 562d185af30SYacine Belkadi * 563d185af30SYacine Belkadi * Return: The unbound pool_workqueue for @node. 564df2d5ae4STejun Heo */ 565df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq, 566df2d5ae4STejun Heo int node) 567df2d5ae4STejun Heo { 5685b95e1afSLai Jiangshan assert_rcu_or_wq_mutex_or_pool_mutex(wq); 569d6e022f1STejun Heo 570d6e022f1STejun Heo /* 571d6e022f1STejun Heo * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a 572d6e022f1STejun Heo * delayed item is pending. The plan is to keep CPU -> NODE 573d6e022f1STejun Heo * mapping valid and stable across CPU on/offlines. Once that 574d6e022f1STejun Heo * happens, this workaround can be removed. 575d6e022f1STejun Heo */ 576d6e022f1STejun Heo if (unlikely(node == NUMA_NO_NODE)) 577d6e022f1STejun Heo return wq->dfl_pwq; 578d6e022f1STejun Heo 579df2d5ae4STejun Heo return rcu_dereference_raw(wq->numa_pwq_tbl[node]); 580df2d5ae4STejun Heo } 581df2d5ae4STejun Heo 58273f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 58373f53c4aSTejun Heo { 58473f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 58573f53c4aSTejun Heo } 58673f53c4aSTejun Heo 58773f53c4aSTejun Heo static int get_work_color(struct work_struct *work) 58873f53c4aSTejun Heo { 58973f53c4aSTejun Heo return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & 59073f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 59173f53c4aSTejun Heo } 59273f53c4aSTejun Heo 59373f53c4aSTejun Heo static int work_next_color(int color) 59473f53c4aSTejun Heo { 59573f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 596a848e3b6SOleg Nesterov } 597a848e3b6SOleg Nesterov 5984594bf15SDavid Howells /* 599112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 600112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 6017c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 6027a22ad75STejun Heo * 603112202d9STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 604112202d9STejun Heo * and clear_work_data() can be used to set the pwq, pool or clear 605bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 606bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 6077a22ad75STejun Heo * 608112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 6097c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 610112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 6117c3eed5cSTejun Heo * available only while the work item is queued. 612bbb68dfaSTejun Heo * 613bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 614bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 615bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 616bbb68dfaSTejun Heo * try to steal the PENDING bit. 6174594bf15SDavid Howells */ 6187a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 6197a22ad75STejun Heo unsigned long flags) 6207a22ad75STejun Heo { 6216183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 6227a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 6237a22ad75STejun Heo } 6247a22ad75STejun Heo 625112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 6264690c4abSTejun Heo unsigned long extra_flags) 627365970a1SDavid Howells { 628112202d9STejun Heo set_work_data(work, (unsigned long)pwq, 629112202d9STejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); 630365970a1SDavid Howells } 631365970a1SDavid Howells 6324468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 6334468a00fSLai Jiangshan int pool_id) 6344468a00fSLai Jiangshan { 6354468a00fSLai Jiangshan set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 6364468a00fSLai Jiangshan WORK_STRUCT_PENDING); 6374468a00fSLai Jiangshan } 6384468a00fSLai Jiangshan 6397c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 6407c3eed5cSTejun Heo int pool_id) 6414d707b9fSOleg Nesterov { 64223657bb1STejun Heo /* 64323657bb1STejun Heo * The following wmb is paired with the implied mb in 64423657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 64523657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 64623657bb1STejun Heo * owner. 64723657bb1STejun Heo */ 64823657bb1STejun Heo smp_wmb(); 6497c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 650346c09f8SRoman Pen /* 651346c09f8SRoman Pen * The following mb guarantees that previous clear of a PENDING bit 652346c09f8SRoman Pen * will not be reordered with any speculative LOADS or STORES from 653346c09f8SRoman Pen * work->current_func, which is executed afterwards. This possible 6548bdc6201SLiu Song * reordering can lead to a missed execution on attempt to queue 655346c09f8SRoman Pen * the same @work. E.g. consider this case: 656346c09f8SRoman Pen * 657346c09f8SRoman Pen * CPU#0 CPU#1 658346c09f8SRoman Pen * ---------------------------- -------------------------------- 659346c09f8SRoman Pen * 660346c09f8SRoman Pen * 1 STORE event_indicated 661346c09f8SRoman Pen * 2 queue_work_on() { 662346c09f8SRoman Pen * 3 test_and_set_bit(PENDING) 663346c09f8SRoman Pen * 4 } set_..._and_clear_pending() { 664346c09f8SRoman Pen * 5 set_work_data() # clear bit 665346c09f8SRoman Pen * 6 smp_mb() 666346c09f8SRoman Pen * 7 work->current_func() { 667346c09f8SRoman Pen * 8 LOAD event_indicated 668346c09f8SRoman Pen * } 669346c09f8SRoman Pen * 670346c09f8SRoman Pen * Without an explicit full barrier speculative LOAD on line 8 can 671346c09f8SRoman Pen * be executed before CPU#0 does STORE on line 1. If that happens, 672346c09f8SRoman Pen * CPU#0 observes the PENDING bit is still set and new execution of 673346c09f8SRoman Pen * a @work is not queued in a hope, that CPU#1 will eventually 674346c09f8SRoman Pen * finish the queued @work. Meanwhile CPU#1 does not see 675346c09f8SRoman Pen * event_indicated is set, because speculative LOAD was executed 676346c09f8SRoman Pen * before actual STORE. 677346c09f8SRoman Pen */ 678346c09f8SRoman Pen smp_mb(); 6794d707b9fSOleg Nesterov } 6804d707b9fSOleg Nesterov 6817a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 682365970a1SDavid Howells { 6837c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 6847c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 6857a22ad75STejun Heo } 6867a22ad75STejun Heo 687112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 6887a22ad75STejun Heo { 689e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 6907a22ad75STejun Heo 691112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 692e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 693e120153dSTejun Heo else 694e120153dSTejun Heo return NULL; 6957a22ad75STejun Heo } 6967a22ad75STejun Heo 6977c3eed5cSTejun Heo /** 6987c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 6997c3eed5cSTejun Heo * @work: the work item of interest 7007c3eed5cSTejun Heo * 70168e13a67SLai Jiangshan * Pools are created and destroyed under wq_pool_mutex, and allows read 70224acfb71SThomas Gleixner * access under RCU read lock. As such, this function should be 70324acfb71SThomas Gleixner * called under wq_pool_mutex or inside of a rcu_read_lock() region. 704fa1b54e6STejun Heo * 705fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 706fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 707fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 708fa1b54e6STejun Heo * returned pool is and stays online. 709d185af30SYacine Belkadi * 710d185af30SYacine Belkadi * Return: The worker_pool @work was last associated with. %NULL if none. 7117c3eed5cSTejun Heo */ 7127c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 7137a22ad75STejun Heo { 714e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 7157c3eed5cSTejun Heo int pool_id; 7167a22ad75STejun Heo 71768e13a67SLai Jiangshan assert_rcu_or_pool_mutex(); 718fa1b54e6STejun Heo 719112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 720112202d9STejun Heo return ((struct pool_workqueue *) 7217c3eed5cSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->pool; 7227a22ad75STejun Heo 7237c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 7247c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 7257a22ad75STejun Heo return NULL; 7267a22ad75STejun Heo 727fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 7287c3eed5cSTejun Heo } 7297c3eed5cSTejun Heo 7307c3eed5cSTejun Heo /** 7317c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 7327c3eed5cSTejun Heo * @work: the work item of interest 7337c3eed5cSTejun Heo * 734d185af30SYacine Belkadi * Return: The worker_pool ID @work was last associated with. 7357c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 7367c3eed5cSTejun Heo */ 7377c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 7387c3eed5cSTejun Heo { 73954d5b7d0SLai Jiangshan unsigned long data = atomic_long_read(&work->data); 7407c3eed5cSTejun Heo 741112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 742112202d9STejun Heo return ((struct pool_workqueue *) 74354d5b7d0SLai Jiangshan (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id; 74454d5b7d0SLai Jiangshan 74554d5b7d0SLai Jiangshan return data >> WORK_OFFQ_POOL_SHIFT; 7467c3eed5cSTejun Heo } 7477c3eed5cSTejun Heo 748bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 749bbb68dfaSTejun Heo { 7507c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 751bbb68dfaSTejun Heo 7527c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 7537c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 754bbb68dfaSTejun Heo } 755bbb68dfaSTejun Heo 756bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 757bbb68dfaSTejun Heo { 758bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 759bbb68dfaSTejun Heo 760112202d9STejun Heo return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); 761bbb68dfaSTejun Heo } 762bbb68dfaSTejun Heo 763e22bee78STejun Heo /* 7643270476aSTejun Heo * Policy functions. These define the policies on how the global worker 7653270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 766d565ed63STejun Heo * they're being called with pool->lock held. 767e22bee78STejun Heo */ 768e22bee78STejun Heo 76963d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool) 770649027d7STejun Heo { 771e19e397aSTejun Heo return !atomic_read(&pool->nr_running); 772649027d7STejun Heo } 773649027d7STejun Heo 774e22bee78STejun Heo /* 775e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 776e22bee78STejun Heo * running workers. 777974271c4STejun Heo * 778974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 779706026c2STejun Heo * function will always return %true for unbound pools as long as the 780974271c4STejun Heo * worklist isn't empty. 781e22bee78STejun Heo */ 78263d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 783e22bee78STejun Heo { 78463d95a91STejun Heo return !list_empty(&pool->worklist) && __need_more_worker(pool); 785e22bee78STejun Heo } 786e22bee78STejun Heo 787e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 78863d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 789e22bee78STejun Heo { 79063d95a91STejun Heo return pool->nr_idle; 791e22bee78STejun Heo } 792e22bee78STejun Heo 793e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 79463d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 795e22bee78STejun Heo { 796e19e397aSTejun Heo return !list_empty(&pool->worklist) && 797e19e397aSTejun Heo atomic_read(&pool->nr_running) <= 1; 798e22bee78STejun Heo } 799e22bee78STejun Heo 800e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 80163d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 802e22bee78STejun Heo { 80363d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 804e22bee78STejun Heo } 805e22bee78STejun Heo 806e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 80763d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 808e22bee78STejun Heo { 809692b4825STejun Heo bool managing = pool->flags & POOL_MANAGER_ACTIVE; 81063d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 81163d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 812e22bee78STejun Heo 813e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 814e22bee78STejun Heo } 815e22bee78STejun Heo 816e22bee78STejun Heo /* 817e22bee78STejun Heo * Wake up functions. 818e22bee78STejun Heo */ 819e22bee78STejun Heo 8201037de36SLai Jiangshan /* Return the first idle worker. Safe with preemption disabled */ 8211037de36SLai Jiangshan static struct worker *first_idle_worker(struct worker_pool *pool) 8227e11629dSTejun Heo { 82363d95a91STejun Heo if (unlikely(list_empty(&pool->idle_list))) 8247e11629dSTejun Heo return NULL; 8257e11629dSTejun Heo 82663d95a91STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 8277e11629dSTejun Heo } 8287e11629dSTejun Heo 8297e11629dSTejun Heo /** 8307e11629dSTejun Heo * wake_up_worker - wake up an idle worker 83163d95a91STejun Heo * @pool: worker pool to wake worker from 8327e11629dSTejun Heo * 83363d95a91STejun Heo * Wake up the first idle worker of @pool. 8347e11629dSTejun Heo * 8357e11629dSTejun Heo * CONTEXT: 836d565ed63STejun Heo * spin_lock_irq(pool->lock). 8377e11629dSTejun Heo */ 83863d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool) 8397e11629dSTejun Heo { 8401037de36SLai Jiangshan struct worker *worker = first_idle_worker(pool); 8417e11629dSTejun Heo 8427e11629dSTejun Heo if (likely(worker)) 8437e11629dSTejun Heo wake_up_process(worker->task); 8447e11629dSTejun Heo } 8457e11629dSTejun Heo 8464690c4abSTejun Heo /** 8476d25be57SThomas Gleixner * wq_worker_running - a worker is running again 848e22bee78STejun Heo * @task: task waking up 849e22bee78STejun Heo * 8506d25be57SThomas Gleixner * This function is called when a worker returns from schedule() 851e22bee78STejun Heo */ 8526d25be57SThomas Gleixner void wq_worker_running(struct task_struct *task) 853e22bee78STejun Heo { 854e22bee78STejun Heo struct worker *worker = kthread_data(task); 855e22bee78STejun Heo 8566d25be57SThomas Gleixner if (!worker->sleeping) 8576d25be57SThomas Gleixner return; 8586d25be57SThomas Gleixner if (!(worker->flags & WORKER_NOT_RUNNING)) 859e19e397aSTejun Heo atomic_inc(&worker->pool->nr_running); 8606d25be57SThomas Gleixner worker->sleeping = 0; 86136576000SJoonsoo Kim } 862e22bee78STejun Heo 863e22bee78STejun Heo /** 864e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 865e22bee78STejun Heo * @task: task going to sleep 866e22bee78STejun Heo * 8676d25be57SThomas Gleixner * This function is called from schedule() when a busy worker is 8686d25be57SThomas Gleixner * going to sleep. 869e22bee78STejun Heo */ 8706d25be57SThomas Gleixner void wq_worker_sleeping(struct task_struct *task) 871e22bee78STejun Heo { 8726d25be57SThomas Gleixner struct worker *next, *worker = kthread_data(task); 873111c225aSTejun Heo struct worker_pool *pool; 874e22bee78STejun Heo 875111c225aSTejun Heo /* 876111c225aSTejun Heo * Rescuers, which may not have all the fields set up like normal 877111c225aSTejun Heo * workers, also reach here, let's not access anything before 878111c225aSTejun Heo * checking NOT_RUNNING. 879111c225aSTejun Heo */ 8802d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 8816d25be57SThomas Gleixner return; 882e22bee78STejun Heo 883111c225aSTejun Heo pool = worker->pool; 884111c225aSTejun Heo 8856d25be57SThomas Gleixner if (WARN_ON_ONCE(worker->sleeping)) 8866d25be57SThomas Gleixner return; 8876d25be57SThomas Gleixner 8886d25be57SThomas Gleixner worker->sleeping = 1; 8896d25be57SThomas Gleixner spin_lock_irq(&pool->lock); 890e22bee78STejun Heo 891e22bee78STejun Heo /* 892e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 893e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 894e22bee78STejun Heo * Please read comment there. 895e22bee78STejun Heo * 896628c78e7STejun Heo * NOT_RUNNING is clear. This means that we're bound to and 897628c78e7STejun Heo * running on the local cpu w/ rq lock held and preemption 898628c78e7STejun Heo * disabled, which in turn means that none else could be 899d565ed63STejun Heo * manipulating idle_list, so dereferencing idle_list without pool 900628c78e7STejun Heo * lock is safe. 901e22bee78STejun Heo */ 902e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 9036d25be57SThomas Gleixner !list_empty(&pool->worklist)) { 9046d25be57SThomas Gleixner next = first_idle_worker(pool); 9056d25be57SThomas Gleixner if (next) 9066d25be57SThomas Gleixner wake_up_process(next->task); 9076d25be57SThomas Gleixner } 9086d25be57SThomas Gleixner spin_unlock_irq(&pool->lock); 909e22bee78STejun Heo } 910e22bee78STejun Heo 911e22bee78STejun Heo /** 9121b69ac6bSJohannes Weiner * wq_worker_last_func - retrieve worker's last work function 9138194fe94SBart Van Assche * @task: Task to retrieve last work function of. 9141b69ac6bSJohannes Weiner * 9151b69ac6bSJohannes Weiner * Determine the last function a worker executed. This is called from 9161b69ac6bSJohannes Weiner * the scheduler to get a worker's last known identity. 9171b69ac6bSJohannes Weiner * 9181b69ac6bSJohannes Weiner * CONTEXT: 9191b69ac6bSJohannes Weiner * spin_lock_irq(rq->lock) 9201b69ac6bSJohannes Weiner * 9214b047002SJohannes Weiner * This function is called during schedule() when a kworker is going 9224b047002SJohannes Weiner * to sleep. It's used by psi to identify aggregation workers during 9234b047002SJohannes Weiner * dequeuing, to allow periodic aggregation to shut-off when that 9244b047002SJohannes Weiner * worker is the last task in the system or cgroup to go to sleep. 9254b047002SJohannes Weiner * 9264b047002SJohannes Weiner * As this function doesn't involve any workqueue-related locking, it 9274b047002SJohannes Weiner * only returns stable values when called from inside the scheduler's 9284b047002SJohannes Weiner * queuing and dequeuing paths, when @task, which must be a kworker, 9294b047002SJohannes Weiner * is guaranteed to not be processing any works. 9304b047002SJohannes Weiner * 9311b69ac6bSJohannes Weiner * Return: 9321b69ac6bSJohannes Weiner * The last work function %current executed as a worker, NULL if it 9331b69ac6bSJohannes Weiner * hasn't executed any work yet. 9341b69ac6bSJohannes Weiner */ 9351b69ac6bSJohannes Weiner work_func_t wq_worker_last_func(struct task_struct *task) 9361b69ac6bSJohannes Weiner { 9371b69ac6bSJohannes Weiner struct worker *worker = kthread_data(task); 9381b69ac6bSJohannes Weiner 9391b69ac6bSJohannes Weiner return worker->last_func; 9401b69ac6bSJohannes Weiner } 9411b69ac6bSJohannes Weiner 9421b69ac6bSJohannes Weiner /** 943e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 944cb444766STejun Heo * @worker: self 945d302f017STejun Heo * @flags: flags to set 946d302f017STejun Heo * 947228f1d00SLai Jiangshan * Set @flags in @worker->flags and adjust nr_running accordingly. 948d302f017STejun Heo * 949cb444766STejun Heo * CONTEXT: 950d565ed63STejun Heo * spin_lock_irq(pool->lock) 951d302f017STejun Heo */ 952228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags) 953d302f017STejun Heo { 954bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 955e22bee78STejun Heo 956cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 957cb444766STejun Heo 958228f1d00SLai Jiangshan /* If transitioning into NOT_RUNNING, adjust nr_running. */ 959e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 960e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 961e19e397aSTejun Heo atomic_dec(&pool->nr_running); 962e22bee78STejun Heo } 963e22bee78STejun Heo 964d302f017STejun Heo worker->flags |= flags; 965d302f017STejun Heo } 966d302f017STejun Heo 967d302f017STejun Heo /** 968e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 969cb444766STejun Heo * @worker: self 970d302f017STejun Heo * @flags: flags to clear 971d302f017STejun Heo * 972e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 973d302f017STejun Heo * 974cb444766STejun Heo * CONTEXT: 975d565ed63STejun Heo * spin_lock_irq(pool->lock) 976d302f017STejun Heo */ 977d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 978d302f017STejun Heo { 97963d95a91STejun Heo struct worker_pool *pool = worker->pool; 980e22bee78STejun Heo unsigned int oflags = worker->flags; 981e22bee78STejun Heo 982cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 983cb444766STejun Heo 984d302f017STejun Heo worker->flags &= ~flags; 985e22bee78STejun Heo 98642c025f3STejun Heo /* 98742c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 98842c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 98942c025f3STejun Heo * of multiple flags, not a single flag. 99042c025f3STejun Heo */ 991e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 992e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 993e19e397aSTejun Heo atomic_inc(&pool->nr_running); 994d302f017STejun Heo } 995d302f017STejun Heo 996d302f017STejun Heo /** 9978cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 998c9e7cf27STejun Heo * @pool: pool of interest 9998cca0eeaSTejun Heo * @work: work to find worker for 10008cca0eeaSTejun Heo * 1001c9e7cf27STejun Heo * Find a worker which is executing @work on @pool by searching 1002c9e7cf27STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 1003a2c1c57bSTejun Heo * to match, its current execution should match the address of @work and 1004a2c1c57bSTejun Heo * its work function. This is to avoid unwanted dependency between 1005a2c1c57bSTejun Heo * unrelated work executions through a work item being recycled while still 1006a2c1c57bSTejun Heo * being executed. 1007a2c1c57bSTejun Heo * 1008a2c1c57bSTejun Heo * This is a bit tricky. A work item may be freed once its execution 1009a2c1c57bSTejun Heo * starts and nothing prevents the freed area from being recycled for 1010a2c1c57bSTejun Heo * another work item. If the same work item address ends up being reused 1011a2c1c57bSTejun Heo * before the original execution finishes, workqueue will identify the 1012a2c1c57bSTejun Heo * recycled work item as currently executing and make it wait until the 1013a2c1c57bSTejun Heo * current execution finishes, introducing an unwanted dependency. 1014a2c1c57bSTejun Heo * 1015c5aa87bbSTejun Heo * This function checks the work item address and work function to avoid 1016c5aa87bbSTejun Heo * false positives. Note that this isn't complete as one may construct a 1017c5aa87bbSTejun Heo * work function which can introduce dependency onto itself through a 1018c5aa87bbSTejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 1019c5aa87bbSTejun Heo * foot that badly, there's only so much we can do, and if such deadlock 1020c5aa87bbSTejun Heo * actually occurs, it should be easy to locate the culprit work function. 10218cca0eeaSTejun Heo * 10228cca0eeaSTejun Heo * CONTEXT: 1023d565ed63STejun Heo * spin_lock_irq(pool->lock). 10248cca0eeaSTejun Heo * 1025d185af30SYacine Belkadi * Return: 1026d185af30SYacine Belkadi * Pointer to worker which is executing @work if found, %NULL 10278cca0eeaSTejun Heo * otherwise. 10288cca0eeaSTejun Heo */ 1029c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 10308cca0eeaSTejun Heo struct work_struct *work) 10318cca0eeaSTejun Heo { 103242f8570fSSasha Levin struct worker *worker; 103342f8570fSSasha Levin 1034b67bfe0dSSasha Levin hash_for_each_possible(pool->busy_hash, worker, hentry, 1035a2c1c57bSTejun Heo (unsigned long)work) 1036a2c1c57bSTejun Heo if (worker->current_work == work && 1037a2c1c57bSTejun Heo worker->current_func == work->func) 103842f8570fSSasha Levin return worker; 103942f8570fSSasha Levin 104042f8570fSSasha Levin return NULL; 10418cca0eeaSTejun Heo } 10428cca0eeaSTejun Heo 10438cca0eeaSTejun Heo /** 1044bf4ede01STejun Heo * move_linked_works - move linked works to a list 1045bf4ede01STejun Heo * @work: start of series of works to be scheduled 1046bf4ede01STejun Heo * @head: target list to append @work to 1047402dd89dSShailendra Verma * @nextp: out parameter for nested worklist walking 1048bf4ede01STejun Heo * 1049bf4ede01STejun Heo * Schedule linked works starting from @work to @head. Work series to 1050bf4ede01STejun Heo * be scheduled starts at @work and includes any consecutive work with 1051bf4ede01STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 1052bf4ede01STejun Heo * 1053bf4ede01STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 1054bf4ede01STejun Heo * the last scheduled work. This allows move_linked_works() to be 1055bf4ede01STejun Heo * nested inside outer list_for_each_entry_safe(). 1056bf4ede01STejun Heo * 1057bf4ede01STejun Heo * CONTEXT: 1058d565ed63STejun Heo * spin_lock_irq(pool->lock). 1059bf4ede01STejun Heo */ 1060bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 1061bf4ede01STejun Heo struct work_struct **nextp) 1062bf4ede01STejun Heo { 1063bf4ede01STejun Heo struct work_struct *n; 1064bf4ede01STejun Heo 1065bf4ede01STejun Heo /* 1066bf4ede01STejun Heo * Linked worklist will always end before the end of the list, 1067bf4ede01STejun Heo * use NULL for list head. 1068bf4ede01STejun Heo */ 1069bf4ede01STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1070bf4ede01STejun Heo list_move_tail(&work->entry, head); 1071bf4ede01STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1072bf4ede01STejun Heo break; 1073bf4ede01STejun Heo } 1074bf4ede01STejun Heo 1075bf4ede01STejun Heo /* 1076bf4ede01STejun Heo * If we're already inside safe list traversal and have moved 1077bf4ede01STejun Heo * multiple works to the scheduled queue, the next position 1078bf4ede01STejun Heo * needs to be updated. 1079bf4ede01STejun Heo */ 1080bf4ede01STejun Heo if (nextp) 1081bf4ede01STejun Heo *nextp = n; 1082bf4ede01STejun Heo } 1083bf4ede01STejun Heo 10848864b4e5STejun Heo /** 10858864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 10868864b4e5STejun Heo * @pwq: pool_workqueue to get 10878864b4e5STejun Heo * 10888864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 10898864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 10908864b4e5STejun Heo */ 10918864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 10928864b4e5STejun Heo { 10938864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 10948864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 10958864b4e5STejun Heo pwq->refcnt++; 10968864b4e5STejun Heo } 10978864b4e5STejun Heo 10988864b4e5STejun Heo /** 10998864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 11008864b4e5STejun Heo * @pwq: pool_workqueue to put 11018864b4e5STejun Heo * 11028864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 11038864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 11048864b4e5STejun Heo */ 11058864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 11068864b4e5STejun Heo { 11078864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 11088864b4e5STejun Heo if (likely(--pwq->refcnt)) 11098864b4e5STejun Heo return; 11108864b4e5STejun Heo if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND))) 11118864b4e5STejun Heo return; 11128864b4e5STejun Heo /* 11138864b4e5STejun Heo * @pwq can't be released under pool->lock, bounce to 11148864b4e5STejun Heo * pwq_unbound_release_workfn(). This never recurses on the same 11158864b4e5STejun Heo * pool->lock as this path is taken only for unbound workqueues and 11168864b4e5STejun Heo * the release work item is scheduled on a per-cpu workqueue. To 11178864b4e5STejun Heo * avoid lockdep warning, unbound pool->locks are given lockdep 11188864b4e5STejun Heo * subclass of 1 in get_unbound_pool(). 11198864b4e5STejun Heo */ 11208864b4e5STejun Heo schedule_work(&pwq->unbound_release_work); 11218864b4e5STejun Heo } 11228864b4e5STejun Heo 1123dce90d47STejun Heo /** 1124dce90d47STejun Heo * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock 1125dce90d47STejun Heo * @pwq: pool_workqueue to put (can be %NULL) 1126dce90d47STejun Heo * 1127dce90d47STejun Heo * put_pwq() with locking. This function also allows %NULL @pwq. 1128dce90d47STejun Heo */ 1129dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq) 1130dce90d47STejun Heo { 1131dce90d47STejun Heo if (pwq) { 1132dce90d47STejun Heo /* 113324acfb71SThomas Gleixner * As both pwqs and pools are RCU protected, the 1134dce90d47STejun Heo * following lock operations are safe. 1135dce90d47STejun Heo */ 1136dce90d47STejun Heo spin_lock_irq(&pwq->pool->lock); 1137dce90d47STejun Heo put_pwq(pwq); 1138dce90d47STejun Heo spin_unlock_irq(&pwq->pool->lock); 1139dce90d47STejun Heo } 1140dce90d47STejun Heo } 1141dce90d47STejun Heo 1142112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work) 1143bf4ede01STejun Heo { 1144112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1145bf4ede01STejun Heo 1146bf4ede01STejun Heo trace_workqueue_activate_work(work); 114782607adcSTejun Heo if (list_empty(&pwq->pool->worklist)) 114882607adcSTejun Heo pwq->pool->watchdog_ts = jiffies; 1149112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 1150bf4ede01STejun Heo __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); 1151112202d9STejun Heo pwq->nr_active++; 1152bf4ede01STejun Heo } 1153bf4ede01STejun Heo 1154112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq) 11553aa62497SLai Jiangshan { 1156112202d9STejun Heo struct work_struct *work = list_first_entry(&pwq->delayed_works, 11573aa62497SLai Jiangshan struct work_struct, entry); 11583aa62497SLai Jiangshan 1159112202d9STejun Heo pwq_activate_delayed_work(work); 11603aa62497SLai Jiangshan } 11613aa62497SLai Jiangshan 1162bf4ede01STejun Heo /** 1163112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1164112202d9STejun Heo * @pwq: pwq of interest 1165bf4ede01STejun Heo * @color: color of work which left the queue 1166bf4ede01STejun Heo * 1167bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1168112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1169bf4ede01STejun Heo * 1170bf4ede01STejun Heo * CONTEXT: 1171d565ed63STejun Heo * spin_lock_irq(pool->lock). 1172bf4ede01STejun Heo */ 1173112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color) 1174bf4ede01STejun Heo { 11758864b4e5STejun Heo /* uncolored work items don't participate in flushing or nr_active */ 1176bf4ede01STejun Heo if (color == WORK_NO_COLOR) 11778864b4e5STejun Heo goto out_put; 1178bf4ede01STejun Heo 1179112202d9STejun Heo pwq->nr_in_flight[color]--; 1180bf4ede01STejun Heo 1181112202d9STejun Heo pwq->nr_active--; 1182112202d9STejun Heo if (!list_empty(&pwq->delayed_works)) { 1183bf4ede01STejun Heo /* one down, submit a delayed one */ 1184112202d9STejun Heo if (pwq->nr_active < pwq->max_active) 1185112202d9STejun Heo pwq_activate_first_delayed(pwq); 1186bf4ede01STejun Heo } 1187bf4ede01STejun Heo 1188bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1189112202d9STejun Heo if (likely(pwq->flush_color != color)) 11908864b4e5STejun Heo goto out_put; 1191bf4ede01STejun Heo 1192bf4ede01STejun Heo /* are there still in-flight works? */ 1193112202d9STejun Heo if (pwq->nr_in_flight[color]) 11948864b4e5STejun Heo goto out_put; 1195bf4ede01STejun Heo 1196112202d9STejun Heo /* this pwq is done, clear flush_color */ 1197112202d9STejun Heo pwq->flush_color = -1; 1198bf4ede01STejun Heo 1199bf4ede01STejun Heo /* 1200112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 1201bf4ede01STejun Heo * will handle the rest. 1202bf4ede01STejun Heo */ 1203112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 1204112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 12058864b4e5STejun Heo out_put: 12068864b4e5STejun Heo put_pwq(pwq); 1207bf4ede01STejun Heo } 1208bf4ede01STejun Heo 120936e227d2STejun Heo /** 1210bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 121136e227d2STejun Heo * @work: work item to steal 121236e227d2STejun Heo * @is_dwork: @work is a delayed_work 1213bbb68dfaSTejun Heo * @flags: place to store irq state 121436e227d2STejun Heo * 121536e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 1216d185af30SYacine Belkadi * stable state - idle, on timer or on worklist. 121736e227d2STejun Heo * 1218d185af30SYacine Belkadi * Return: 121936e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 122036e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 122136e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1222bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1223bbb68dfaSTejun Heo * for arbitrarily long 122436e227d2STejun Heo * 1225d185af30SYacine Belkadi * Note: 1226bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1227e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1228e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1229e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1230bbb68dfaSTejun Heo * 1231bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1232bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1233bbb68dfaSTejun Heo * 1234e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1235bf4ede01STejun Heo */ 1236bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1237bbb68dfaSTejun Heo unsigned long *flags) 1238bf4ede01STejun Heo { 1239d565ed63STejun Heo struct worker_pool *pool; 1240112202d9STejun Heo struct pool_workqueue *pwq; 1241bf4ede01STejun Heo 1242bbb68dfaSTejun Heo local_irq_save(*flags); 1243bbb68dfaSTejun Heo 124436e227d2STejun Heo /* try to steal the timer if it exists */ 124536e227d2STejun Heo if (is_dwork) { 124636e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 124736e227d2STejun Heo 1248e0aecdd8STejun Heo /* 1249e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1250e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1251e0aecdd8STejun Heo * running on the local CPU. 1252e0aecdd8STejun Heo */ 125336e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 125436e227d2STejun Heo return 1; 125536e227d2STejun Heo } 125636e227d2STejun Heo 125736e227d2STejun Heo /* try to claim PENDING the normal way */ 1258bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1259bf4ede01STejun Heo return 0; 1260bf4ede01STejun Heo 126124acfb71SThomas Gleixner rcu_read_lock(); 1262bf4ede01STejun Heo /* 1263bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1264bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1265bf4ede01STejun Heo */ 1266d565ed63STejun Heo pool = get_work_pool(work); 1267d565ed63STejun Heo if (!pool) 1268bbb68dfaSTejun Heo goto fail; 1269bf4ede01STejun Heo 1270d565ed63STejun Heo spin_lock(&pool->lock); 1271bf4ede01STejun Heo /* 1272112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 1273112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 1274112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 1275112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 1276112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 12770b3dae68SLai Jiangshan * item is currently queued on that pool. 1278bf4ede01STejun Heo */ 1279112202d9STejun Heo pwq = get_work_pwq(work); 1280112202d9STejun Heo if (pwq && pwq->pool == pool) { 1281bf4ede01STejun Heo debug_work_deactivate(work); 12823aa62497SLai Jiangshan 12833aa62497SLai Jiangshan /* 128416062836STejun Heo * A delayed work item cannot be grabbed directly because 128516062836STejun Heo * it might have linked NO_COLOR work items which, if left 1286112202d9STejun Heo * on the delayed_list, will confuse pwq->nr_active 128716062836STejun Heo * management later on and cause stall. Make sure the work 128816062836STejun Heo * item is activated before grabbing. 12893aa62497SLai Jiangshan */ 12903aa62497SLai Jiangshan if (*work_data_bits(work) & WORK_STRUCT_DELAYED) 1291112202d9STejun Heo pwq_activate_delayed_work(work); 12923aa62497SLai Jiangshan 1293bf4ede01STejun Heo list_del_init(&work->entry); 12949c34a704SLai Jiangshan pwq_dec_nr_in_flight(pwq, get_work_color(work)); 129536e227d2STejun Heo 1296112202d9STejun Heo /* work->data points to pwq iff queued, point to pool */ 12974468a00fSLai Jiangshan set_work_pool_and_keep_pending(work, pool->id); 12984468a00fSLai Jiangshan 1299d565ed63STejun Heo spin_unlock(&pool->lock); 130024acfb71SThomas Gleixner rcu_read_unlock(); 130136e227d2STejun Heo return 1; 1302bf4ede01STejun Heo } 1303d565ed63STejun Heo spin_unlock(&pool->lock); 1304bbb68dfaSTejun Heo fail: 130524acfb71SThomas Gleixner rcu_read_unlock(); 1306bbb68dfaSTejun Heo local_irq_restore(*flags); 1307bbb68dfaSTejun Heo if (work_is_canceling(work)) 1308bbb68dfaSTejun Heo return -ENOENT; 1309bbb68dfaSTejun Heo cpu_relax(); 131036e227d2STejun Heo return -EAGAIN; 1311bf4ede01STejun Heo } 1312bf4ede01STejun Heo 1313bf4ede01STejun Heo /** 1314706026c2STejun Heo * insert_work - insert a work into a pool 1315112202d9STejun Heo * @pwq: pwq @work belongs to 13164690c4abSTejun Heo * @work: work to insert 13174690c4abSTejun Heo * @head: insertion point 13184690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 13194690c4abSTejun Heo * 1320112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 1321706026c2STejun Heo * work_struct flags. 13224690c4abSTejun Heo * 13234690c4abSTejun Heo * CONTEXT: 1324d565ed63STejun Heo * spin_lock_irq(pool->lock). 1325365970a1SDavid Howells */ 1326112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 1327112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 1328b89deed3SOleg Nesterov { 1329112202d9STejun Heo struct worker_pool *pool = pwq->pool; 1330e1d8aa9fSFrederic Weisbecker 13314690c4abSTejun Heo /* we own @work, set data and link */ 1332112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 13331a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 13348864b4e5STejun Heo get_pwq(pwq); 1335e22bee78STejun Heo 1336e22bee78STejun Heo /* 1337c5aa87bbSTejun Heo * Ensure either wq_worker_sleeping() sees the above 1338c5aa87bbSTejun Heo * list_add_tail() or we see zero nr_running to avoid workers lying 1339c5aa87bbSTejun Heo * around lazily while there are works to be processed. 1340e22bee78STejun Heo */ 1341e22bee78STejun Heo smp_mb(); 1342e22bee78STejun Heo 134363d95a91STejun Heo if (__need_more_worker(pool)) 134463d95a91STejun Heo wake_up_worker(pool); 1345b89deed3SOleg Nesterov } 1346b89deed3SOleg Nesterov 1347c8efcc25STejun Heo /* 1348c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 13498d03ecfeSTejun Heo * same workqueue. 1350c8efcc25STejun Heo */ 1351c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1352c8efcc25STejun Heo { 1353c8efcc25STejun Heo struct worker *worker; 1354c8efcc25STejun Heo 13558d03ecfeSTejun Heo worker = current_wq_worker(); 1356c8efcc25STejun Heo /* 1357bf393fd4SBart Van Assche * Return %true iff I'm a worker executing a work item on @wq. If 13588d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 1359c8efcc25STejun Heo */ 1360112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 1361c8efcc25STejun Heo } 1362c8efcc25STejun Heo 1363ef557180SMike Galbraith /* 1364ef557180SMike Galbraith * When queueing an unbound work item to a wq, prefer local CPU if allowed 1365ef557180SMike Galbraith * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to 1366ef557180SMike Galbraith * avoid perturbing sensitive tasks. 1367ef557180SMike Galbraith */ 1368ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu) 1369ef557180SMike Galbraith { 1370f303fccbSTejun Heo static bool printed_dbg_warning; 1371ef557180SMike Galbraith int new_cpu; 1372ef557180SMike Galbraith 1373f303fccbSTejun Heo if (likely(!wq_debug_force_rr_cpu)) { 1374ef557180SMike Galbraith if (cpumask_test_cpu(cpu, wq_unbound_cpumask)) 1375ef557180SMike Galbraith return cpu; 1376f303fccbSTejun Heo } else if (!printed_dbg_warning) { 1377f303fccbSTejun Heo pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n"); 1378f303fccbSTejun Heo printed_dbg_warning = true; 1379f303fccbSTejun Heo } 1380f303fccbSTejun Heo 1381ef557180SMike Galbraith if (cpumask_empty(wq_unbound_cpumask)) 1382ef557180SMike Galbraith return cpu; 1383ef557180SMike Galbraith 1384ef557180SMike Galbraith new_cpu = __this_cpu_read(wq_rr_cpu_last); 1385ef557180SMike Galbraith new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask); 1386ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) { 1387ef557180SMike Galbraith new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask); 1388ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) 1389ef557180SMike Galbraith return cpu; 1390ef557180SMike Galbraith } 1391ef557180SMike Galbraith __this_cpu_write(wq_rr_cpu_last, new_cpu); 1392ef557180SMike Galbraith 1393ef557180SMike Galbraith return new_cpu; 1394ef557180SMike Galbraith } 1395ef557180SMike Galbraith 1396d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 13971da177e4SLinus Torvalds struct work_struct *work) 13981da177e4SLinus Torvalds { 1399112202d9STejun Heo struct pool_workqueue *pwq; 1400c9178087STejun Heo struct worker_pool *last_pool; 14011e19ffc6STejun Heo struct list_head *worklist; 14028a2e8e5dSTejun Heo unsigned int work_flags; 1403b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 14048930cabaSTejun Heo 14058930cabaSTejun Heo /* 14068930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 14078930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 14088930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 14098930cabaSTejun Heo * happen with IRQ disabled. 14108930cabaSTejun Heo */ 14118e8eb730SFrederic Weisbecker lockdep_assert_irqs_disabled(); 14121da177e4SLinus Torvalds 1413dc186ad7SThomas Gleixner debug_work_activate(work); 14141e19ffc6STejun Heo 14159ef28a73SLi Bin /* if draining, only works from the same workqueue are allowed */ 1416618b01ebSTejun Heo if (unlikely(wq->flags & __WQ_DRAINING) && 1417c8efcc25STejun Heo WARN_ON_ONCE(!is_chained_work(wq))) 1418e41e704bSTejun Heo return; 141924acfb71SThomas Gleixner rcu_read_lock(); 14209e8cd2f5STejun Heo retry: 1421df2d5ae4STejun Heo if (req_cpu == WORK_CPU_UNBOUND) 1422ef557180SMike Galbraith cpu = wq_select_unbound_cpu(raw_smp_processor_id()); 1423df2d5ae4STejun Heo 1424df2d5ae4STejun Heo /* pwq which will be used unless @work is executing elsewhere */ 1425df2d5ae4STejun Heo if (!(wq->flags & WQ_UNBOUND)) 1426c9178087STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 1427df2d5ae4STejun Heo else 1428df2d5ae4STejun Heo pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); 1429f3421797STejun Heo 143018aa9effSTejun Heo /* 1431c9178087STejun Heo * If @work was previously on a different pool, it might still be 1432c9178087STejun Heo * running there, in which case the work needs to be queued on that 1433c9178087STejun Heo * pool to guarantee non-reentrancy. 143418aa9effSTejun Heo */ 1435c9e7cf27STejun Heo last_pool = get_work_pool(work); 1436112202d9STejun Heo if (last_pool && last_pool != pwq->pool) { 143718aa9effSTejun Heo struct worker *worker; 143818aa9effSTejun Heo 1439d565ed63STejun Heo spin_lock(&last_pool->lock); 144018aa9effSTejun Heo 1441c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 144218aa9effSTejun Heo 1443112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 1444c9178087STejun Heo pwq = worker->current_pwq; 14458594fadeSLai Jiangshan } else { 144618aa9effSTejun Heo /* meh... not running there, queue here */ 1447d565ed63STejun Heo spin_unlock(&last_pool->lock); 1448112202d9STejun Heo spin_lock(&pwq->pool->lock); 144918aa9effSTejun Heo } 14508930cabaSTejun Heo } else { 1451112202d9STejun Heo spin_lock(&pwq->pool->lock); 14528930cabaSTejun Heo } 1453502ca9d8STejun Heo 14549e8cd2f5STejun Heo /* 14559e8cd2f5STejun Heo * pwq is determined and locked. For unbound pools, we could have 14569e8cd2f5STejun Heo * raced with pwq release and it could already be dead. If its 14579e8cd2f5STejun Heo * refcnt is zero, repeat pwq selection. Note that pwqs never die 1458df2d5ae4STejun Heo * without another pwq replacing it in the numa_pwq_tbl or while 1459df2d5ae4STejun Heo * work items are executing on it, so the retrying is guaranteed to 14609e8cd2f5STejun Heo * make forward-progress. 14619e8cd2f5STejun Heo */ 14629e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 14639e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 14649e8cd2f5STejun Heo spin_unlock(&pwq->pool->lock); 14659e8cd2f5STejun Heo cpu_relax(); 14669e8cd2f5STejun Heo goto retry; 14679e8cd2f5STejun Heo } 14689e8cd2f5STejun Heo /* oops */ 14699e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 14709e8cd2f5STejun Heo wq->name, cpu); 14719e8cd2f5STejun Heo } 14729e8cd2f5STejun Heo 1473112202d9STejun Heo /* pwq determined, queue */ 1474112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 1475502ca9d8STejun Heo 147624acfb71SThomas Gleixner if (WARN_ON(!list_empty(&work->entry))) 147724acfb71SThomas Gleixner goto out; 14781e19ffc6STejun Heo 1479112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 1480112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 14811e19ffc6STejun Heo 1482112202d9STejun Heo if (likely(pwq->nr_active < pwq->max_active)) { 1483cdadf009STejun Heo trace_workqueue_activate_work(work); 1484112202d9STejun Heo pwq->nr_active++; 1485112202d9STejun Heo worklist = &pwq->pool->worklist; 148682607adcSTejun Heo if (list_empty(worklist)) 148782607adcSTejun Heo pwq->pool->watchdog_ts = jiffies; 14888a2e8e5dSTejun Heo } else { 14898a2e8e5dSTejun Heo work_flags |= WORK_STRUCT_DELAYED; 1490112202d9STejun Heo worklist = &pwq->delayed_works; 14918a2e8e5dSTejun Heo } 14921e19ffc6STejun Heo 1493112202d9STejun Heo insert_work(pwq, work, worklist, work_flags); 14941e19ffc6STejun Heo 149524acfb71SThomas Gleixner out: 1496112202d9STejun Heo spin_unlock(&pwq->pool->lock); 149724acfb71SThomas Gleixner rcu_read_unlock(); 14981da177e4SLinus Torvalds } 14991da177e4SLinus Torvalds 15000fcb78c2SRolf Eike Beer /** 1501c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1502c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1503c1a220e7SZhang Rui * @wq: workqueue to use 1504c1a220e7SZhang Rui * @work: work to queue 1505c1a220e7SZhang Rui * 1506c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1507c1a220e7SZhang Rui * can't go away. 1508d185af30SYacine Belkadi * 1509d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. 1510c1a220e7SZhang Rui */ 1511d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1512d4283e93STejun Heo struct work_struct *work) 1513c1a220e7SZhang Rui { 1514d4283e93STejun Heo bool ret = false; 15158930cabaSTejun Heo unsigned long flags; 15168930cabaSTejun Heo 15178930cabaSTejun Heo local_irq_save(flags); 1518c1a220e7SZhang Rui 151922df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 15204690c4abSTejun Heo __queue_work(cpu, wq, work); 1521d4283e93STejun Heo ret = true; 1522c1a220e7SZhang Rui } 15238930cabaSTejun Heo 15248930cabaSTejun Heo local_irq_restore(flags); 1525c1a220e7SZhang Rui return ret; 1526c1a220e7SZhang Rui } 1527ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on); 1528c1a220e7SZhang Rui 15298204e0c1SAlexander Duyck /** 15308204e0c1SAlexander Duyck * workqueue_select_cpu_near - Select a CPU based on NUMA node 15318204e0c1SAlexander Duyck * @node: NUMA node ID that we want to select a CPU from 15328204e0c1SAlexander Duyck * 15338204e0c1SAlexander Duyck * This function will attempt to find a "random" cpu available on a given 15348204e0c1SAlexander Duyck * node. If there are no CPUs available on the given node it will return 15358204e0c1SAlexander Duyck * WORK_CPU_UNBOUND indicating that we should just schedule to any 15368204e0c1SAlexander Duyck * available CPU if we need to schedule this work. 15378204e0c1SAlexander Duyck */ 15388204e0c1SAlexander Duyck static int workqueue_select_cpu_near(int node) 15398204e0c1SAlexander Duyck { 15408204e0c1SAlexander Duyck int cpu; 15418204e0c1SAlexander Duyck 15428204e0c1SAlexander Duyck /* No point in doing this if NUMA isn't enabled for workqueues */ 15438204e0c1SAlexander Duyck if (!wq_numa_enabled) 15448204e0c1SAlexander Duyck return WORK_CPU_UNBOUND; 15458204e0c1SAlexander Duyck 15468204e0c1SAlexander Duyck /* Delay binding to CPU if node is not valid or online */ 15478204e0c1SAlexander Duyck if (node < 0 || node >= MAX_NUMNODES || !node_online(node)) 15488204e0c1SAlexander Duyck return WORK_CPU_UNBOUND; 15498204e0c1SAlexander Duyck 15508204e0c1SAlexander Duyck /* Use local node/cpu if we are already there */ 15518204e0c1SAlexander Duyck cpu = raw_smp_processor_id(); 15528204e0c1SAlexander Duyck if (node == cpu_to_node(cpu)) 15538204e0c1SAlexander Duyck return cpu; 15548204e0c1SAlexander Duyck 15558204e0c1SAlexander Duyck /* Use "random" otherwise know as "first" online CPU of node */ 15568204e0c1SAlexander Duyck cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask); 15578204e0c1SAlexander Duyck 15588204e0c1SAlexander Duyck /* If CPU is valid return that, otherwise just defer */ 15598204e0c1SAlexander Duyck return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND; 15608204e0c1SAlexander Duyck } 15618204e0c1SAlexander Duyck 15628204e0c1SAlexander Duyck /** 15638204e0c1SAlexander Duyck * queue_work_node - queue work on a "random" cpu for a given NUMA node 15648204e0c1SAlexander Duyck * @node: NUMA node that we are targeting the work for 15658204e0c1SAlexander Duyck * @wq: workqueue to use 15668204e0c1SAlexander Duyck * @work: work to queue 15678204e0c1SAlexander Duyck * 15688204e0c1SAlexander Duyck * We queue the work to a "random" CPU within a given NUMA node. The basic 15698204e0c1SAlexander Duyck * idea here is to provide a way to somehow associate work with a given 15708204e0c1SAlexander Duyck * NUMA node. 15718204e0c1SAlexander Duyck * 15728204e0c1SAlexander Duyck * This function will only make a best effort attempt at getting this onto 15738204e0c1SAlexander Duyck * the right NUMA node. If no node is requested or the requested node is 15748204e0c1SAlexander Duyck * offline then we just fall back to standard queue_work behavior. 15758204e0c1SAlexander Duyck * 15768204e0c1SAlexander Duyck * Currently the "random" CPU ends up being the first available CPU in the 15778204e0c1SAlexander Duyck * intersection of cpu_online_mask and the cpumask of the node, unless we 15788204e0c1SAlexander Duyck * are running on the node. In that case we just use the current CPU. 15798204e0c1SAlexander Duyck * 15808204e0c1SAlexander Duyck * Return: %false if @work was already on a queue, %true otherwise. 15818204e0c1SAlexander Duyck */ 15828204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq, 15838204e0c1SAlexander Duyck struct work_struct *work) 15848204e0c1SAlexander Duyck { 15858204e0c1SAlexander Duyck unsigned long flags; 15868204e0c1SAlexander Duyck bool ret = false; 15878204e0c1SAlexander Duyck 15888204e0c1SAlexander Duyck /* 15898204e0c1SAlexander Duyck * This current implementation is specific to unbound workqueues. 15908204e0c1SAlexander Duyck * Specifically we only return the first available CPU for a given 15918204e0c1SAlexander Duyck * node instead of cycling through individual CPUs within the node. 15928204e0c1SAlexander Duyck * 15938204e0c1SAlexander Duyck * If this is used with a per-cpu workqueue then the logic in 15948204e0c1SAlexander Duyck * workqueue_select_cpu_near would need to be updated to allow for 15958204e0c1SAlexander Duyck * some round robin type logic. 15968204e0c1SAlexander Duyck */ 15978204e0c1SAlexander Duyck WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)); 15988204e0c1SAlexander Duyck 15998204e0c1SAlexander Duyck local_irq_save(flags); 16008204e0c1SAlexander Duyck 16018204e0c1SAlexander Duyck if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 16028204e0c1SAlexander Duyck int cpu = workqueue_select_cpu_near(node); 16038204e0c1SAlexander Duyck 16048204e0c1SAlexander Duyck __queue_work(cpu, wq, work); 16058204e0c1SAlexander Duyck ret = true; 16068204e0c1SAlexander Duyck } 16078204e0c1SAlexander Duyck 16088204e0c1SAlexander Duyck local_irq_restore(flags); 16098204e0c1SAlexander Duyck return ret; 16108204e0c1SAlexander Duyck } 16118204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node); 16128204e0c1SAlexander Duyck 16138c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t) 16141da177e4SLinus Torvalds { 16158c20feb6SKees Cook struct delayed_work *dwork = from_timer(dwork, t, timer); 16161da177e4SLinus Torvalds 1617e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 161860c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 16191da177e4SLinus Torvalds } 16201438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 16211da177e4SLinus Torvalds 16227beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 162352bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 16241da177e4SLinus Torvalds { 16257beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 16267beb2edfSTejun Heo struct work_struct *work = &dwork->work; 16271da177e4SLinus Torvalds 1628637fdbaeSTejun Heo WARN_ON_ONCE(!wq); 1629841b86f3SKees Cook WARN_ON_ONCE(timer->function != delayed_work_timer_fn); 1630fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 1631fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 16327beb2edfSTejun Heo 16338852aac2STejun Heo /* 16348852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 16358852aac2STejun Heo * both optimization and correctness. The earliest @timer can 16368852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 16378852aac2STejun Heo * on that there's no such delay when @delay is 0. 16388852aac2STejun Heo */ 16398852aac2STejun Heo if (!delay) { 16408852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 16418852aac2STejun Heo return; 16428852aac2STejun Heo } 16438852aac2STejun Heo 164460c057bcSLai Jiangshan dwork->wq = wq; 16451265057fSTejun Heo dwork->cpu = cpu; 16467beb2edfSTejun Heo timer->expires = jiffies + delay; 16477beb2edfSTejun Heo 1648041bd12eSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 16497beb2edfSTejun Heo add_timer_on(timer, cpu); 1650041bd12eSTejun Heo else 1651041bd12eSTejun Heo add_timer(timer); 16527beb2edfSTejun Heo } 16531da177e4SLinus Torvalds 16540fcb78c2SRolf Eike Beer /** 16550fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 16560fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 16570fcb78c2SRolf Eike Beer * @wq: workqueue to use 1658af9997e4SRandy Dunlap * @dwork: work to queue 16590fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 16600fcb78c2SRolf Eike Beer * 1661d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. If 1662715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 1663715f1300STejun Heo * execution. 16640fcb78c2SRolf Eike Beer */ 1665d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 166652bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 16677a6bc1cdSVenkatesh Pallipadi { 166852bad64dSDavid Howells struct work_struct *work = &dwork->work; 1669d4283e93STejun Heo bool ret = false; 16708930cabaSTejun Heo unsigned long flags; 16718930cabaSTejun Heo 16728930cabaSTejun Heo /* read the comment in __queue_work() */ 16738930cabaSTejun Heo local_irq_save(flags); 16747a6bc1cdSVenkatesh Pallipadi 167522df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 16767beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 1677d4283e93STejun Heo ret = true; 16787a6bc1cdSVenkatesh Pallipadi } 16798930cabaSTejun Heo 16808930cabaSTejun Heo local_irq_restore(flags); 16817a6bc1cdSVenkatesh Pallipadi return ret; 16827a6bc1cdSVenkatesh Pallipadi } 1683ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on); 16841da177e4SLinus Torvalds 1685c8e55f36STejun Heo /** 16868376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 16878376fe22STejun Heo * @cpu: CPU number to execute work on 16888376fe22STejun Heo * @wq: workqueue to use 16898376fe22STejun Heo * @dwork: work to queue 16908376fe22STejun Heo * @delay: number of jiffies to wait before queueing 16918376fe22STejun Heo * 16928376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 16938376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 16948376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 16958376fe22STejun Heo * current state. 16968376fe22STejun Heo * 1697d185af30SYacine Belkadi * Return: %false if @dwork was idle and queued, %true if @dwork was 16988376fe22STejun Heo * pending and its timer was modified. 16998376fe22STejun Heo * 1700e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 17018376fe22STejun Heo * See try_to_grab_pending() for details. 17028376fe22STejun Heo */ 17038376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 17048376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 17058376fe22STejun Heo { 17068376fe22STejun Heo unsigned long flags; 17078376fe22STejun Heo int ret; 17088376fe22STejun Heo 17098376fe22STejun Heo do { 17108376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 17118376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 17128376fe22STejun Heo 17138376fe22STejun Heo if (likely(ret >= 0)) { 17148376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 17158376fe22STejun Heo local_irq_restore(flags); 17168376fe22STejun Heo } 17178376fe22STejun Heo 17188376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 17198376fe22STejun Heo return ret; 17208376fe22STejun Heo } 17218376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 17228376fe22STejun Heo 172305f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu) 172405f0fe6bSTejun Heo { 172505f0fe6bSTejun Heo struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu); 172605f0fe6bSTejun Heo 172705f0fe6bSTejun Heo /* read the comment in __queue_work() */ 172805f0fe6bSTejun Heo local_irq_disable(); 172905f0fe6bSTejun Heo __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work); 173005f0fe6bSTejun Heo local_irq_enable(); 173105f0fe6bSTejun Heo } 173205f0fe6bSTejun Heo 173305f0fe6bSTejun Heo /** 173405f0fe6bSTejun Heo * queue_rcu_work - queue work after a RCU grace period 173505f0fe6bSTejun Heo * @wq: workqueue to use 173605f0fe6bSTejun Heo * @rwork: work to queue 173705f0fe6bSTejun Heo * 173805f0fe6bSTejun Heo * Return: %false if @rwork was already pending, %true otherwise. Note 173905f0fe6bSTejun Heo * that a full RCU grace period is guaranteed only after a %true return. 1740bf393fd4SBart Van Assche * While @rwork is guaranteed to be executed after a %false return, the 174105f0fe6bSTejun Heo * execution may happen before a full RCU grace period has passed. 174205f0fe6bSTejun Heo */ 174305f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork) 174405f0fe6bSTejun Heo { 174505f0fe6bSTejun Heo struct work_struct *work = &rwork->work; 174605f0fe6bSTejun Heo 174705f0fe6bSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 174805f0fe6bSTejun Heo rwork->wq = wq; 174905f0fe6bSTejun Heo call_rcu(&rwork->rcu, rcu_work_rcufn); 175005f0fe6bSTejun Heo return true; 175105f0fe6bSTejun Heo } 175205f0fe6bSTejun Heo 175305f0fe6bSTejun Heo return false; 175405f0fe6bSTejun Heo } 175505f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work); 175605f0fe6bSTejun Heo 17578376fe22STejun Heo /** 1758c8e55f36STejun Heo * worker_enter_idle - enter idle state 1759c8e55f36STejun Heo * @worker: worker which is entering idle state 1760c8e55f36STejun Heo * 1761c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1762c8e55f36STejun Heo * necessary. 1763c8e55f36STejun Heo * 1764c8e55f36STejun Heo * LOCKING: 1765d565ed63STejun Heo * spin_lock_irq(pool->lock). 1766c8e55f36STejun Heo */ 1767c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 17681da177e4SLinus Torvalds { 1769bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1770c8e55f36STejun Heo 17716183c009STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 17726183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 17736183c009STejun Heo (worker->hentry.next || worker->hentry.pprev))) 17746183c009STejun Heo return; 1775c8e55f36STejun Heo 1776051e1850SLai Jiangshan /* can't use worker_set_flags(), also called from create_worker() */ 1777cb444766STejun Heo worker->flags |= WORKER_IDLE; 1778bd7bdd43STejun Heo pool->nr_idle++; 1779e22bee78STejun Heo worker->last_active = jiffies; 1780c8e55f36STejun Heo 1781c8e55f36STejun Heo /* idle_list is LIFO */ 1782bd7bdd43STejun Heo list_add(&worker->entry, &pool->idle_list); 1783db7bccf4STejun Heo 178463d95a91STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1785628c78e7STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1786cb444766STejun Heo 1787544ecf31STejun Heo /* 1788e8b3f8dbSLai Jiangshan * Sanity check nr_running. Because unbind_workers() releases 1789d565ed63STejun Heo * pool->lock between setting %WORKER_UNBOUND and zapping 1790628c78e7STejun Heo * nr_running, the warning may trigger spuriously. Check iff 1791628c78e7STejun Heo * unbind is not in progress. 1792544ecf31STejun Heo */ 179324647570STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 1794bd7bdd43STejun Heo pool->nr_workers == pool->nr_idle && 1795e19e397aSTejun Heo atomic_read(&pool->nr_running)); 1796c8e55f36STejun Heo } 1797c8e55f36STejun Heo 1798c8e55f36STejun Heo /** 1799c8e55f36STejun Heo * worker_leave_idle - leave idle state 1800c8e55f36STejun Heo * @worker: worker which is leaving idle state 1801c8e55f36STejun Heo * 1802c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1803c8e55f36STejun Heo * 1804c8e55f36STejun Heo * LOCKING: 1805d565ed63STejun Heo * spin_lock_irq(pool->lock). 1806c8e55f36STejun Heo */ 1807c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1808c8e55f36STejun Heo { 1809bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1810c8e55f36STejun Heo 18116183c009STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 18126183c009STejun Heo return; 1813d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1814bd7bdd43STejun Heo pool->nr_idle--; 1815c8e55f36STejun Heo list_del_init(&worker->entry); 1816c8e55f36STejun Heo } 1817c8e55f36STejun Heo 1818f7537df5SLai Jiangshan static struct worker *alloc_worker(int node) 1819c34056a3STejun Heo { 1820c34056a3STejun Heo struct worker *worker; 1821c34056a3STejun Heo 1822f7537df5SLai Jiangshan worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node); 1823c8e55f36STejun Heo if (worker) { 1824c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1825affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 1826da028469SLai Jiangshan INIT_LIST_HEAD(&worker->node); 1827e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1828e22bee78STejun Heo worker->flags = WORKER_PREP; 1829c8e55f36STejun Heo } 1830c34056a3STejun Heo return worker; 1831c34056a3STejun Heo } 1832c34056a3STejun Heo 1833c34056a3STejun Heo /** 18344736cbf7SLai Jiangshan * worker_attach_to_pool() - attach a worker to a pool 18354736cbf7SLai Jiangshan * @worker: worker to be attached 18364736cbf7SLai Jiangshan * @pool: the target pool 18374736cbf7SLai Jiangshan * 18384736cbf7SLai Jiangshan * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and 18394736cbf7SLai Jiangshan * cpu-binding of @worker are kept coordinated with the pool across 18404736cbf7SLai Jiangshan * cpu-[un]hotplugs. 18414736cbf7SLai Jiangshan */ 18424736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker, 18434736cbf7SLai Jiangshan struct worker_pool *pool) 18444736cbf7SLai Jiangshan { 18451258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 18464736cbf7SLai Jiangshan 18474736cbf7SLai Jiangshan /* 18484736cbf7SLai Jiangshan * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any 18494736cbf7SLai Jiangshan * online CPUs. It'll be re-applied when any of the CPUs come up. 18504736cbf7SLai Jiangshan */ 18514736cbf7SLai Jiangshan set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask); 18524736cbf7SLai Jiangshan 18534736cbf7SLai Jiangshan /* 18541258fae7STejun Heo * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains 18551258fae7STejun Heo * stable across this function. See the comments above the flag 18561258fae7STejun Heo * definition for details. 18574736cbf7SLai Jiangshan */ 18584736cbf7SLai Jiangshan if (pool->flags & POOL_DISASSOCIATED) 18594736cbf7SLai Jiangshan worker->flags |= WORKER_UNBOUND; 18604736cbf7SLai Jiangshan 18614736cbf7SLai Jiangshan list_add_tail(&worker->node, &pool->workers); 1862a2d812a2STejun Heo worker->pool = pool; 18634736cbf7SLai Jiangshan 18641258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 18654736cbf7SLai Jiangshan } 18664736cbf7SLai Jiangshan 18674736cbf7SLai Jiangshan /** 186860f5a4bcSLai Jiangshan * worker_detach_from_pool() - detach a worker from its pool 186960f5a4bcSLai Jiangshan * @worker: worker which is attached to its pool 187060f5a4bcSLai Jiangshan * 18714736cbf7SLai Jiangshan * Undo the attaching which had been done in worker_attach_to_pool(). The 18724736cbf7SLai Jiangshan * caller worker shouldn't access to the pool after detached except it has 18734736cbf7SLai Jiangshan * other reference to the pool. 187460f5a4bcSLai Jiangshan */ 1875a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker) 187660f5a4bcSLai Jiangshan { 1877a2d812a2STejun Heo struct worker_pool *pool = worker->pool; 187860f5a4bcSLai Jiangshan struct completion *detach_completion = NULL; 187960f5a4bcSLai Jiangshan 18801258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 1881a2d812a2STejun Heo 1882da028469SLai Jiangshan list_del(&worker->node); 1883a2d812a2STejun Heo worker->pool = NULL; 1884a2d812a2STejun Heo 1885da028469SLai Jiangshan if (list_empty(&pool->workers)) 188660f5a4bcSLai Jiangshan detach_completion = pool->detach_completion; 18871258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 188860f5a4bcSLai Jiangshan 1889b62c0751SLai Jiangshan /* clear leftover flags without pool->lock after it is detached */ 1890b62c0751SLai Jiangshan worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND); 1891b62c0751SLai Jiangshan 189260f5a4bcSLai Jiangshan if (detach_completion) 189360f5a4bcSLai Jiangshan complete(detach_completion); 189460f5a4bcSLai Jiangshan } 189560f5a4bcSLai Jiangshan 189660f5a4bcSLai Jiangshan /** 1897c34056a3STejun Heo * create_worker - create a new workqueue worker 189863d95a91STejun Heo * @pool: pool the new worker will belong to 1899c34056a3STejun Heo * 1900051e1850SLai Jiangshan * Create and start a new worker which is attached to @pool. 1901c34056a3STejun Heo * 1902c34056a3STejun Heo * CONTEXT: 1903c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1904c34056a3STejun Heo * 1905d185af30SYacine Belkadi * Return: 1906c34056a3STejun Heo * Pointer to the newly created worker. 1907c34056a3STejun Heo */ 1908bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 1909c34056a3STejun Heo { 1910c34056a3STejun Heo struct worker *worker = NULL; 1911f3421797STejun Heo int id = -1; 1912e3c916a4STejun Heo char id_buf[16]; 1913c34056a3STejun Heo 19147cda9aaeSLai Jiangshan /* ID is needed to determine kthread name */ 19157cda9aaeSLai Jiangshan id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL); 1916822d8405STejun Heo if (id < 0) 1917c34056a3STejun Heo goto fail; 1918c34056a3STejun Heo 1919f7537df5SLai Jiangshan worker = alloc_worker(pool->node); 1920c34056a3STejun Heo if (!worker) 1921c34056a3STejun Heo goto fail; 1922c34056a3STejun Heo 1923c34056a3STejun Heo worker->id = id; 1924c34056a3STejun Heo 192529c91e99STejun Heo if (pool->cpu >= 0) 1926e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, 1927e3c916a4STejun Heo pool->attrs->nice < 0 ? "H" : ""); 1928f3421797STejun Heo else 1929e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); 1930e3c916a4STejun Heo 1931f3f90ad4STejun Heo worker->task = kthread_create_on_node(worker_thread, worker, pool->node, 1932e3c916a4STejun Heo "kworker/%s", id_buf); 1933c34056a3STejun Heo if (IS_ERR(worker->task)) 1934c34056a3STejun Heo goto fail; 1935c34056a3STejun Heo 193691151228SOleg Nesterov set_user_nice(worker->task, pool->attrs->nice); 193725834c73SPeter Zijlstra kthread_bind_mask(worker->task, pool->attrs->cpumask); 193891151228SOleg Nesterov 1939da028469SLai Jiangshan /* successful, attach the worker to the pool */ 19404736cbf7SLai Jiangshan worker_attach_to_pool(worker, pool); 1941822d8405STejun Heo 1942051e1850SLai Jiangshan /* start the newly created worker */ 1943051e1850SLai Jiangshan spin_lock_irq(&pool->lock); 1944051e1850SLai Jiangshan worker->pool->nr_workers++; 1945051e1850SLai Jiangshan worker_enter_idle(worker); 1946051e1850SLai Jiangshan wake_up_process(worker->task); 1947051e1850SLai Jiangshan spin_unlock_irq(&pool->lock); 1948051e1850SLai Jiangshan 1949c34056a3STejun Heo return worker; 1950822d8405STejun Heo 1951c34056a3STejun Heo fail: 19529625ab17SLai Jiangshan if (id >= 0) 19537cda9aaeSLai Jiangshan ida_simple_remove(&pool->worker_ida, id); 1954c34056a3STejun Heo kfree(worker); 1955c34056a3STejun Heo return NULL; 1956c34056a3STejun Heo } 1957c34056a3STejun Heo 1958c34056a3STejun Heo /** 1959c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1960c34056a3STejun Heo * @worker: worker to be destroyed 1961c34056a3STejun Heo * 196273eb7fe7SLai Jiangshan * Destroy @worker and adjust @pool stats accordingly. The worker should 196373eb7fe7SLai Jiangshan * be idle. 1964c8e55f36STejun Heo * 1965c8e55f36STejun Heo * CONTEXT: 196660f5a4bcSLai Jiangshan * spin_lock_irq(pool->lock). 1967c34056a3STejun Heo */ 1968c34056a3STejun Heo static void destroy_worker(struct worker *worker) 1969c34056a3STejun Heo { 1970bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1971c34056a3STejun Heo 1972cd549687STejun Heo lockdep_assert_held(&pool->lock); 1973cd549687STejun Heo 1974c34056a3STejun Heo /* sanity check frenzy */ 19756183c009STejun Heo if (WARN_ON(worker->current_work) || 197673eb7fe7SLai Jiangshan WARN_ON(!list_empty(&worker->scheduled)) || 197773eb7fe7SLai Jiangshan WARN_ON(!(worker->flags & WORKER_IDLE))) 19786183c009STejun Heo return; 1979c34056a3STejun Heo 1980bd7bdd43STejun Heo pool->nr_workers--; 1981bd7bdd43STejun Heo pool->nr_idle--; 1982c8e55f36STejun Heo 1983c8e55f36STejun Heo list_del_init(&worker->entry); 1984cb444766STejun Heo worker->flags |= WORKER_DIE; 198560f5a4bcSLai Jiangshan wake_up_process(worker->task); 1986c34056a3STejun Heo } 1987c34056a3STejun Heo 198832a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t) 1989e22bee78STejun Heo { 199032a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, idle_timer); 1991e22bee78STejun Heo 1992d565ed63STejun Heo spin_lock_irq(&pool->lock); 1993e22bee78STejun Heo 19943347fc9fSLai Jiangshan while (too_many_workers(pool)) { 1995e22bee78STejun Heo struct worker *worker; 1996e22bee78STejun Heo unsigned long expires; 1997e22bee78STejun Heo 1998e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 199963d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 2000e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 2001e22bee78STejun Heo 20023347fc9fSLai Jiangshan if (time_before(jiffies, expires)) { 200363d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 20043347fc9fSLai Jiangshan break; 2005e22bee78STejun Heo } 20063347fc9fSLai Jiangshan 20073347fc9fSLai Jiangshan destroy_worker(worker); 2008e22bee78STejun Heo } 2009e22bee78STejun Heo 2010d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2011e22bee78STejun Heo } 2012e22bee78STejun Heo 2013493a1724STejun Heo static void send_mayday(struct work_struct *work) 2014e22bee78STejun Heo { 2015112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2016112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 2017493a1724STejun Heo 20182e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 2019e22bee78STejun Heo 2020493008a8STejun Heo if (!wq->rescuer) 2021493a1724STejun Heo return; 2022e22bee78STejun Heo 2023e22bee78STejun Heo /* mayday mayday mayday */ 2024493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 202577668c8bSLai Jiangshan /* 202677668c8bSLai Jiangshan * If @pwq is for an unbound wq, its base ref may be put at 202777668c8bSLai Jiangshan * any time due to an attribute change. Pin @pwq until the 202877668c8bSLai Jiangshan * rescuer is done with it. 202977668c8bSLai Jiangshan */ 203077668c8bSLai Jiangshan get_pwq(pwq); 2031493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2032e22bee78STejun Heo wake_up_process(wq->rescuer->task); 2033493a1724STejun Heo } 2034e22bee78STejun Heo } 2035e22bee78STejun Heo 203632a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t) 2037e22bee78STejun Heo { 203832a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, mayday_timer); 2039e22bee78STejun Heo struct work_struct *work; 2040e22bee78STejun Heo 2041b2d82909STejun Heo spin_lock_irq(&pool->lock); 2042b2d82909STejun Heo spin_lock(&wq_mayday_lock); /* for wq->maydays */ 2043e22bee78STejun Heo 204463d95a91STejun Heo if (need_to_create_worker(pool)) { 2045e22bee78STejun Heo /* 2046e22bee78STejun Heo * We've been trying to create a new worker but 2047e22bee78STejun Heo * haven't been successful. We might be hitting an 2048e22bee78STejun Heo * allocation deadlock. Send distress signals to 2049e22bee78STejun Heo * rescuers. 2050e22bee78STejun Heo */ 205163d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 2052e22bee78STejun Heo send_mayday(work); 2053e22bee78STejun Heo } 2054e22bee78STejun Heo 2055b2d82909STejun Heo spin_unlock(&wq_mayday_lock); 2056b2d82909STejun Heo spin_unlock_irq(&pool->lock); 2057e22bee78STejun Heo 205863d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 2059e22bee78STejun Heo } 2060e22bee78STejun Heo 2061e22bee78STejun Heo /** 2062e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 206363d95a91STejun Heo * @pool: pool to create a new worker for 2064e22bee78STejun Heo * 206563d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 2066e22bee78STejun Heo * have at least one idle worker on return from this function. If 2067e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 206863d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 2069e22bee78STejun Heo * possible allocation deadlock. 2070e22bee78STejun Heo * 2071c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 2072c5aa87bbSTejun Heo * may_start_working() %true. 2073e22bee78STejun Heo * 2074e22bee78STejun Heo * LOCKING: 2075d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2076e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 2077e22bee78STejun Heo * manager. 2078e22bee78STejun Heo */ 207929187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool) 2080d565ed63STejun Heo __releases(&pool->lock) 2081d565ed63STejun Heo __acquires(&pool->lock) 2082e22bee78STejun Heo { 2083e22bee78STejun Heo restart: 2084d565ed63STejun Heo spin_unlock_irq(&pool->lock); 20859f9c2364STejun Heo 2086e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 208763d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 2088e22bee78STejun Heo 2089e22bee78STejun Heo while (true) { 2090051e1850SLai Jiangshan if (create_worker(pool) || !need_to_create_worker(pool)) 2091e22bee78STejun Heo break; 2092e22bee78STejun Heo 2093e212f361SLai Jiangshan schedule_timeout_interruptible(CREATE_COOLDOWN); 20949f9c2364STejun Heo 209563d95a91STejun Heo if (!need_to_create_worker(pool)) 2096e22bee78STejun Heo break; 2097e22bee78STejun Heo } 2098e22bee78STejun Heo 209963d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 2100d565ed63STejun Heo spin_lock_irq(&pool->lock); 2101051e1850SLai Jiangshan /* 2102051e1850SLai Jiangshan * This is necessary even after a new worker was just successfully 2103051e1850SLai Jiangshan * created as @pool->lock was dropped and the new worker might have 2104051e1850SLai Jiangshan * already become busy. 2105051e1850SLai Jiangshan */ 210663d95a91STejun Heo if (need_to_create_worker(pool)) 2107e22bee78STejun Heo goto restart; 2108e22bee78STejun Heo } 2109e22bee78STejun Heo 2110e22bee78STejun Heo /** 2111e22bee78STejun Heo * manage_workers - manage worker pool 2112e22bee78STejun Heo * @worker: self 2113e22bee78STejun Heo * 2114706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 2115e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 2116706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 2117e22bee78STejun Heo * 2118e22bee78STejun Heo * The caller can safely start processing works on false return. On 2119e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 2120e22bee78STejun Heo * and may_start_working() is true. 2121e22bee78STejun Heo * 2122e22bee78STejun Heo * CONTEXT: 2123d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2124e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 2125e22bee78STejun Heo * 2126d185af30SYacine Belkadi * Return: 212729187a9eSTejun Heo * %false if the pool doesn't need management and the caller can safely 212829187a9eSTejun Heo * start processing works, %true if management function was performed and 212929187a9eSTejun Heo * the conditions that the caller verified before calling the function may 213029187a9eSTejun Heo * no longer be true. 2131e22bee78STejun Heo */ 2132e22bee78STejun Heo static bool manage_workers(struct worker *worker) 2133e22bee78STejun Heo { 213463d95a91STejun Heo struct worker_pool *pool = worker->pool; 2135e22bee78STejun Heo 2136692b4825STejun Heo if (pool->flags & POOL_MANAGER_ACTIVE) 213729187a9eSTejun Heo return false; 2138692b4825STejun Heo 2139692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 21402607d7a6STejun Heo pool->manager = worker; 2141e22bee78STejun Heo 214229187a9eSTejun Heo maybe_create_worker(pool); 2143e22bee78STejun Heo 21442607d7a6STejun Heo pool->manager = NULL; 2145692b4825STejun Heo pool->flags &= ~POOL_MANAGER_ACTIVE; 2146692b4825STejun Heo wake_up(&wq_manager_wait); 214729187a9eSTejun Heo return true; 2148e22bee78STejun Heo } 2149e22bee78STejun Heo 2150a62428c0STejun Heo /** 2151a62428c0STejun Heo * process_one_work - process single work 2152c34056a3STejun Heo * @worker: self 2153a62428c0STejun Heo * @work: work to process 2154a62428c0STejun Heo * 2155a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 2156a62428c0STejun Heo * process a single work including synchronization against and 2157a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 2158a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 2159a62428c0STejun Heo * call this function to process a work. 2160a62428c0STejun Heo * 2161a62428c0STejun Heo * CONTEXT: 2162d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 2163a62428c0STejun Heo */ 2164c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 2165d565ed63STejun Heo __releases(&pool->lock) 2166d565ed63STejun Heo __acquires(&pool->lock) 21671da177e4SLinus Torvalds { 2168112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2169bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2170112202d9STejun Heo bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE; 217173f53c4aSTejun Heo int work_color; 21727e11629dSTejun Heo struct worker *collision; 21734e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 21744e6045f1SJohannes Berg /* 2175a62428c0STejun Heo * It is permissible to free the struct work_struct from 2176a62428c0STejun Heo * inside the function that is called from it, this we need to 2177a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 2178a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 2179a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 21804e6045f1SJohannes Berg */ 21814d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 21824d82a1deSPeter Zijlstra 21834d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 21844e6045f1SJohannes Berg #endif 2185807407c0SLai Jiangshan /* ensure we're on the correct CPU */ 218685327af6SLai Jiangshan WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 2187ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 218825511a47STejun Heo 21897e11629dSTejun Heo /* 21907e11629dSTejun Heo * A single work shouldn't be executed concurrently by 21917e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 21927e11629dSTejun Heo * already processing the work. If so, defer the work to the 21937e11629dSTejun Heo * currently executing one. 21947e11629dSTejun Heo */ 2195c9e7cf27STejun Heo collision = find_worker_executing_work(pool, work); 21967e11629dSTejun Heo if (unlikely(collision)) { 21977e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 21987e11629dSTejun Heo return; 21997e11629dSTejun Heo } 22001da177e4SLinus Torvalds 22018930cabaSTejun Heo /* claim and dequeue */ 22021da177e4SLinus Torvalds debug_work_deactivate(work); 2203c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 2204c34056a3STejun Heo worker->current_work = work; 2205a2c1c57bSTejun Heo worker->current_func = work->func; 2206112202d9STejun Heo worker->current_pwq = pwq; 220773f53c4aSTejun Heo work_color = get_work_color(work); 22087a22ad75STejun Heo 22098bf89593STejun Heo /* 22108bf89593STejun Heo * Record wq name for cmdline and debug reporting, may get 22118bf89593STejun Heo * overridden through set_worker_desc(). 22128bf89593STejun Heo */ 22138bf89593STejun Heo strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN); 22148bf89593STejun Heo 2215a62428c0STejun Heo list_del_init(&work->entry); 2216a62428c0STejun Heo 2217649027d7STejun Heo /* 2218228f1d00SLai Jiangshan * CPU intensive works don't participate in concurrency management. 2219228f1d00SLai Jiangshan * They're the scheduler's responsibility. This takes @worker out 2220228f1d00SLai Jiangshan * of concurrency management and the next code block will chain 2221228f1d00SLai Jiangshan * execution of the pending work items. 2222fb0e7bebSTejun Heo */ 2223fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2224228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_CPU_INTENSIVE); 2225fb0e7bebSTejun Heo 2226974271c4STejun Heo /* 2227a489a03eSLai Jiangshan * Wake up another worker if necessary. The condition is always 2228a489a03eSLai Jiangshan * false for normal per-cpu workers since nr_running would always 2229a489a03eSLai Jiangshan * be >= 1 at this point. This is used to chain execution of the 2230a489a03eSLai Jiangshan * pending work items for WORKER_NOT_RUNNING workers such as the 2231228f1d00SLai Jiangshan * UNBOUND and CPU_INTENSIVE ones. 2232974271c4STejun Heo */ 2233a489a03eSLai Jiangshan if (need_more_worker(pool)) 223463d95a91STejun Heo wake_up_worker(pool); 2235974271c4STejun Heo 22368930cabaSTejun Heo /* 22377c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2238d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 223923657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 224023657bb1STejun Heo * disabled. 22418930cabaSTejun Heo */ 22427c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 22431da177e4SLinus Torvalds 2244d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2245365970a1SDavid Howells 2246a1d14934SPeter Zijlstra lock_map_acquire(&pwq->wq->lockdep_map); 22473295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2248e6f3faa7SPeter Zijlstra /* 2249f52be570SPeter Zijlstra * Strictly speaking we should mark the invariant state without holding 2250f52be570SPeter Zijlstra * any locks, that is, before these two lock_map_acquire()'s. 2251e6f3faa7SPeter Zijlstra * 2252e6f3faa7SPeter Zijlstra * However, that would result in: 2253e6f3faa7SPeter Zijlstra * 2254e6f3faa7SPeter Zijlstra * A(W1) 2255e6f3faa7SPeter Zijlstra * WFC(C) 2256e6f3faa7SPeter Zijlstra * A(W1) 2257e6f3faa7SPeter Zijlstra * C(C) 2258e6f3faa7SPeter Zijlstra * 2259e6f3faa7SPeter Zijlstra * Which would create W1->C->W1 dependencies, even though there is no 2260e6f3faa7SPeter Zijlstra * actual deadlock possible. There are two solutions, using a 2261e6f3faa7SPeter Zijlstra * read-recursive acquire on the work(queue) 'locks', but this will then 2262f52be570SPeter Zijlstra * hit the lockdep limitation on recursive locks, or simply discard 2263e6f3faa7SPeter Zijlstra * these locks. 2264e6f3faa7SPeter Zijlstra * 2265e6f3faa7SPeter Zijlstra * AFAICT there is no possible deadlock scenario between the 2266e6f3faa7SPeter Zijlstra * flush_work() and complete() primitives (except for single-threaded 2267e6f3faa7SPeter Zijlstra * workqueues), so hiding them isn't a problem. 2268e6f3faa7SPeter Zijlstra */ 2269f52be570SPeter Zijlstra lockdep_invariant_state(true); 2270e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2271a2c1c57bSTejun Heo worker->current_func(work); 2272e36c886aSArjan van de Ven /* 2273e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2274e36c886aSArjan van de Ven * point will only record its address. 2275e36c886aSArjan van de Ven */ 2276e36c886aSArjan van de Ven trace_workqueue_execute_end(work); 22773295f0efSIngo Molnar lock_map_release(&lockdep_map); 2278112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 22791da177e4SLinus Torvalds 2280d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 2281044c782cSValentin Ilie pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" 2282d75f773cSSakari Ailus " last function: %ps\n", 2283a2c1c57bSTejun Heo current->comm, preempt_count(), task_pid_nr(current), 2284a2c1c57bSTejun Heo worker->current_func); 2285d5abe669SPeter Zijlstra debug_show_held_locks(current); 2286d5abe669SPeter Zijlstra dump_stack(); 2287d5abe669SPeter Zijlstra } 2288d5abe669SPeter Zijlstra 2289b22ce278STejun Heo /* 2290b22ce278STejun Heo * The following prevents a kworker from hogging CPU on !PREEMPT 2291b22ce278STejun Heo * kernels, where a requeueing work item waiting for something to 2292b22ce278STejun Heo * happen could deadlock with stop_machine as such work item could 2293b22ce278STejun Heo * indefinitely requeue itself while all other CPUs are trapped in 2294789cbbecSJoe Lawrence * stop_machine. At the same time, report a quiescent RCU state so 2295789cbbecSJoe Lawrence * the same condition doesn't freeze RCU. 2296b22ce278STejun Heo */ 2297a7e6425eSPaul E. McKenney cond_resched(); 2298b22ce278STejun Heo 2299d565ed63STejun Heo spin_lock_irq(&pool->lock); 2300a62428c0STejun Heo 2301fb0e7bebSTejun Heo /* clear cpu intensive status */ 2302fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2303fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2304fb0e7bebSTejun Heo 23051b69ac6bSJohannes Weiner /* tag the worker for identification in schedule() */ 23061b69ac6bSJohannes Weiner worker->last_func = worker->current_func; 23071b69ac6bSJohannes Weiner 2308a62428c0STejun Heo /* we're done with it, release */ 230942f8570fSSasha Levin hash_del(&worker->hentry); 2310c34056a3STejun Heo worker->current_work = NULL; 2311a2c1c57bSTejun Heo worker->current_func = NULL; 2312112202d9STejun Heo worker->current_pwq = NULL; 2313112202d9STejun Heo pwq_dec_nr_in_flight(pwq, work_color); 23141da177e4SLinus Torvalds } 23151da177e4SLinus Torvalds 2316affee4b2STejun Heo /** 2317affee4b2STejun Heo * process_scheduled_works - process scheduled works 2318affee4b2STejun Heo * @worker: self 2319affee4b2STejun Heo * 2320affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2321affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2322affee4b2STejun Heo * fetches a work from the top and executes it. 2323affee4b2STejun Heo * 2324affee4b2STejun Heo * CONTEXT: 2325d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2326affee4b2STejun Heo * multiple times. 2327affee4b2STejun Heo */ 2328affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 23291da177e4SLinus Torvalds { 2330affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 2331affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 2332a62428c0STejun Heo struct work_struct, entry); 2333c34056a3STejun Heo process_one_work(worker, work); 2334a62428c0STejun Heo } 23351da177e4SLinus Torvalds } 23361da177e4SLinus Torvalds 2337197f6accSTejun Heo static void set_pf_worker(bool val) 2338197f6accSTejun Heo { 2339197f6accSTejun Heo mutex_lock(&wq_pool_attach_mutex); 2340197f6accSTejun Heo if (val) 2341197f6accSTejun Heo current->flags |= PF_WQ_WORKER; 2342197f6accSTejun Heo else 2343197f6accSTejun Heo current->flags &= ~PF_WQ_WORKER; 2344197f6accSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 2345197f6accSTejun Heo } 2346197f6accSTejun Heo 23474690c4abSTejun Heo /** 23484690c4abSTejun Heo * worker_thread - the worker thread function 2349c34056a3STejun Heo * @__worker: self 23504690c4abSTejun Heo * 2351c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 2352c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 2353c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 2354c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 2355c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 2356d185af30SYacine Belkadi * 2357d185af30SYacine Belkadi * Return: 0 23584690c4abSTejun Heo */ 2359c34056a3STejun Heo static int worker_thread(void *__worker) 23601da177e4SLinus Torvalds { 2361c34056a3STejun Heo struct worker *worker = __worker; 2362bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 23631da177e4SLinus Torvalds 2364e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2365197f6accSTejun Heo set_pf_worker(true); 2366c8e55f36STejun Heo woke_up: 2367d565ed63STejun Heo spin_lock_irq(&pool->lock); 2368affee4b2STejun Heo 2369a9ab775bSTejun Heo /* am I supposed to die? */ 2370a9ab775bSTejun Heo if (unlikely(worker->flags & WORKER_DIE)) { 2371d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2372a9ab775bSTejun Heo WARN_ON_ONCE(!list_empty(&worker->entry)); 2373197f6accSTejun Heo set_pf_worker(false); 237460f5a4bcSLai Jiangshan 237560f5a4bcSLai Jiangshan set_task_comm(worker->task, "kworker/dying"); 23767cda9aaeSLai Jiangshan ida_simple_remove(&pool->worker_ida, worker->id); 2377a2d812a2STejun Heo worker_detach_from_pool(worker); 237860f5a4bcSLai Jiangshan kfree(worker); 2379c8e55f36STejun Heo return 0; 2380c8e55f36STejun Heo } 2381c8e55f36STejun Heo 2382c8e55f36STejun Heo worker_leave_idle(worker); 2383db7bccf4STejun Heo recheck: 2384e22bee78STejun Heo /* no more worker necessary? */ 238563d95a91STejun Heo if (!need_more_worker(pool)) 2386e22bee78STejun Heo goto sleep; 2387e22bee78STejun Heo 2388e22bee78STejun Heo /* do we need to manage? */ 238963d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2390e22bee78STejun Heo goto recheck; 2391e22bee78STejun Heo 2392c8e55f36STejun Heo /* 2393c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2394c8e55f36STejun Heo * preparing to process a work or actually processing it. 2395c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2396c8e55f36STejun Heo */ 23976183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 2398c8e55f36STejun Heo 2399e22bee78STejun Heo /* 2400a9ab775bSTejun Heo * Finish PREP stage. We're guaranteed to have at least one idle 2401a9ab775bSTejun Heo * worker or that someone else has already assumed the manager 2402a9ab775bSTejun Heo * role. This is where @worker starts participating in concurrency 2403a9ab775bSTejun Heo * management if applicable and concurrency management is restored 2404a9ab775bSTejun Heo * after being rebound. See rebind_workers() for details. 2405e22bee78STejun Heo */ 2406a9ab775bSTejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 2407e22bee78STejun Heo 2408e22bee78STejun Heo do { 2409affee4b2STejun Heo struct work_struct *work = 2410bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2411affee4b2STejun Heo struct work_struct, entry); 2412affee4b2STejun Heo 241382607adcSTejun Heo pool->watchdog_ts = jiffies; 241482607adcSTejun Heo 2415c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 2416affee4b2STejun Heo /* optimization path, not strictly necessary */ 2417affee4b2STejun Heo process_one_work(worker, work); 2418affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 2419affee4b2STejun Heo process_scheduled_works(worker); 2420affee4b2STejun Heo } else { 2421c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 2422affee4b2STejun Heo process_scheduled_works(worker); 2423affee4b2STejun Heo } 242463d95a91STejun Heo } while (keep_working(pool)); 2425affee4b2STejun Heo 2426228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_PREP); 2427d313dd85STejun Heo sleep: 2428c8e55f36STejun Heo /* 2429d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2430d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2431d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2432d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2433d565ed63STejun Heo * event. 2434c8e55f36STejun Heo */ 2435c8e55f36STejun Heo worker_enter_idle(worker); 2436c5a94a61SPeter Zijlstra __set_current_state(TASK_IDLE); 2437d565ed63STejun Heo spin_unlock_irq(&pool->lock); 24381da177e4SLinus Torvalds schedule(); 2439c8e55f36STejun Heo goto woke_up; 24401da177e4SLinus Torvalds } 24411da177e4SLinus Torvalds 2442e22bee78STejun Heo /** 2443e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2444111c225aSTejun Heo * @__rescuer: self 2445e22bee78STejun Heo * 2446e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2447493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 2448e22bee78STejun Heo * 2449706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 2450e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2451e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2452e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2453e22bee78STejun Heo * the problem rescuer solves. 2454e22bee78STejun Heo * 2455706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 2456706026c2STejun Heo * workqueues which have works queued on the pool and let them process 2457e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2458e22bee78STejun Heo * 2459e22bee78STejun Heo * This should happen rarely. 2460d185af30SYacine Belkadi * 2461d185af30SYacine Belkadi * Return: 0 2462e22bee78STejun Heo */ 2463111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2464e22bee78STejun Heo { 2465111c225aSTejun Heo struct worker *rescuer = __rescuer; 2466111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 2467e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 24684d595b86SLai Jiangshan bool should_stop; 2469e22bee78STejun Heo 2470e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2471111c225aSTejun Heo 2472111c225aSTejun Heo /* 2473111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2474111c225aSTejun Heo * doesn't participate in concurrency management. 2475111c225aSTejun Heo */ 2476197f6accSTejun Heo set_pf_worker(true); 2477e22bee78STejun Heo repeat: 2478c5a94a61SPeter Zijlstra set_current_state(TASK_IDLE); 24791da177e4SLinus Torvalds 24804d595b86SLai Jiangshan /* 24814d595b86SLai Jiangshan * By the time the rescuer is requested to stop, the workqueue 24824d595b86SLai Jiangshan * shouldn't have any work pending, but @wq->maydays may still have 24834d595b86SLai Jiangshan * pwq(s) queued. This can happen by non-rescuer workers consuming 24844d595b86SLai Jiangshan * all the work items before the rescuer got to them. Go through 24854d595b86SLai Jiangshan * @wq->maydays processing before acting on should_stop so that the 24864d595b86SLai Jiangshan * list is always empty on exit. 24874d595b86SLai Jiangshan */ 24884d595b86SLai Jiangshan should_stop = kthread_should_stop(); 24891da177e4SLinus Torvalds 2490493a1724STejun Heo /* see whether any pwq is asking for help */ 24912e109a28STejun Heo spin_lock_irq(&wq_mayday_lock); 2492493a1724STejun Heo 2493493a1724STejun Heo while (!list_empty(&wq->maydays)) { 2494493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 2495493a1724STejun Heo struct pool_workqueue, mayday_node); 2496112202d9STejun Heo struct worker_pool *pool = pwq->pool; 2497e22bee78STejun Heo struct work_struct *work, *n; 249882607adcSTejun Heo bool first = true; 2499e22bee78STejun Heo 2500e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2501493a1724STejun Heo list_del_init(&pwq->mayday_node); 2502493a1724STejun Heo 25032e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 2504e22bee78STejun Heo 250551697d39SLai Jiangshan worker_attach_to_pool(rescuer, pool); 250651697d39SLai Jiangshan 250751697d39SLai Jiangshan spin_lock_irq(&pool->lock); 2508e22bee78STejun Heo 2509e22bee78STejun Heo /* 2510e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2511e22bee78STejun Heo * process'em. 2512e22bee78STejun Heo */ 25130479c8c5STejun Heo WARN_ON_ONCE(!list_empty(scheduled)); 251482607adcSTejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) { 251582607adcSTejun Heo if (get_work_pwq(work) == pwq) { 251682607adcSTejun Heo if (first) 251782607adcSTejun Heo pool->watchdog_ts = jiffies; 2518e22bee78STejun Heo move_linked_works(work, scheduled, &n); 251982607adcSTejun Heo } 252082607adcSTejun Heo first = false; 252182607adcSTejun Heo } 2522e22bee78STejun Heo 2523008847f6SNeilBrown if (!list_empty(scheduled)) { 2524e22bee78STejun Heo process_scheduled_works(rescuer); 25257576958aSTejun Heo 25267576958aSTejun Heo /* 2527008847f6SNeilBrown * The above execution of rescued work items could 2528008847f6SNeilBrown * have created more to rescue through 2529008847f6SNeilBrown * pwq_activate_first_delayed() or chained 2530008847f6SNeilBrown * queueing. Let's put @pwq back on mayday list so 2531008847f6SNeilBrown * that such back-to-back work items, which may be 2532008847f6SNeilBrown * being used to relieve memory pressure, don't 2533008847f6SNeilBrown * incur MAYDAY_INTERVAL delay inbetween. 2534008847f6SNeilBrown */ 2535008847f6SNeilBrown if (need_to_create_worker(pool)) { 2536008847f6SNeilBrown spin_lock(&wq_mayday_lock); 2537e66b39afSTejun Heo /* 2538e66b39afSTejun Heo * Queue iff we aren't racing destruction 2539e66b39afSTejun Heo * and somebody else hasn't queued it already. 2540e66b39afSTejun Heo */ 2541e66b39afSTejun Heo if (wq->rescuer && list_empty(&pwq->mayday_node)) { 2542008847f6SNeilBrown get_pwq(pwq); 2543e66b39afSTejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2544e66b39afSTejun Heo } 2545008847f6SNeilBrown spin_unlock(&wq_mayday_lock); 2546008847f6SNeilBrown } 2547008847f6SNeilBrown } 2548008847f6SNeilBrown 2549008847f6SNeilBrown /* 255077668c8bSLai Jiangshan * Put the reference grabbed by send_mayday(). @pool won't 255113b1d625SLai Jiangshan * go away while we're still attached to it. 255277668c8bSLai Jiangshan */ 255377668c8bSLai Jiangshan put_pwq(pwq); 255477668c8bSLai Jiangshan 255577668c8bSLai Jiangshan /* 2556d8ca83e6SLai Jiangshan * Leave this pool. If need_more_worker() is %true, notify a 25577576958aSTejun Heo * regular worker; otherwise, we end up with 0 concurrency 25587576958aSTejun Heo * and stalling the execution. 25597576958aSTejun Heo */ 2560d8ca83e6SLai Jiangshan if (need_more_worker(pool)) 256163d95a91STejun Heo wake_up_worker(pool); 25627576958aSTejun Heo 256313b1d625SLai Jiangshan spin_unlock_irq(&pool->lock); 256413b1d625SLai Jiangshan 2565a2d812a2STejun Heo worker_detach_from_pool(rescuer); 256613b1d625SLai Jiangshan 256713b1d625SLai Jiangshan spin_lock_irq(&wq_mayday_lock); 25681da177e4SLinus Torvalds } 25691da177e4SLinus Torvalds 25702e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 2571493a1724STejun Heo 25724d595b86SLai Jiangshan if (should_stop) { 25734d595b86SLai Jiangshan __set_current_state(TASK_RUNNING); 2574197f6accSTejun Heo set_pf_worker(false); 25754d595b86SLai Jiangshan return 0; 25764d595b86SLai Jiangshan } 25774d595b86SLai Jiangshan 2578111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 2579111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 2580e22bee78STejun Heo schedule(); 2581e22bee78STejun Heo goto repeat; 25821da177e4SLinus Torvalds } 25831da177e4SLinus Torvalds 2584fca839c0STejun Heo /** 2585fca839c0STejun Heo * check_flush_dependency - check for flush dependency sanity 2586fca839c0STejun Heo * @target_wq: workqueue being flushed 2587fca839c0STejun Heo * @target_work: work item being flushed (NULL for workqueue flushes) 2588fca839c0STejun Heo * 2589fca839c0STejun Heo * %current is trying to flush the whole @target_wq or @target_work on it. 2590fca839c0STejun Heo * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not 2591fca839c0STejun Heo * reclaiming memory or running on a workqueue which doesn't have 2592fca839c0STejun Heo * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to 2593fca839c0STejun Heo * a deadlock. 2594fca839c0STejun Heo */ 2595fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq, 2596fca839c0STejun Heo struct work_struct *target_work) 2597fca839c0STejun Heo { 2598fca839c0STejun Heo work_func_t target_func = target_work ? target_work->func : NULL; 2599fca839c0STejun Heo struct worker *worker; 2600fca839c0STejun Heo 2601fca839c0STejun Heo if (target_wq->flags & WQ_MEM_RECLAIM) 2602fca839c0STejun Heo return; 2603fca839c0STejun Heo 2604fca839c0STejun Heo worker = current_wq_worker(); 2605fca839c0STejun Heo 2606fca839c0STejun Heo WARN_ONCE(current->flags & PF_MEMALLOC, 2607d75f773cSSakari Ailus "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps", 2608fca839c0STejun Heo current->pid, current->comm, target_wq->name, target_func); 260923d11a58STejun Heo WARN_ONCE(worker && ((worker->current_pwq->wq->flags & 261023d11a58STejun Heo (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM), 2611d75f773cSSakari Ailus "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps", 2612fca839c0STejun Heo worker->current_pwq->wq->name, worker->current_func, 2613fca839c0STejun Heo target_wq->name, target_func); 2614fca839c0STejun Heo } 2615fca839c0STejun Heo 2616fc2e4d70SOleg Nesterov struct wq_barrier { 2617fc2e4d70SOleg Nesterov struct work_struct work; 2618fc2e4d70SOleg Nesterov struct completion done; 26192607d7a6STejun Heo struct task_struct *task; /* purely informational */ 2620fc2e4d70SOleg Nesterov }; 2621fc2e4d70SOleg Nesterov 2622fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2623fc2e4d70SOleg Nesterov { 2624fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2625fc2e4d70SOleg Nesterov complete(&barr->done); 2626fc2e4d70SOleg Nesterov } 2627fc2e4d70SOleg Nesterov 26284690c4abSTejun Heo /** 26294690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 2630112202d9STejun Heo * @pwq: pwq to insert barrier into 26314690c4abSTejun Heo * @barr: wq_barrier to insert 2632affee4b2STejun Heo * @target: target work to attach @barr to 2633affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 26344690c4abSTejun Heo * 2635affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2636affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2637affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2638affee4b2STejun Heo * cpu. 2639affee4b2STejun Heo * 2640affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2641affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2642affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2643affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2644affee4b2STejun Heo * after a work with LINKED flag set. 2645affee4b2STejun Heo * 2646affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2647112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 26484690c4abSTejun Heo * 26494690c4abSTejun Heo * CONTEXT: 2650d565ed63STejun Heo * spin_lock_irq(pool->lock). 26514690c4abSTejun Heo */ 2652112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 2653affee4b2STejun Heo struct wq_barrier *barr, 2654affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2655fc2e4d70SOleg Nesterov { 2656affee4b2STejun Heo struct list_head *head; 2657affee4b2STejun Heo unsigned int linked = 0; 2658affee4b2STejun Heo 2659dc186ad7SThomas Gleixner /* 2660d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 2661dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2662dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2663dc186ad7SThomas Gleixner * might deadlock. 2664dc186ad7SThomas Gleixner */ 2665ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 266622df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 266752fa5bc5SBoqun Feng 2668fd1a5b04SByungchul Park init_completion_map(&barr->done, &target->lockdep_map); 2669fd1a5b04SByungchul Park 26702607d7a6STejun Heo barr->task = current; 267183c22520SOleg Nesterov 2672affee4b2STejun Heo /* 2673affee4b2STejun Heo * If @target is currently being executed, schedule the 2674affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2675affee4b2STejun Heo */ 2676affee4b2STejun Heo if (worker) 2677affee4b2STejun Heo head = worker->scheduled.next; 2678affee4b2STejun Heo else { 2679affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2680affee4b2STejun Heo 2681affee4b2STejun Heo head = target->entry.next; 2682affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2683affee4b2STejun Heo linked = *bits & WORK_STRUCT_LINKED; 2684affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2685affee4b2STejun Heo } 2686affee4b2STejun Heo 2687dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2688112202d9STejun Heo insert_work(pwq, &barr->work, head, 2689affee4b2STejun Heo work_color_to_flags(WORK_NO_COLOR) | linked); 2690fc2e4d70SOleg Nesterov } 2691fc2e4d70SOleg Nesterov 269273f53c4aSTejun Heo /** 2693112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 269473f53c4aSTejun Heo * @wq: workqueue being flushed 269573f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 269673f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 269773f53c4aSTejun Heo * 2698112202d9STejun Heo * Prepare pwqs for workqueue flushing. 269973f53c4aSTejun Heo * 2700112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 2701112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 2702112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 2703112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 2704112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 270573f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 270673f53c4aSTejun Heo * 270773f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 270873f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 270973f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 271073f53c4aSTejun Heo * is returned. 271173f53c4aSTejun Heo * 2712112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 271373f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 271473f53c4aSTejun Heo * advanced to @work_color. 271573f53c4aSTejun Heo * 271673f53c4aSTejun Heo * CONTEXT: 27173c25a55dSLai Jiangshan * mutex_lock(wq->mutex). 271873f53c4aSTejun Heo * 2719d185af30SYacine Belkadi * Return: 272073f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 272173f53c4aSTejun Heo * otherwise. 272273f53c4aSTejun Heo */ 2723112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 272473f53c4aSTejun Heo int flush_color, int work_color) 27251da177e4SLinus Torvalds { 272673f53c4aSTejun Heo bool wait = false; 272749e3cf44STejun Heo struct pool_workqueue *pwq; 27281da177e4SLinus Torvalds 272973f53c4aSTejun Heo if (flush_color >= 0) { 27306183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 2731112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 2732dc186ad7SThomas Gleixner } 273314441960SOleg Nesterov 273449e3cf44STejun Heo for_each_pwq(pwq, wq) { 2735112202d9STejun Heo struct worker_pool *pool = pwq->pool; 27361da177e4SLinus Torvalds 2737b09f4fd3SLai Jiangshan spin_lock_irq(&pool->lock); 273873f53c4aSTejun Heo 273973f53c4aSTejun Heo if (flush_color >= 0) { 27406183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 274173f53c4aSTejun Heo 2742112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 2743112202d9STejun Heo pwq->flush_color = flush_color; 2744112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 274573f53c4aSTejun Heo wait = true; 27461da177e4SLinus Torvalds } 274773f53c4aSTejun Heo } 274873f53c4aSTejun Heo 274973f53c4aSTejun Heo if (work_color >= 0) { 27506183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 2751112202d9STejun Heo pwq->work_color = work_color; 275273f53c4aSTejun Heo } 275373f53c4aSTejun Heo 2754b09f4fd3SLai Jiangshan spin_unlock_irq(&pool->lock); 27551da177e4SLinus Torvalds } 27561da177e4SLinus Torvalds 2757112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 275873f53c4aSTejun Heo complete(&wq->first_flusher->done); 275973f53c4aSTejun Heo 276073f53c4aSTejun Heo return wait; 276183c22520SOleg Nesterov } 27621da177e4SLinus Torvalds 27630fcb78c2SRolf Eike Beer /** 27641da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 27650fcb78c2SRolf Eike Beer * @wq: workqueue to flush 27661da177e4SLinus Torvalds * 2767c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 2768c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 27691da177e4SLinus Torvalds */ 27707ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 27711da177e4SLinus Torvalds { 277273f53c4aSTejun Heo struct wq_flusher this_flusher = { 277373f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 277473f53c4aSTejun Heo .flush_color = -1, 2775fd1a5b04SByungchul Park .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map), 277673f53c4aSTejun Heo }; 277773f53c4aSTejun Heo int next_color; 2778b1f4ec17SOleg Nesterov 27793347fa09STejun Heo if (WARN_ON(!wq_online)) 27803347fa09STejun Heo return; 27813347fa09STejun Heo 278287915adcSJohannes Berg lock_map_acquire(&wq->lockdep_map); 278387915adcSJohannes Berg lock_map_release(&wq->lockdep_map); 278487915adcSJohannes Berg 27853c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 278673f53c4aSTejun Heo 278773f53c4aSTejun Heo /* 278873f53c4aSTejun Heo * Start-to-wait phase 278973f53c4aSTejun Heo */ 279073f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 279173f53c4aSTejun Heo 279273f53c4aSTejun Heo if (next_color != wq->flush_color) { 279373f53c4aSTejun Heo /* 279473f53c4aSTejun Heo * Color space is not full. The current work_color 279573f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 279673f53c4aSTejun Heo * by one. 279773f53c4aSTejun Heo */ 27986183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 279973f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 280073f53c4aSTejun Heo wq->work_color = next_color; 280173f53c4aSTejun Heo 280273f53c4aSTejun Heo if (!wq->first_flusher) { 280373f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 28046183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 280573f53c4aSTejun Heo 280673f53c4aSTejun Heo wq->first_flusher = &this_flusher; 280773f53c4aSTejun Heo 2808112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 280973f53c4aSTejun Heo wq->work_color)) { 281073f53c4aSTejun Heo /* nothing to flush, done */ 281173f53c4aSTejun Heo wq->flush_color = next_color; 281273f53c4aSTejun Heo wq->first_flusher = NULL; 281373f53c4aSTejun Heo goto out_unlock; 281473f53c4aSTejun Heo } 281573f53c4aSTejun Heo } else { 281673f53c4aSTejun Heo /* wait in queue */ 28176183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 281873f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 2819112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 282073f53c4aSTejun Heo } 282173f53c4aSTejun Heo } else { 282273f53c4aSTejun Heo /* 282373f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 282473f53c4aSTejun Heo * The next flush completion will assign us 282573f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 282673f53c4aSTejun Heo */ 282773f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 282873f53c4aSTejun Heo } 282973f53c4aSTejun Heo 2830fca839c0STejun Heo check_flush_dependency(wq, NULL); 2831fca839c0STejun Heo 28323c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 283373f53c4aSTejun Heo 283473f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 283573f53c4aSTejun Heo 283673f53c4aSTejun Heo /* 283773f53c4aSTejun Heo * Wake-up-and-cascade phase 283873f53c4aSTejun Heo * 283973f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 284073f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 284173f53c4aSTejun Heo */ 284273f53c4aSTejun Heo if (wq->first_flusher != &this_flusher) 284373f53c4aSTejun Heo return; 284473f53c4aSTejun Heo 28453c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 284673f53c4aSTejun Heo 28474ce48b37STejun Heo /* we might have raced, check again with mutex held */ 28484ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 28494ce48b37STejun Heo goto out_unlock; 28504ce48b37STejun Heo 285173f53c4aSTejun Heo wq->first_flusher = NULL; 285273f53c4aSTejun Heo 28536183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 28546183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 285573f53c4aSTejun Heo 285673f53c4aSTejun Heo while (true) { 285773f53c4aSTejun Heo struct wq_flusher *next, *tmp; 285873f53c4aSTejun Heo 285973f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 286073f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 286173f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 286273f53c4aSTejun Heo break; 286373f53c4aSTejun Heo list_del_init(&next->list); 286473f53c4aSTejun Heo complete(&next->done); 286573f53c4aSTejun Heo } 286673f53c4aSTejun Heo 28676183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 286873f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 286973f53c4aSTejun Heo 287073f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 287173f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 287273f53c4aSTejun Heo 287373f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 287473f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 287573f53c4aSTejun Heo /* 287673f53c4aSTejun Heo * Assign the same color to all overflowed 287773f53c4aSTejun Heo * flushers, advance work_color and append to 287873f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 287973f53c4aSTejun Heo * phase for these overflowed flushers. 288073f53c4aSTejun Heo */ 288173f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 288273f53c4aSTejun Heo tmp->flush_color = wq->work_color; 288373f53c4aSTejun Heo 288473f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 288573f53c4aSTejun Heo 288673f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 288773f53c4aSTejun Heo &wq->flusher_queue); 2888112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 288973f53c4aSTejun Heo } 289073f53c4aSTejun Heo 289173f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 28926183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 289373f53c4aSTejun Heo break; 289473f53c4aSTejun Heo } 289573f53c4aSTejun Heo 289673f53c4aSTejun Heo /* 289773f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 2898112202d9STejun Heo * the new first flusher and arm pwqs. 289973f53c4aSTejun Heo */ 29006183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 29016183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 290273f53c4aSTejun Heo 290373f53c4aSTejun Heo list_del_init(&next->list); 290473f53c4aSTejun Heo wq->first_flusher = next; 290573f53c4aSTejun Heo 2906112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 290773f53c4aSTejun Heo break; 290873f53c4aSTejun Heo 290973f53c4aSTejun Heo /* 291073f53c4aSTejun Heo * Meh... this color is already done, clear first 291173f53c4aSTejun Heo * flusher and repeat cascading. 291273f53c4aSTejun Heo */ 291373f53c4aSTejun Heo wq->first_flusher = NULL; 291473f53c4aSTejun Heo } 291573f53c4aSTejun Heo 291673f53c4aSTejun Heo out_unlock: 29173c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 29181da177e4SLinus Torvalds } 29191dadafa8STim Gardner EXPORT_SYMBOL(flush_workqueue); 29201da177e4SLinus Torvalds 29219c5a2ba7STejun Heo /** 29229c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 29239c5a2ba7STejun Heo * @wq: workqueue to drain 29249c5a2ba7STejun Heo * 29259c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 29269c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 29279c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 2928b749b1b6SChen Hanxiao * repeatedly until it becomes empty. The number of flushing is determined 29299c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 29309c5a2ba7STejun Heo * takes too long. 29319c5a2ba7STejun Heo */ 29329c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 29339c5a2ba7STejun Heo { 29349c5a2ba7STejun Heo unsigned int flush_cnt = 0; 293549e3cf44STejun Heo struct pool_workqueue *pwq; 29369c5a2ba7STejun Heo 29379c5a2ba7STejun Heo /* 29389c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 29399c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 2940618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 29419c5a2ba7STejun Heo */ 294287fc741eSLai Jiangshan mutex_lock(&wq->mutex); 29439c5a2ba7STejun Heo if (!wq->nr_drainers++) 2944618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 294587fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 29469c5a2ba7STejun Heo reflush: 29479c5a2ba7STejun Heo flush_workqueue(wq); 29489c5a2ba7STejun Heo 2949b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 295076af4d93STejun Heo 295149e3cf44STejun Heo for_each_pwq(pwq, wq) { 2952fa2563e4SThomas Tuttle bool drained; 29539c5a2ba7STejun Heo 2954b09f4fd3SLai Jiangshan spin_lock_irq(&pwq->pool->lock); 2955112202d9STejun Heo drained = !pwq->nr_active && list_empty(&pwq->delayed_works); 2956b09f4fd3SLai Jiangshan spin_unlock_irq(&pwq->pool->lock); 2957fa2563e4SThomas Tuttle 2958fa2563e4SThomas Tuttle if (drained) 29599c5a2ba7STejun Heo continue; 29609c5a2ba7STejun Heo 29619c5a2ba7STejun Heo if (++flush_cnt == 10 || 29629c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 2963c5aa87bbSTejun Heo pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n", 29649c5a2ba7STejun Heo wq->name, flush_cnt); 296576af4d93STejun Heo 2966b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 29679c5a2ba7STejun Heo goto reflush; 29689c5a2ba7STejun Heo } 29699c5a2ba7STejun Heo 29709c5a2ba7STejun Heo if (!--wq->nr_drainers) 2971618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 297287fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 29739c5a2ba7STejun Heo } 29749c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 29759c5a2ba7STejun Heo 2976d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, 2977d6e89786SJohannes Berg bool from_cancel) 2978baf59022STejun Heo { 2979baf59022STejun Heo struct worker *worker = NULL; 2980c9e7cf27STejun Heo struct worker_pool *pool; 2981112202d9STejun Heo struct pool_workqueue *pwq; 2982baf59022STejun Heo 2983baf59022STejun Heo might_sleep(); 2984baf59022STejun Heo 298524acfb71SThomas Gleixner rcu_read_lock(); 2986fa1b54e6STejun Heo pool = get_work_pool(work); 2987fa1b54e6STejun Heo if (!pool) { 298824acfb71SThomas Gleixner rcu_read_unlock(); 2989fa1b54e6STejun Heo return false; 2990fa1b54e6STejun Heo } 2991fa1b54e6STejun Heo 299224acfb71SThomas Gleixner spin_lock_irq(&pool->lock); 29930b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 2994112202d9STejun Heo pwq = get_work_pwq(work); 2995112202d9STejun Heo if (pwq) { 2996112202d9STejun Heo if (unlikely(pwq->pool != pool)) 2997baf59022STejun Heo goto already_gone; 2998606a5020STejun Heo } else { 2999c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 3000baf59022STejun Heo if (!worker) 3001baf59022STejun Heo goto already_gone; 3002112202d9STejun Heo pwq = worker->current_pwq; 3003606a5020STejun Heo } 3004baf59022STejun Heo 3005fca839c0STejun Heo check_flush_dependency(pwq->wq, work); 3006fca839c0STejun Heo 3007112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 3008d565ed63STejun Heo spin_unlock_irq(&pool->lock); 3009baf59022STejun Heo 3010e159489bSTejun Heo /* 3011a1d14934SPeter Zijlstra * Force a lock recursion deadlock when using flush_work() inside a 3012a1d14934SPeter Zijlstra * single-threaded or rescuer equipped workqueue. 3013a1d14934SPeter Zijlstra * 3014a1d14934SPeter Zijlstra * For single threaded workqueues the deadlock happens when the work 3015a1d14934SPeter Zijlstra * is after the work issuing the flush_work(). For rescuer equipped 3016a1d14934SPeter Zijlstra * workqueues the deadlock happens when the rescuer stalls, blocking 3017a1d14934SPeter Zijlstra * forward progress. 3018e159489bSTejun Heo */ 3019d6e89786SJohannes Berg if (!from_cancel && 3020d6e89786SJohannes Berg (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) { 3021112202d9STejun Heo lock_map_acquire(&pwq->wq->lockdep_map); 3022112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 3023a1d14934SPeter Zijlstra } 302424acfb71SThomas Gleixner rcu_read_unlock(); 3025baf59022STejun Heo return true; 3026baf59022STejun Heo already_gone: 3027d565ed63STejun Heo spin_unlock_irq(&pool->lock); 302824acfb71SThomas Gleixner rcu_read_unlock(); 3029baf59022STejun Heo return false; 3030baf59022STejun Heo } 3031baf59022STejun Heo 3032d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel) 3033d6e89786SJohannes Berg { 3034d6e89786SJohannes Berg struct wq_barrier barr; 3035d6e89786SJohannes Berg 3036d6e89786SJohannes Berg if (WARN_ON(!wq_online)) 3037d6e89786SJohannes Berg return false; 3038d6e89786SJohannes Berg 30394d43d395STetsuo Handa if (WARN_ON(!work->func)) 30404d43d395STetsuo Handa return false; 30414d43d395STetsuo Handa 304287915adcSJohannes Berg if (!from_cancel) { 304387915adcSJohannes Berg lock_map_acquire(&work->lockdep_map); 304487915adcSJohannes Berg lock_map_release(&work->lockdep_map); 304587915adcSJohannes Berg } 304687915adcSJohannes Berg 3047d6e89786SJohannes Berg if (start_flush_work(work, &barr, from_cancel)) { 3048d6e89786SJohannes Berg wait_for_completion(&barr.done); 3049d6e89786SJohannes Berg destroy_work_on_stack(&barr.work); 3050d6e89786SJohannes Berg return true; 3051d6e89786SJohannes Berg } else { 3052d6e89786SJohannes Berg return false; 3053d6e89786SJohannes Berg } 3054d6e89786SJohannes Berg } 3055d6e89786SJohannes Berg 3056db700897SOleg Nesterov /** 3057401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 3058401a8d04STejun Heo * @work: the work to flush 3059db700897SOleg Nesterov * 3060606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 3061606a5020STejun Heo * on return if it hasn't been requeued since flush started. 3062401a8d04STejun Heo * 3063d185af30SYacine Belkadi * Return: 3064401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 3065401a8d04STejun Heo * %false if it was already idle. 3066db700897SOleg Nesterov */ 3067401a8d04STejun Heo bool flush_work(struct work_struct *work) 3068db700897SOleg Nesterov { 3069d6e89786SJohannes Berg return __flush_work(work, false); 3070606a5020STejun Heo } 3071db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 3072db700897SOleg Nesterov 30738603e1b3STejun Heo struct cwt_wait { 3074ac6424b9SIngo Molnar wait_queue_entry_t wait; 30758603e1b3STejun Heo struct work_struct *work; 30768603e1b3STejun Heo }; 30778603e1b3STejun Heo 3078ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key) 30798603e1b3STejun Heo { 30808603e1b3STejun Heo struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait); 30818603e1b3STejun Heo 30828603e1b3STejun Heo if (cwait->work != key) 30838603e1b3STejun Heo return 0; 30848603e1b3STejun Heo return autoremove_wake_function(wait, mode, sync, key); 30858603e1b3STejun Heo } 30868603e1b3STejun Heo 308736e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 3088401a8d04STejun Heo { 30898603e1b3STejun Heo static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq); 3090bbb68dfaSTejun Heo unsigned long flags; 30911f1f642eSOleg Nesterov int ret; 30921f1f642eSOleg Nesterov 30931f1f642eSOleg Nesterov do { 3094bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 3095bbb68dfaSTejun Heo /* 30968603e1b3STejun Heo * If someone else is already canceling, wait for it to 30978603e1b3STejun Heo * finish. flush_work() doesn't work for PREEMPT_NONE 30988603e1b3STejun Heo * because we may get scheduled between @work's completion 30998603e1b3STejun Heo * and the other canceling task resuming and clearing 31008603e1b3STejun Heo * CANCELING - flush_work() will return false immediately 31018603e1b3STejun Heo * as @work is no longer busy, try_to_grab_pending() will 31028603e1b3STejun Heo * return -ENOENT as @work is still being canceled and the 31038603e1b3STejun Heo * other canceling task won't be able to clear CANCELING as 31048603e1b3STejun Heo * we're hogging the CPU. 31058603e1b3STejun Heo * 31068603e1b3STejun Heo * Let's wait for completion using a waitqueue. As this 31078603e1b3STejun Heo * may lead to the thundering herd problem, use a custom 31088603e1b3STejun Heo * wake function which matches @work along with exclusive 31098603e1b3STejun Heo * wait and wakeup. 3110bbb68dfaSTejun Heo */ 31118603e1b3STejun Heo if (unlikely(ret == -ENOENT)) { 31128603e1b3STejun Heo struct cwt_wait cwait; 31138603e1b3STejun Heo 31148603e1b3STejun Heo init_wait(&cwait.wait); 31158603e1b3STejun Heo cwait.wait.func = cwt_wakefn; 31168603e1b3STejun Heo cwait.work = work; 31178603e1b3STejun Heo 31188603e1b3STejun Heo prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait, 31198603e1b3STejun Heo TASK_UNINTERRUPTIBLE); 31208603e1b3STejun Heo if (work_is_canceling(work)) 31218603e1b3STejun Heo schedule(); 31228603e1b3STejun Heo finish_wait(&cancel_waitq, &cwait.wait); 31238603e1b3STejun Heo } 31241f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 31251f1f642eSOleg Nesterov 3126bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 3127bbb68dfaSTejun Heo mark_work_canceling(work); 3128bbb68dfaSTejun Heo local_irq_restore(flags); 3129bbb68dfaSTejun Heo 31303347fa09STejun Heo /* 31313347fa09STejun Heo * This allows canceling during early boot. We know that @work 31323347fa09STejun Heo * isn't executing. 31333347fa09STejun Heo */ 31343347fa09STejun Heo if (wq_online) 3135d6e89786SJohannes Berg __flush_work(work, true); 31363347fa09STejun Heo 31377a22ad75STejun Heo clear_work_data(work); 31388603e1b3STejun Heo 31398603e1b3STejun Heo /* 31408603e1b3STejun Heo * Paired with prepare_to_wait() above so that either 31418603e1b3STejun Heo * waitqueue_active() is visible here or !work_is_canceling() is 31428603e1b3STejun Heo * visible there. 31438603e1b3STejun Heo */ 31448603e1b3STejun Heo smp_mb(); 31458603e1b3STejun Heo if (waitqueue_active(&cancel_waitq)) 31468603e1b3STejun Heo __wake_up(&cancel_waitq, TASK_NORMAL, 1, work); 31478603e1b3STejun Heo 31481f1f642eSOleg Nesterov return ret; 31491f1f642eSOleg Nesterov } 31501f1f642eSOleg Nesterov 31516e84d644SOleg Nesterov /** 3152401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 3153401a8d04STejun Heo * @work: the work to cancel 31546e84d644SOleg Nesterov * 3155401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 3156401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 3157401a8d04STejun Heo * another workqueue. On return from this function, @work is 3158401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 31591f1f642eSOleg Nesterov * 3160401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 3161401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 31626e84d644SOleg Nesterov * 3163401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 31646e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 3165401a8d04STejun Heo * 3166d185af30SYacine Belkadi * Return: 3167401a8d04STejun Heo * %true if @work was pending, %false otherwise. 31686e84d644SOleg Nesterov */ 3169401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 31706e84d644SOleg Nesterov { 317136e227d2STejun Heo return __cancel_work_timer(work, false); 3172b89deed3SOleg Nesterov } 317328e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 3174b89deed3SOleg Nesterov 31756e84d644SOleg Nesterov /** 3176401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 3177401a8d04STejun Heo * @dwork: the delayed work to flush 31786e84d644SOleg Nesterov * 3179401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 3180401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 3181401a8d04STejun Heo * considers the last queueing instance of @dwork. 31821f1f642eSOleg Nesterov * 3183d185af30SYacine Belkadi * Return: 3184401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 3185401a8d04STejun Heo * %false if it was already idle. 31866e84d644SOleg Nesterov */ 3187401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 3188401a8d04STejun Heo { 31898930cabaSTejun Heo local_irq_disable(); 3190401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 319160c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 31928930cabaSTejun Heo local_irq_enable(); 3193401a8d04STejun Heo return flush_work(&dwork->work); 3194401a8d04STejun Heo } 3195401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 3196401a8d04STejun Heo 319705f0fe6bSTejun Heo /** 319805f0fe6bSTejun Heo * flush_rcu_work - wait for a rwork to finish executing the last queueing 319905f0fe6bSTejun Heo * @rwork: the rcu work to flush 320005f0fe6bSTejun Heo * 320105f0fe6bSTejun Heo * Return: 320205f0fe6bSTejun Heo * %true if flush_rcu_work() waited for the work to finish execution, 320305f0fe6bSTejun Heo * %false if it was already idle. 320405f0fe6bSTejun Heo */ 320505f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork) 320605f0fe6bSTejun Heo { 320705f0fe6bSTejun Heo if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) { 320805f0fe6bSTejun Heo rcu_barrier(); 320905f0fe6bSTejun Heo flush_work(&rwork->work); 321005f0fe6bSTejun Heo return true; 321105f0fe6bSTejun Heo } else { 321205f0fe6bSTejun Heo return flush_work(&rwork->work); 321305f0fe6bSTejun Heo } 321405f0fe6bSTejun Heo } 321505f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work); 321605f0fe6bSTejun Heo 3217f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork) 3218f72b8792SJens Axboe { 3219f72b8792SJens Axboe unsigned long flags; 3220f72b8792SJens Axboe int ret; 3221f72b8792SJens Axboe 3222f72b8792SJens Axboe do { 3223f72b8792SJens Axboe ret = try_to_grab_pending(work, is_dwork, &flags); 3224f72b8792SJens Axboe } while (unlikely(ret == -EAGAIN)); 3225f72b8792SJens Axboe 3226f72b8792SJens Axboe if (unlikely(ret < 0)) 3227f72b8792SJens Axboe return false; 3228f72b8792SJens Axboe 3229f72b8792SJens Axboe set_work_pool_and_clear_pending(work, get_work_pool_id(work)); 3230f72b8792SJens Axboe local_irq_restore(flags); 3231f72b8792SJens Axboe return ret; 3232f72b8792SJens Axboe } 3233f72b8792SJens Axboe 3234401a8d04STejun Heo /** 323557b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 323657b30ae7STejun Heo * @dwork: delayed_work to cancel 323709383498STejun Heo * 3238d185af30SYacine Belkadi * Kill off a pending delayed_work. 3239d185af30SYacine Belkadi * 3240d185af30SYacine Belkadi * Return: %true if @dwork was pending and canceled; %false if it wasn't 3241d185af30SYacine Belkadi * pending. 3242d185af30SYacine Belkadi * 3243d185af30SYacine Belkadi * Note: 3244d185af30SYacine Belkadi * The work callback function may still be running on return, unless 3245d185af30SYacine Belkadi * it returns %true and the work doesn't re-arm itself. Explicitly flush or 3246d185af30SYacine Belkadi * use cancel_delayed_work_sync() to wait on it. 324709383498STejun Heo * 324857b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 324909383498STejun Heo */ 325057b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 325109383498STejun Heo { 3252f72b8792SJens Axboe return __cancel_work(&dwork->work, true); 325309383498STejun Heo } 325457b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 325509383498STejun Heo 325609383498STejun Heo /** 3257401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 3258401a8d04STejun Heo * @dwork: the delayed work cancel 3259401a8d04STejun Heo * 3260401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 3261401a8d04STejun Heo * 3262d185af30SYacine Belkadi * Return: 3263401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 3264401a8d04STejun Heo */ 3265401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 32666e84d644SOleg Nesterov { 326736e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 32686e84d644SOleg Nesterov } 3269f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 32701da177e4SLinus Torvalds 32710fcb78c2SRolf Eike Beer /** 327231ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 3273b6136773SAndrew Morton * @func: the function to call 3274b6136773SAndrew Morton * 327531ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 327631ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 3277b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 327831ddd871STejun Heo * 3279d185af30SYacine Belkadi * Return: 328031ddd871STejun Heo * 0 on success, -errno on failure. 3281b6136773SAndrew Morton */ 328265f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 328315316ba8SChristoph Lameter { 328415316ba8SChristoph Lameter int cpu; 328538f51568SNamhyung Kim struct work_struct __percpu *works; 328615316ba8SChristoph Lameter 3287b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 3288b6136773SAndrew Morton if (!works) 328915316ba8SChristoph Lameter return -ENOMEM; 3290b6136773SAndrew Morton 329195402b38SGautham R Shenoy get_online_cpus(); 329293981800STejun Heo 329315316ba8SChristoph Lameter for_each_online_cpu(cpu) { 32949bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 32959bfb1839SIngo Molnar 32969bfb1839SIngo Molnar INIT_WORK(work, func); 32978de6d308SOleg Nesterov schedule_work_on(cpu, work); 329815316ba8SChristoph Lameter } 329993981800STejun Heo 330093981800STejun Heo for_each_online_cpu(cpu) 33018616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 330293981800STejun Heo 330395402b38SGautham R Shenoy put_online_cpus(); 3304b6136773SAndrew Morton free_percpu(works); 330515316ba8SChristoph Lameter return 0; 330615316ba8SChristoph Lameter } 330715316ba8SChristoph Lameter 3308eef6a7d5SAlan Stern /** 33091fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 33101fa44ecaSJames Bottomley * @fn: the function to execute 33111fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 33121fa44ecaSJames Bottomley * be available when the work executes) 33131fa44ecaSJames Bottomley * 33141fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 33151fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 33161fa44ecaSJames Bottomley * 3317d185af30SYacine Belkadi * Return: 0 - function was executed 33181fa44ecaSJames Bottomley * 1 - function was scheduled for execution 33191fa44ecaSJames Bottomley */ 332065f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 33211fa44ecaSJames Bottomley { 33221fa44ecaSJames Bottomley if (!in_interrupt()) { 332365f27f38SDavid Howells fn(&ew->work); 33241fa44ecaSJames Bottomley return 0; 33251fa44ecaSJames Bottomley } 33261fa44ecaSJames Bottomley 332765f27f38SDavid Howells INIT_WORK(&ew->work, fn); 33281fa44ecaSJames Bottomley schedule_work(&ew->work); 33291fa44ecaSJames Bottomley 33301fa44ecaSJames Bottomley return 1; 33311fa44ecaSJames Bottomley } 33321fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 33331fa44ecaSJames Bottomley 33347a4e344cSTejun Heo /** 33357a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 33367a4e344cSTejun Heo * @attrs: workqueue_attrs to free 33377a4e344cSTejun Heo * 33387a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 33397a4e344cSTejun Heo */ 3340513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs) 33417a4e344cSTejun Heo { 33427a4e344cSTejun Heo if (attrs) { 33437a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 33447a4e344cSTejun Heo kfree(attrs); 33457a4e344cSTejun Heo } 33467a4e344cSTejun Heo } 33477a4e344cSTejun Heo 33487a4e344cSTejun Heo /** 33497a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 33507a4e344cSTejun Heo * 33517a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 3352d185af30SYacine Belkadi * return it. 3353d185af30SYacine Belkadi * 3354d185af30SYacine Belkadi * Return: The allocated new workqueue_attr on success. %NULL on failure. 33557a4e344cSTejun Heo */ 3356513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void) 33577a4e344cSTejun Heo { 33587a4e344cSTejun Heo struct workqueue_attrs *attrs; 33597a4e344cSTejun Heo 3360be69d00dSThomas Gleixner attrs = kzalloc(sizeof(*attrs), GFP_KERNEL); 33617a4e344cSTejun Heo if (!attrs) 33627a4e344cSTejun Heo goto fail; 3363be69d00dSThomas Gleixner if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL)) 33647a4e344cSTejun Heo goto fail; 33657a4e344cSTejun Heo 336613e2e556STejun Heo cpumask_copy(attrs->cpumask, cpu_possible_mask); 33677a4e344cSTejun Heo return attrs; 33687a4e344cSTejun Heo fail: 33697a4e344cSTejun Heo free_workqueue_attrs(attrs); 33707a4e344cSTejun Heo return NULL; 33717a4e344cSTejun Heo } 33727a4e344cSTejun Heo 337329c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 337429c91e99STejun Heo const struct workqueue_attrs *from) 337529c91e99STejun Heo { 337629c91e99STejun Heo to->nice = from->nice; 337729c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 33782865a8fbSShaohua Li /* 33792865a8fbSShaohua Li * Unlike hash and equality test, this function doesn't ignore 33802865a8fbSShaohua Li * ->no_numa as it is used for both pool and wq attrs. Instead, 33812865a8fbSShaohua Li * get_unbound_pool() explicitly clears ->no_numa after copying. 33822865a8fbSShaohua Li */ 33832865a8fbSShaohua Li to->no_numa = from->no_numa; 338429c91e99STejun Heo } 338529c91e99STejun Heo 338629c91e99STejun Heo /* hash value of the content of @attr */ 338729c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 338829c91e99STejun Heo { 338929c91e99STejun Heo u32 hash = 0; 339029c91e99STejun Heo 339129c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 339213e2e556STejun Heo hash = jhash(cpumask_bits(attrs->cpumask), 339313e2e556STejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 339429c91e99STejun Heo return hash; 339529c91e99STejun Heo } 339629c91e99STejun Heo 339729c91e99STejun Heo /* content equality test */ 339829c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 339929c91e99STejun Heo const struct workqueue_attrs *b) 340029c91e99STejun Heo { 340129c91e99STejun Heo if (a->nice != b->nice) 340229c91e99STejun Heo return false; 340329c91e99STejun Heo if (!cpumask_equal(a->cpumask, b->cpumask)) 340429c91e99STejun Heo return false; 340529c91e99STejun Heo return true; 340629c91e99STejun Heo } 340729c91e99STejun Heo 34087a4e344cSTejun Heo /** 34097a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 34107a4e344cSTejun Heo * @pool: worker_pool to initialize 34117a4e344cSTejun Heo * 3412402dd89dSShailendra Verma * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs. 3413d185af30SYacine Belkadi * 3414d185af30SYacine Belkadi * Return: 0 on success, -errno on failure. Even on failure, all fields 341529c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 341629c91e99STejun Heo * on @pool safely to release it. 34177a4e344cSTejun Heo */ 34187a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 34194e1a1f9aSTejun Heo { 34204e1a1f9aSTejun Heo spin_lock_init(&pool->lock); 342129c91e99STejun Heo pool->id = -1; 342229c91e99STejun Heo pool->cpu = -1; 3423f3f90ad4STejun Heo pool->node = NUMA_NO_NODE; 34244e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 342582607adcSTejun Heo pool->watchdog_ts = jiffies; 34264e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 34274e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 34284e1a1f9aSTejun Heo hash_init(pool->busy_hash); 34294e1a1f9aSTejun Heo 343032a6c723SKees Cook timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE); 34314e1a1f9aSTejun Heo 343232a6c723SKees Cook timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0); 34334e1a1f9aSTejun Heo 3434da028469SLai Jiangshan INIT_LIST_HEAD(&pool->workers); 34357a4e344cSTejun Heo 34367cda9aaeSLai Jiangshan ida_init(&pool->worker_ida); 343729c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 343829c91e99STejun Heo pool->refcnt = 1; 343929c91e99STejun Heo 344029c91e99STejun Heo /* shouldn't fail above this point */ 3441be69d00dSThomas Gleixner pool->attrs = alloc_workqueue_attrs(); 34427a4e344cSTejun Heo if (!pool->attrs) 34437a4e344cSTejun Heo return -ENOMEM; 34447a4e344cSTejun Heo return 0; 34454e1a1f9aSTejun Heo } 34464e1a1f9aSTejun Heo 3447669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP 3448669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 3449669de8bdSBart Van Assche { 3450669de8bdSBart Van Assche char *lock_name; 3451669de8bdSBart Van Assche 3452669de8bdSBart Van Assche lockdep_register_key(&wq->key); 3453669de8bdSBart Van Assche lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name); 3454669de8bdSBart Van Assche if (!lock_name) 3455669de8bdSBart Van Assche lock_name = wq->name; 345669a106c0SQian Cai 345769a106c0SQian Cai wq->lock_name = lock_name; 3458669de8bdSBart Van Assche lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0); 3459669de8bdSBart Van Assche } 3460669de8bdSBart Van Assche 3461669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 3462669de8bdSBart Van Assche { 3463669de8bdSBart Van Assche lockdep_unregister_key(&wq->key); 3464669de8bdSBart Van Assche } 3465669de8bdSBart Van Assche 3466669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 3467669de8bdSBart Van Assche { 3468669de8bdSBart Van Assche if (wq->lock_name != wq->name) 3469669de8bdSBart Van Assche kfree(wq->lock_name); 3470669de8bdSBart Van Assche } 3471669de8bdSBart Van Assche #else 3472669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 3473669de8bdSBart Van Assche { 3474669de8bdSBart Van Assche } 3475669de8bdSBart Van Assche 3476669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 3477669de8bdSBart Van Assche { 3478669de8bdSBart Van Assche } 3479669de8bdSBart Van Assche 3480669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 3481669de8bdSBart Van Assche { 3482669de8bdSBart Van Assche } 3483669de8bdSBart Van Assche #endif 3484669de8bdSBart Van Assche 3485e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu) 3486e2dca7adSTejun Heo { 3487e2dca7adSTejun Heo struct workqueue_struct *wq = 3488e2dca7adSTejun Heo container_of(rcu, struct workqueue_struct, rcu); 3489e2dca7adSTejun Heo 3490669de8bdSBart Van Assche wq_free_lockdep(wq); 3491669de8bdSBart Van Assche 3492e2dca7adSTejun Heo if (!(wq->flags & WQ_UNBOUND)) 3493e2dca7adSTejun Heo free_percpu(wq->cpu_pwqs); 3494e2dca7adSTejun Heo else 3495e2dca7adSTejun Heo free_workqueue_attrs(wq->unbound_attrs); 3496e2dca7adSTejun Heo 3497e2dca7adSTejun Heo kfree(wq->rescuer); 3498e2dca7adSTejun Heo kfree(wq); 3499e2dca7adSTejun Heo } 3500e2dca7adSTejun Heo 350129c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 350229c91e99STejun Heo { 350329c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 350429c91e99STejun Heo 35057cda9aaeSLai Jiangshan ida_destroy(&pool->worker_ida); 350629c91e99STejun Heo free_workqueue_attrs(pool->attrs); 350729c91e99STejun Heo kfree(pool); 350829c91e99STejun Heo } 350929c91e99STejun Heo 351029c91e99STejun Heo /** 351129c91e99STejun Heo * put_unbound_pool - put a worker_pool 351229c91e99STejun Heo * @pool: worker_pool to put 351329c91e99STejun Heo * 351424acfb71SThomas Gleixner * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU 3515c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 3516c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 3517c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 3518a892caccSTejun Heo * 3519a892caccSTejun Heo * Should be called with wq_pool_mutex held. 352029c91e99STejun Heo */ 352129c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 352229c91e99STejun Heo { 352360f5a4bcSLai Jiangshan DECLARE_COMPLETION_ONSTACK(detach_completion); 352429c91e99STejun Heo struct worker *worker; 352529c91e99STejun Heo 3526a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3527a892caccSTejun Heo 3528a892caccSTejun Heo if (--pool->refcnt) 352929c91e99STejun Heo return; 353029c91e99STejun Heo 353129c91e99STejun Heo /* sanity checks */ 353261d0fbb4SLai Jiangshan if (WARN_ON(!(pool->cpu < 0)) || 3533a892caccSTejun Heo WARN_ON(!list_empty(&pool->worklist))) 353429c91e99STejun Heo return; 353529c91e99STejun Heo 353629c91e99STejun Heo /* release id and unhash */ 353729c91e99STejun Heo if (pool->id >= 0) 353829c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 353929c91e99STejun Heo hash_del(&pool->hash_node); 354029c91e99STejun Heo 3541c5aa87bbSTejun Heo /* 3542692b4825STejun Heo * Become the manager and destroy all workers. This prevents 3543692b4825STejun Heo * @pool's workers from blocking on attach_mutex. We're the last 3544692b4825STejun Heo * manager and @pool gets freed with the flag set. 3545c5aa87bbSTejun Heo */ 354660f5a4bcSLai Jiangshan spin_lock_irq(&pool->lock); 3547692b4825STejun Heo wait_event_lock_irq(wq_manager_wait, 3548692b4825STejun Heo !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock); 3549692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 3550692b4825STejun Heo 35511037de36SLai Jiangshan while ((worker = first_idle_worker(pool))) 355229c91e99STejun Heo destroy_worker(worker); 355329c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 355429c91e99STejun Heo spin_unlock_irq(&pool->lock); 355560f5a4bcSLai Jiangshan 35561258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 3557da028469SLai Jiangshan if (!list_empty(&pool->workers)) 355860f5a4bcSLai Jiangshan pool->detach_completion = &detach_completion; 35591258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 356060f5a4bcSLai Jiangshan 356160f5a4bcSLai Jiangshan if (pool->detach_completion) 356260f5a4bcSLai Jiangshan wait_for_completion(pool->detach_completion); 356360f5a4bcSLai Jiangshan 356429c91e99STejun Heo /* shut down the timers */ 356529c91e99STejun Heo del_timer_sync(&pool->idle_timer); 356629c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 356729c91e99STejun Heo 356824acfb71SThomas Gleixner /* RCU protected to allow dereferences from get_work_pool() */ 356925b00775SPaul E. McKenney call_rcu(&pool->rcu, rcu_free_pool); 357029c91e99STejun Heo } 357129c91e99STejun Heo 357229c91e99STejun Heo /** 357329c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 357429c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 357529c91e99STejun Heo * 357629c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 357729c91e99STejun Heo * reference count and return it. If there already is a matching 357829c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 3579d185af30SYacine Belkadi * create a new one. 3580a892caccSTejun Heo * 3581a892caccSTejun Heo * Should be called with wq_pool_mutex held. 3582d185af30SYacine Belkadi * 3583d185af30SYacine Belkadi * Return: On success, a worker_pool with the same attributes as @attrs. 3584d185af30SYacine Belkadi * On failure, %NULL. 358529c91e99STejun Heo */ 358629c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 358729c91e99STejun Heo { 358829c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 358929c91e99STejun Heo struct worker_pool *pool; 3590f3f90ad4STejun Heo int node; 3591e2273584SXunlei Pang int target_node = NUMA_NO_NODE; 359229c91e99STejun Heo 3593a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 359429c91e99STejun Heo 359529c91e99STejun Heo /* do we already have a matching pool? */ 359629c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 359729c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 359829c91e99STejun Heo pool->refcnt++; 35993fb1823cSLai Jiangshan return pool; 360029c91e99STejun Heo } 360129c91e99STejun Heo } 360229c91e99STejun Heo 3603e2273584SXunlei Pang /* if cpumask is contained inside a NUMA node, we belong to that node */ 3604e2273584SXunlei Pang if (wq_numa_enabled) { 3605e2273584SXunlei Pang for_each_node(node) { 3606e2273584SXunlei Pang if (cpumask_subset(attrs->cpumask, 3607e2273584SXunlei Pang wq_numa_possible_cpumask[node])) { 3608e2273584SXunlei Pang target_node = node; 3609e2273584SXunlei Pang break; 3610e2273584SXunlei Pang } 3611e2273584SXunlei Pang } 3612e2273584SXunlei Pang } 3613e2273584SXunlei Pang 361429c91e99STejun Heo /* nope, create a new one */ 3615e2273584SXunlei Pang pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node); 361629c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 361729c91e99STejun Heo goto fail; 361829c91e99STejun Heo 36198864b4e5STejun Heo lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */ 362029c91e99STejun Heo copy_workqueue_attrs(pool->attrs, attrs); 3621e2273584SXunlei Pang pool->node = target_node; 362229c91e99STejun Heo 36232865a8fbSShaohua Li /* 36242865a8fbSShaohua Li * no_numa isn't a worker_pool attribute, always clear it. See 36252865a8fbSShaohua Li * 'struct workqueue_attrs' comments for detail. 36262865a8fbSShaohua Li */ 36272865a8fbSShaohua Li pool->attrs->no_numa = false; 36282865a8fbSShaohua Li 362929c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 363029c91e99STejun Heo goto fail; 363129c91e99STejun Heo 363229c91e99STejun Heo /* create and start the initial worker */ 36333347fa09STejun Heo if (wq_online && !create_worker(pool)) 363429c91e99STejun Heo goto fail; 363529c91e99STejun Heo 363629c91e99STejun Heo /* install */ 363729c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 36383fb1823cSLai Jiangshan 363929c91e99STejun Heo return pool; 364029c91e99STejun Heo fail: 364129c91e99STejun Heo if (pool) 364229c91e99STejun Heo put_unbound_pool(pool); 364329c91e99STejun Heo return NULL; 364429c91e99STejun Heo } 364529c91e99STejun Heo 36468864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu) 36478864b4e5STejun Heo { 36488864b4e5STejun Heo kmem_cache_free(pwq_cache, 36498864b4e5STejun Heo container_of(rcu, struct pool_workqueue, rcu)); 36508864b4e5STejun Heo } 36518864b4e5STejun Heo 36528864b4e5STejun Heo /* 36538864b4e5STejun Heo * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt 36548864b4e5STejun Heo * and needs to be destroyed. 36558864b4e5STejun Heo */ 36568864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work) 36578864b4e5STejun Heo { 36588864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 36598864b4e5STejun Heo unbound_release_work); 36608864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 36618864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 3662bc0caf09STejun Heo bool is_last; 36638864b4e5STejun Heo 36648864b4e5STejun Heo if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND))) 36658864b4e5STejun Heo return; 36668864b4e5STejun Heo 36673c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 36688864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 3669bc0caf09STejun Heo is_last = list_empty(&wq->pwqs); 36703c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 36718864b4e5STejun Heo 3672a892caccSTejun Heo mutex_lock(&wq_pool_mutex); 36738864b4e5STejun Heo put_unbound_pool(pool); 3674a892caccSTejun Heo mutex_unlock(&wq_pool_mutex); 3675a892caccSTejun Heo 367625b00775SPaul E. McKenney call_rcu(&pwq->rcu, rcu_free_pwq); 36778864b4e5STejun Heo 36788864b4e5STejun Heo /* 36798864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 3680e2dca7adSTejun Heo * is gonna access it anymore. Schedule RCU free. 36818864b4e5STejun Heo */ 3682669de8bdSBart Van Assche if (is_last) { 3683669de8bdSBart Van Assche wq_unregister_lockdep(wq); 368425b00775SPaul E. McKenney call_rcu(&wq->rcu, rcu_free_wq); 36856029a918STejun Heo } 3686669de8bdSBart Van Assche } 36878864b4e5STejun Heo 36880fbd95aaSTejun Heo /** 3689699ce097STejun Heo * pwq_adjust_max_active - update a pwq's max_active to the current setting 36900fbd95aaSTejun Heo * @pwq: target pool_workqueue 36910fbd95aaSTejun Heo * 3692699ce097STejun Heo * If @pwq isn't freezing, set @pwq->max_active to the associated 3693699ce097STejun Heo * workqueue's saved_max_active and activate delayed work items 3694699ce097STejun Heo * accordingly. If @pwq is freezing, clear @pwq->max_active to zero. 36950fbd95aaSTejun Heo */ 3696699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq) 36970fbd95aaSTejun Heo { 3698699ce097STejun Heo struct workqueue_struct *wq = pwq->wq; 3699699ce097STejun Heo bool freezable = wq->flags & WQ_FREEZABLE; 37003347fa09STejun Heo unsigned long flags; 3701699ce097STejun Heo 3702699ce097STejun Heo /* for @wq->saved_max_active */ 3703a357fc03SLai Jiangshan lockdep_assert_held(&wq->mutex); 3704699ce097STejun Heo 3705699ce097STejun Heo /* fast exit for non-freezable wqs */ 3706699ce097STejun Heo if (!freezable && pwq->max_active == wq->saved_max_active) 3707699ce097STejun Heo return; 3708699ce097STejun Heo 37093347fa09STejun Heo /* this function can be called during early boot w/ irq disabled */ 37103347fa09STejun Heo spin_lock_irqsave(&pwq->pool->lock, flags); 3711699ce097STejun Heo 371274b414eaSLai Jiangshan /* 371374b414eaSLai Jiangshan * During [un]freezing, the caller is responsible for ensuring that 371474b414eaSLai Jiangshan * this function is called at least once after @workqueue_freezing 371574b414eaSLai Jiangshan * is updated and visible. 371674b414eaSLai Jiangshan */ 371774b414eaSLai Jiangshan if (!freezable || !workqueue_freezing) { 3718699ce097STejun Heo pwq->max_active = wq->saved_max_active; 37190fbd95aaSTejun Heo 37200fbd95aaSTejun Heo while (!list_empty(&pwq->delayed_works) && 37210fbd95aaSTejun Heo pwq->nr_active < pwq->max_active) 37220fbd95aaSTejun Heo pwq_activate_first_delayed(pwq); 3723951a078aSLai Jiangshan 3724951a078aSLai Jiangshan /* 3725951a078aSLai Jiangshan * Need to kick a worker after thawed or an unbound wq's 3726951a078aSLai Jiangshan * max_active is bumped. It's a slow path. Do it always. 3727951a078aSLai Jiangshan */ 3728951a078aSLai Jiangshan wake_up_worker(pwq->pool); 3729699ce097STejun Heo } else { 3730699ce097STejun Heo pwq->max_active = 0; 3731699ce097STejun Heo } 3732699ce097STejun Heo 37333347fa09STejun Heo spin_unlock_irqrestore(&pwq->pool->lock, flags); 37340fbd95aaSTejun Heo } 37350fbd95aaSTejun Heo 3736e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */ 3737f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, 3738f147f29eSTejun Heo struct worker_pool *pool) 3739d2c1d404STejun Heo { 3740d2c1d404STejun Heo BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); 3741d2c1d404STejun Heo 3742e50aba9aSTejun Heo memset(pwq, 0, sizeof(*pwq)); 3743e50aba9aSTejun Heo 3744d2c1d404STejun Heo pwq->pool = pool; 3745d2c1d404STejun Heo pwq->wq = wq; 3746d2c1d404STejun Heo pwq->flush_color = -1; 37478864b4e5STejun Heo pwq->refcnt = 1; 3748d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->delayed_works); 37491befcf30STejun Heo INIT_LIST_HEAD(&pwq->pwqs_node); 3750d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 37518864b4e5STejun Heo INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn); 3752f147f29eSTejun Heo } 3753d2c1d404STejun Heo 3754f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */ 37551befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq) 3756f147f29eSTejun Heo { 3757f147f29eSTejun Heo struct workqueue_struct *wq = pwq->wq; 3758f147f29eSTejun Heo 3759f147f29eSTejun Heo lockdep_assert_held(&wq->mutex); 376075ccf595STejun Heo 37611befcf30STejun Heo /* may be called multiple times, ignore if already linked */ 37621befcf30STejun Heo if (!list_empty(&pwq->pwqs_node)) 37631befcf30STejun Heo return; 37641befcf30STejun Heo 376529b1cb41SLai Jiangshan /* set the matching work_color */ 376675ccf595STejun Heo pwq->work_color = wq->work_color; 3767983ca25eSTejun Heo 3768983ca25eSTejun Heo /* sync max_active to the current setting */ 3769983ca25eSTejun Heo pwq_adjust_max_active(pwq); 3770983ca25eSTejun Heo 3771983ca25eSTejun Heo /* link in @pwq */ 37729e8cd2f5STejun Heo list_add_rcu(&pwq->pwqs_node, &wq->pwqs); 3773df2d5ae4STejun Heo } 37746029a918STejun Heo 3775f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ 3776f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, 3777f147f29eSTejun Heo const struct workqueue_attrs *attrs) 3778f147f29eSTejun Heo { 3779f147f29eSTejun Heo struct worker_pool *pool; 3780f147f29eSTejun Heo struct pool_workqueue *pwq; 3781f147f29eSTejun Heo 3782f147f29eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3783f147f29eSTejun Heo 3784f147f29eSTejun Heo pool = get_unbound_pool(attrs); 3785f147f29eSTejun Heo if (!pool) 3786f147f29eSTejun Heo return NULL; 3787f147f29eSTejun Heo 3788e50aba9aSTejun Heo pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); 3789f147f29eSTejun Heo if (!pwq) { 3790f147f29eSTejun Heo put_unbound_pool(pool); 3791f147f29eSTejun Heo return NULL; 3792f147f29eSTejun Heo } 3793f147f29eSTejun Heo 3794f147f29eSTejun Heo init_pwq(pwq, wq, pool); 3795f147f29eSTejun Heo return pwq; 3796d2c1d404STejun Heo } 3797d2c1d404STejun Heo 37984c16bd32STejun Heo /** 379930186c6fSGong Zhaogang * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node 3800042f7df1SLai Jiangshan * @attrs: the wq_attrs of the default pwq of the target workqueue 38014c16bd32STejun Heo * @node: the target NUMA node 38024c16bd32STejun Heo * @cpu_going_down: if >= 0, the CPU to consider as offline 38034c16bd32STejun Heo * @cpumask: outarg, the resulting cpumask 38044c16bd32STejun Heo * 38054c16bd32STejun Heo * Calculate the cpumask a workqueue with @attrs should use on @node. If 38064c16bd32STejun Heo * @cpu_going_down is >= 0, that cpu is considered offline during 3807d185af30SYacine Belkadi * calculation. The result is stored in @cpumask. 38084c16bd32STejun Heo * 38094c16bd32STejun Heo * If NUMA affinity is not enabled, @attrs->cpumask is always used. If 38104c16bd32STejun Heo * enabled and @node has online CPUs requested by @attrs, the returned 38114c16bd32STejun Heo * cpumask is the intersection of the possible CPUs of @node and 38124c16bd32STejun Heo * @attrs->cpumask. 38134c16bd32STejun Heo * 38144c16bd32STejun Heo * The caller is responsible for ensuring that the cpumask of @node stays 38154c16bd32STejun Heo * stable. 3816d185af30SYacine Belkadi * 3817d185af30SYacine Belkadi * Return: %true if the resulting @cpumask is different from @attrs->cpumask, 3818d185af30SYacine Belkadi * %false if equal. 38194c16bd32STejun Heo */ 38204c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node, 38214c16bd32STejun Heo int cpu_going_down, cpumask_t *cpumask) 38224c16bd32STejun Heo { 3823d55262c4STejun Heo if (!wq_numa_enabled || attrs->no_numa) 38244c16bd32STejun Heo goto use_dfl; 38254c16bd32STejun Heo 38264c16bd32STejun Heo /* does @node have any online CPUs @attrs wants? */ 38274c16bd32STejun Heo cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask); 38284c16bd32STejun Heo if (cpu_going_down >= 0) 38294c16bd32STejun Heo cpumask_clear_cpu(cpu_going_down, cpumask); 38304c16bd32STejun Heo 38314c16bd32STejun Heo if (cpumask_empty(cpumask)) 38324c16bd32STejun Heo goto use_dfl; 38334c16bd32STejun Heo 38344c16bd32STejun Heo /* yeap, return possible CPUs in @node that @attrs wants */ 38354c16bd32STejun Heo cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]); 38361ad0f0a7SMichael Bringmann 38371ad0f0a7SMichael Bringmann if (cpumask_empty(cpumask)) { 38381ad0f0a7SMichael Bringmann pr_warn_once("WARNING: workqueue cpumask: online intersect > " 38391ad0f0a7SMichael Bringmann "possible intersect\n"); 38401ad0f0a7SMichael Bringmann return false; 38411ad0f0a7SMichael Bringmann } 38421ad0f0a7SMichael Bringmann 38434c16bd32STejun Heo return !cpumask_equal(cpumask, attrs->cpumask); 38444c16bd32STejun Heo 38454c16bd32STejun Heo use_dfl: 38464c16bd32STejun Heo cpumask_copy(cpumask, attrs->cpumask); 38474c16bd32STejun Heo return false; 38484c16bd32STejun Heo } 38494c16bd32STejun Heo 38501befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */ 38511befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq, 38521befcf30STejun Heo int node, 38531befcf30STejun Heo struct pool_workqueue *pwq) 38541befcf30STejun Heo { 38551befcf30STejun Heo struct pool_workqueue *old_pwq; 38561befcf30STejun Heo 38575b95e1afSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 38581befcf30STejun Heo lockdep_assert_held(&wq->mutex); 38591befcf30STejun Heo 38601befcf30STejun Heo /* link_pwq() can handle duplicate calls */ 38611befcf30STejun Heo link_pwq(pwq); 38621befcf30STejun Heo 38631befcf30STejun Heo old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); 38641befcf30STejun Heo rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq); 38651befcf30STejun Heo return old_pwq; 38661befcf30STejun Heo } 38671befcf30STejun Heo 38682d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */ 38692d5f0764SLai Jiangshan struct apply_wqattrs_ctx { 38702d5f0764SLai Jiangshan struct workqueue_struct *wq; /* target workqueue */ 38712d5f0764SLai Jiangshan struct workqueue_attrs *attrs; /* attrs to apply */ 3872042f7df1SLai Jiangshan struct list_head list; /* queued for batching commit */ 38732d5f0764SLai Jiangshan struct pool_workqueue *dfl_pwq; 38742d5f0764SLai Jiangshan struct pool_workqueue *pwq_tbl[]; 38752d5f0764SLai Jiangshan }; 38762d5f0764SLai Jiangshan 38772d5f0764SLai Jiangshan /* free the resources after success or abort */ 38782d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx) 38792d5f0764SLai Jiangshan { 38802d5f0764SLai Jiangshan if (ctx) { 38812d5f0764SLai Jiangshan int node; 38822d5f0764SLai Jiangshan 38832d5f0764SLai Jiangshan for_each_node(node) 38842d5f0764SLai Jiangshan put_pwq_unlocked(ctx->pwq_tbl[node]); 38852d5f0764SLai Jiangshan put_pwq_unlocked(ctx->dfl_pwq); 38862d5f0764SLai Jiangshan 38872d5f0764SLai Jiangshan free_workqueue_attrs(ctx->attrs); 38882d5f0764SLai Jiangshan 38892d5f0764SLai Jiangshan kfree(ctx); 38902d5f0764SLai Jiangshan } 38912d5f0764SLai Jiangshan } 38922d5f0764SLai Jiangshan 38932d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */ 38942d5f0764SLai Jiangshan static struct apply_wqattrs_ctx * 38952d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq, 38962d5f0764SLai Jiangshan const struct workqueue_attrs *attrs) 38972d5f0764SLai Jiangshan { 38982d5f0764SLai Jiangshan struct apply_wqattrs_ctx *ctx; 38992d5f0764SLai Jiangshan struct workqueue_attrs *new_attrs, *tmp_attrs; 39002d5f0764SLai Jiangshan int node; 39012d5f0764SLai Jiangshan 39022d5f0764SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 39032d5f0764SLai Jiangshan 3904acafe7e3SKees Cook ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL); 39052d5f0764SLai Jiangshan 3906be69d00dSThomas Gleixner new_attrs = alloc_workqueue_attrs(); 3907be69d00dSThomas Gleixner tmp_attrs = alloc_workqueue_attrs(); 39082d5f0764SLai Jiangshan if (!ctx || !new_attrs || !tmp_attrs) 39092d5f0764SLai Jiangshan goto out_free; 39102d5f0764SLai Jiangshan 3911042f7df1SLai Jiangshan /* 3912042f7df1SLai Jiangshan * Calculate the attrs of the default pwq. 3913042f7df1SLai Jiangshan * If the user configured cpumask doesn't overlap with the 3914042f7df1SLai Jiangshan * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask. 3915042f7df1SLai Jiangshan */ 39162d5f0764SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 3917b05a7928SFrederic Weisbecker cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask); 3918042f7df1SLai Jiangshan if (unlikely(cpumask_empty(new_attrs->cpumask))) 3919042f7df1SLai Jiangshan cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask); 39202d5f0764SLai Jiangshan 39212d5f0764SLai Jiangshan /* 39222d5f0764SLai Jiangshan * We may create multiple pwqs with differing cpumasks. Make a 39232d5f0764SLai Jiangshan * copy of @new_attrs which will be modified and used to obtain 39242d5f0764SLai Jiangshan * pools. 39252d5f0764SLai Jiangshan */ 39262d5f0764SLai Jiangshan copy_workqueue_attrs(tmp_attrs, new_attrs); 39272d5f0764SLai Jiangshan 39282d5f0764SLai Jiangshan /* 39292d5f0764SLai Jiangshan * If something goes wrong during CPU up/down, we'll fall back to 39302d5f0764SLai Jiangshan * the default pwq covering whole @attrs->cpumask. Always create 39312d5f0764SLai Jiangshan * it even if we don't use it immediately. 39322d5f0764SLai Jiangshan */ 39332d5f0764SLai Jiangshan ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs); 39342d5f0764SLai Jiangshan if (!ctx->dfl_pwq) 39352d5f0764SLai Jiangshan goto out_free; 39362d5f0764SLai Jiangshan 39372d5f0764SLai Jiangshan for_each_node(node) { 3938042f7df1SLai Jiangshan if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) { 39392d5f0764SLai Jiangshan ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs); 39402d5f0764SLai Jiangshan if (!ctx->pwq_tbl[node]) 39412d5f0764SLai Jiangshan goto out_free; 39422d5f0764SLai Jiangshan } else { 39432d5f0764SLai Jiangshan ctx->dfl_pwq->refcnt++; 39442d5f0764SLai Jiangshan ctx->pwq_tbl[node] = ctx->dfl_pwq; 39452d5f0764SLai Jiangshan } 39462d5f0764SLai Jiangshan } 39472d5f0764SLai Jiangshan 3948042f7df1SLai Jiangshan /* save the user configured attrs and sanitize it. */ 3949042f7df1SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 3950042f7df1SLai Jiangshan cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); 39512d5f0764SLai Jiangshan ctx->attrs = new_attrs; 3952042f7df1SLai Jiangshan 39532d5f0764SLai Jiangshan ctx->wq = wq; 39542d5f0764SLai Jiangshan free_workqueue_attrs(tmp_attrs); 39552d5f0764SLai Jiangshan return ctx; 39562d5f0764SLai Jiangshan 39572d5f0764SLai Jiangshan out_free: 39582d5f0764SLai Jiangshan free_workqueue_attrs(tmp_attrs); 39592d5f0764SLai Jiangshan free_workqueue_attrs(new_attrs); 39602d5f0764SLai Jiangshan apply_wqattrs_cleanup(ctx); 39612d5f0764SLai Jiangshan return NULL; 39622d5f0764SLai Jiangshan } 39632d5f0764SLai Jiangshan 39642d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */ 39652d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx) 39662d5f0764SLai Jiangshan { 39672d5f0764SLai Jiangshan int node; 39682d5f0764SLai Jiangshan 39692d5f0764SLai Jiangshan /* all pwqs have been created successfully, let's install'em */ 39702d5f0764SLai Jiangshan mutex_lock(&ctx->wq->mutex); 39712d5f0764SLai Jiangshan 39722d5f0764SLai Jiangshan copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs); 39732d5f0764SLai Jiangshan 39742d5f0764SLai Jiangshan /* save the previous pwq and install the new one */ 39752d5f0764SLai Jiangshan for_each_node(node) 39762d5f0764SLai Jiangshan ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node, 39772d5f0764SLai Jiangshan ctx->pwq_tbl[node]); 39782d5f0764SLai Jiangshan 39792d5f0764SLai Jiangshan /* @dfl_pwq might not have been used, ensure it's linked */ 39802d5f0764SLai Jiangshan link_pwq(ctx->dfl_pwq); 39812d5f0764SLai Jiangshan swap(ctx->wq->dfl_pwq, ctx->dfl_pwq); 39822d5f0764SLai Jiangshan 39832d5f0764SLai Jiangshan mutex_unlock(&ctx->wq->mutex); 39842d5f0764SLai Jiangshan } 39852d5f0764SLai Jiangshan 3986a0111cf6SLai Jiangshan static void apply_wqattrs_lock(void) 3987a0111cf6SLai Jiangshan { 3988a0111cf6SLai Jiangshan /* CPUs should stay stable across pwq creations and installations */ 3989a0111cf6SLai Jiangshan get_online_cpus(); 3990a0111cf6SLai Jiangshan mutex_lock(&wq_pool_mutex); 3991a0111cf6SLai Jiangshan } 3992a0111cf6SLai Jiangshan 3993a0111cf6SLai Jiangshan static void apply_wqattrs_unlock(void) 3994a0111cf6SLai Jiangshan { 3995a0111cf6SLai Jiangshan mutex_unlock(&wq_pool_mutex); 3996a0111cf6SLai Jiangshan put_online_cpus(); 3997a0111cf6SLai Jiangshan } 3998a0111cf6SLai Jiangshan 3999a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq, 4000a0111cf6SLai Jiangshan const struct workqueue_attrs *attrs) 4001a0111cf6SLai Jiangshan { 4002a0111cf6SLai Jiangshan struct apply_wqattrs_ctx *ctx; 4003a0111cf6SLai Jiangshan 4004a0111cf6SLai Jiangshan /* only unbound workqueues can change attributes */ 4005a0111cf6SLai Jiangshan if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 4006a0111cf6SLai Jiangshan return -EINVAL; 4007a0111cf6SLai Jiangshan 4008a0111cf6SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 40090a94efb5STejun Heo if (!list_empty(&wq->pwqs)) { 40100a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 4011a0111cf6SLai Jiangshan return -EINVAL; 4012a0111cf6SLai Jiangshan 40130a94efb5STejun Heo wq->flags &= ~__WQ_ORDERED; 40140a94efb5STejun Heo } 40150a94efb5STejun Heo 4016a0111cf6SLai Jiangshan ctx = apply_wqattrs_prepare(wq, attrs); 40176201171eSwanghaibin if (!ctx) 40186201171eSwanghaibin return -ENOMEM; 4019a0111cf6SLai Jiangshan 4020a0111cf6SLai Jiangshan /* the ctx has been prepared successfully, let's commit it */ 4021a0111cf6SLai Jiangshan apply_wqattrs_commit(ctx); 4022a0111cf6SLai Jiangshan apply_wqattrs_cleanup(ctx); 4023a0111cf6SLai Jiangshan 40246201171eSwanghaibin return 0; 4025a0111cf6SLai Jiangshan } 4026a0111cf6SLai Jiangshan 40279e8cd2f5STejun Heo /** 40289e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 40299e8cd2f5STejun Heo * @wq: the target workqueue 40309e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 40319e8cd2f5STejun Heo * 40324c16bd32STejun Heo * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA 40334c16bd32STejun Heo * machines, this function maps a separate pwq to each NUMA node with 40344c16bd32STejun Heo * possibles CPUs in @attrs->cpumask so that work items are affine to the 40354c16bd32STejun Heo * NUMA node it was issued on. Older pwqs are released as in-flight work 40364c16bd32STejun Heo * items finish. Note that a work item which repeatedly requeues itself 40374c16bd32STejun Heo * back-to-back will stay on its current pwq. 40389e8cd2f5STejun Heo * 4039d185af30SYacine Belkadi * Performs GFP_KERNEL allocations. 4040d185af30SYacine Belkadi * 4041509b3204SDaniel Jordan * Assumes caller has CPU hotplug read exclusion, i.e. get_online_cpus(). 4042509b3204SDaniel Jordan * 4043d185af30SYacine Belkadi * Return: 0 on success and -errno on failure. 40449e8cd2f5STejun Heo */ 4045513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq, 40469e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 40479e8cd2f5STejun Heo { 4048a0111cf6SLai Jiangshan int ret; 40499e8cd2f5STejun Heo 4050509b3204SDaniel Jordan lockdep_assert_cpus_held(); 4051509b3204SDaniel Jordan 4052509b3204SDaniel Jordan mutex_lock(&wq_pool_mutex); 4053a0111cf6SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 4054509b3204SDaniel Jordan mutex_unlock(&wq_pool_mutex); 40552d5f0764SLai Jiangshan 40562d5f0764SLai Jiangshan return ret; 40579e8cd2f5STejun Heo } 40589e8cd2f5STejun Heo 40594c16bd32STejun Heo /** 40604c16bd32STejun Heo * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug 40614c16bd32STejun Heo * @wq: the target workqueue 40624c16bd32STejun Heo * @cpu: the CPU coming up or going down 40634c16bd32STejun Heo * @online: whether @cpu is coming up or going down 40644c16bd32STejun Heo * 40654c16bd32STejun Heo * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and 40664c16bd32STejun Heo * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of 40674c16bd32STejun Heo * @wq accordingly. 40684c16bd32STejun Heo * 40694c16bd32STejun Heo * If NUMA affinity can't be adjusted due to memory allocation failure, it 40704c16bd32STejun Heo * falls back to @wq->dfl_pwq which may not be optimal but is always 40714c16bd32STejun Heo * correct. 40724c16bd32STejun Heo * 40734c16bd32STejun Heo * Note that when the last allowed CPU of a NUMA node goes offline for a 40744c16bd32STejun Heo * workqueue with a cpumask spanning multiple nodes, the workers which were 40754c16bd32STejun Heo * already executing the work items for the workqueue will lose their CPU 40764c16bd32STejun Heo * affinity and may execute on any CPU. This is similar to how per-cpu 40774c16bd32STejun Heo * workqueues behave on CPU_DOWN. If a workqueue user wants strict 40784c16bd32STejun Heo * affinity, it's the user's responsibility to flush the work item from 40794c16bd32STejun Heo * CPU_DOWN_PREPARE. 40804c16bd32STejun Heo */ 40814c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu, 40824c16bd32STejun Heo bool online) 40834c16bd32STejun Heo { 40844c16bd32STejun Heo int node = cpu_to_node(cpu); 40854c16bd32STejun Heo int cpu_off = online ? -1 : cpu; 40864c16bd32STejun Heo struct pool_workqueue *old_pwq = NULL, *pwq; 40874c16bd32STejun Heo struct workqueue_attrs *target_attrs; 40884c16bd32STejun Heo cpumask_t *cpumask; 40894c16bd32STejun Heo 40904c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 40914c16bd32STejun Heo 4092f7142ed4SLai Jiangshan if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) || 4093f7142ed4SLai Jiangshan wq->unbound_attrs->no_numa) 40944c16bd32STejun Heo return; 40954c16bd32STejun Heo 40964c16bd32STejun Heo /* 40974c16bd32STejun Heo * We don't wanna alloc/free wq_attrs for each wq for each CPU. 40984c16bd32STejun Heo * Let's use a preallocated one. The following buf is protected by 40994c16bd32STejun Heo * CPU hotplug exclusion. 41004c16bd32STejun Heo */ 41014c16bd32STejun Heo target_attrs = wq_update_unbound_numa_attrs_buf; 41024c16bd32STejun Heo cpumask = target_attrs->cpumask; 41034c16bd32STejun Heo 41044c16bd32STejun Heo copy_workqueue_attrs(target_attrs, wq->unbound_attrs); 41054c16bd32STejun Heo pwq = unbound_pwq_by_node(wq, node); 41064c16bd32STejun Heo 41074c16bd32STejun Heo /* 41084c16bd32STejun Heo * Let's determine what needs to be done. If the target cpumask is 4109042f7df1SLai Jiangshan * different from the default pwq's, we need to compare it to @pwq's 4110042f7df1SLai Jiangshan * and create a new one if they don't match. If the target cpumask 4111042f7df1SLai Jiangshan * equals the default pwq's, the default pwq should be used. 41124c16bd32STejun Heo */ 4113042f7df1SLai Jiangshan if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) { 41144c16bd32STejun Heo if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask)) 4115f7142ed4SLai Jiangshan return; 41164c16bd32STejun Heo } else { 41174c16bd32STejun Heo goto use_dfl_pwq; 41184c16bd32STejun Heo } 41194c16bd32STejun Heo 41204c16bd32STejun Heo /* create a new pwq */ 41214c16bd32STejun Heo pwq = alloc_unbound_pwq(wq, target_attrs); 41224c16bd32STejun Heo if (!pwq) { 41232d916033SFabian Frederick pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n", 41244c16bd32STejun Heo wq->name); 412577f300b1SDaeseok Youn goto use_dfl_pwq; 41264c16bd32STejun Heo } 41274c16bd32STejun Heo 4128f7142ed4SLai Jiangshan /* Install the new pwq. */ 41294c16bd32STejun Heo mutex_lock(&wq->mutex); 41304c16bd32STejun Heo old_pwq = numa_pwq_tbl_install(wq, node, pwq); 41314c16bd32STejun Heo goto out_unlock; 41324c16bd32STejun Heo 41334c16bd32STejun Heo use_dfl_pwq: 4134f7142ed4SLai Jiangshan mutex_lock(&wq->mutex); 41354c16bd32STejun Heo spin_lock_irq(&wq->dfl_pwq->pool->lock); 41364c16bd32STejun Heo get_pwq(wq->dfl_pwq); 41374c16bd32STejun Heo spin_unlock_irq(&wq->dfl_pwq->pool->lock); 41384c16bd32STejun Heo old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq); 41394c16bd32STejun Heo out_unlock: 41404c16bd32STejun Heo mutex_unlock(&wq->mutex); 41414c16bd32STejun Heo put_pwq_unlocked(old_pwq); 41424c16bd32STejun Heo } 41434c16bd32STejun Heo 414430cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 41451da177e4SLinus Torvalds { 414649e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 41478a2b7538STejun Heo int cpu, ret; 4148e1d8aa9fSFrederic Weisbecker 414930cdf249STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 4150420c0ddbSTejun Heo wq->cpu_pwqs = alloc_percpu(struct pool_workqueue); 4151420c0ddbSTejun Heo if (!wq->cpu_pwqs) 415230cdf249STejun Heo return -ENOMEM; 415330cdf249STejun Heo 415430cdf249STejun Heo for_each_possible_cpu(cpu) { 41557fb98ea7STejun Heo struct pool_workqueue *pwq = 41567fb98ea7STejun Heo per_cpu_ptr(wq->cpu_pwqs, cpu); 41577a62c2c8STejun Heo struct worker_pool *cpu_pools = 4158f02ae73aSTejun Heo per_cpu(cpu_worker_pools, cpu); 415930cdf249STejun Heo 4160f147f29eSTejun Heo init_pwq(pwq, wq, &cpu_pools[highpri]); 4161f147f29eSTejun Heo 4162f147f29eSTejun Heo mutex_lock(&wq->mutex); 41631befcf30STejun Heo link_pwq(pwq); 4164f147f29eSTejun Heo mutex_unlock(&wq->mutex); 416530cdf249STejun Heo } 416630cdf249STejun Heo return 0; 4167509b3204SDaniel Jordan } 4168509b3204SDaniel Jordan 4169509b3204SDaniel Jordan get_online_cpus(); 4170509b3204SDaniel Jordan if (wq->flags & __WQ_ORDERED) { 41718a2b7538STejun Heo ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]); 41728a2b7538STejun Heo /* there should only be single pwq for ordering guarantee */ 41738a2b7538STejun Heo WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node || 41748a2b7538STejun Heo wq->pwqs.prev != &wq->dfl_pwq->pwqs_node), 41758a2b7538STejun Heo "ordering guarantee broken for workqueue %s\n", wq->name); 41769e8cd2f5STejun Heo } else { 4177509b3204SDaniel Jordan ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); 41789e8cd2f5STejun Heo } 4179509b3204SDaniel Jordan put_online_cpus(); 4180509b3204SDaniel Jordan 4181509b3204SDaniel Jordan return ret; 41820f900049STejun Heo } 41830f900049STejun Heo 4184f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 4185f3421797STejun Heo const char *name) 4186b71ab8c2STejun Heo { 4187f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 4188f3421797STejun Heo 4189f3421797STejun Heo if (max_active < 1 || max_active > lim) 4190044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 4191f3421797STejun Heo max_active, name, 1, lim); 4192b71ab8c2STejun Heo 4193f3421797STejun Heo return clamp_val(max_active, 1, lim); 4194b71ab8c2STejun Heo } 4195b71ab8c2STejun Heo 4196983c7515STejun Heo /* 4197983c7515STejun Heo * Workqueues which may be used during memory reclaim should have a rescuer 4198983c7515STejun Heo * to guarantee forward progress. 4199983c7515STejun Heo */ 4200983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq) 4201983c7515STejun Heo { 4202983c7515STejun Heo struct worker *rescuer; 4203983c7515STejun Heo int ret; 4204983c7515STejun Heo 4205983c7515STejun Heo if (!(wq->flags & WQ_MEM_RECLAIM)) 4206983c7515STejun Heo return 0; 4207983c7515STejun Heo 4208983c7515STejun Heo rescuer = alloc_worker(NUMA_NO_NODE); 4209983c7515STejun Heo if (!rescuer) 4210983c7515STejun Heo return -ENOMEM; 4211983c7515STejun Heo 4212983c7515STejun Heo rescuer->rescue_wq = wq; 4213983c7515STejun Heo rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name); 4214983c7515STejun Heo ret = PTR_ERR_OR_ZERO(rescuer->task); 4215983c7515STejun Heo if (ret) { 4216983c7515STejun Heo kfree(rescuer); 4217983c7515STejun Heo return ret; 4218983c7515STejun Heo } 4219983c7515STejun Heo 4220983c7515STejun Heo wq->rescuer = rescuer; 4221983c7515STejun Heo kthread_bind_mask(rescuer->task, cpu_possible_mask); 4222983c7515STejun Heo wake_up_process(rescuer->task); 4223983c7515STejun Heo 4224983c7515STejun Heo return 0; 4225983c7515STejun Heo } 4226983c7515STejun Heo 4227a2775bbcSMathieu Malaterre __printf(1, 4) 4228669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt, 422997e37d7bSTejun Heo unsigned int flags, 4230669de8bdSBart Van Assche int max_active, ...) 42313af24433SOleg Nesterov { 4232df2d5ae4STejun Heo size_t tbl_size = 0; 4233ecf6881fSTejun Heo va_list args; 42343af24433SOleg Nesterov struct workqueue_struct *wq; 423549e3cf44STejun Heo struct pool_workqueue *pwq; 4236b196be89STejun Heo 42375c0338c6STejun Heo /* 42385c0338c6STejun Heo * Unbound && max_active == 1 used to imply ordered, which is no 42395c0338c6STejun Heo * longer the case on NUMA machines due to per-node pools. While 42405c0338c6STejun Heo * alloc_ordered_workqueue() is the right way to create an ordered 42415c0338c6STejun Heo * workqueue, keep the previous behavior to avoid subtle breakages 42425c0338c6STejun Heo * on NUMA. 42435c0338c6STejun Heo */ 42445c0338c6STejun Heo if ((flags & WQ_UNBOUND) && max_active == 1) 42455c0338c6STejun Heo flags |= __WQ_ORDERED; 42465c0338c6STejun Heo 4247cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 4248cee22a15SViresh Kumar if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) 4249cee22a15SViresh Kumar flags |= WQ_UNBOUND; 4250cee22a15SViresh Kumar 4251ecf6881fSTejun Heo /* allocate wq and format name */ 4252df2d5ae4STejun Heo if (flags & WQ_UNBOUND) 4253ddcb57e2SLai Jiangshan tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]); 4254df2d5ae4STejun Heo 4255df2d5ae4STejun Heo wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL); 4256b196be89STejun Heo if (!wq) 4257d2c1d404STejun Heo return NULL; 4258b196be89STejun Heo 42596029a918STejun Heo if (flags & WQ_UNBOUND) { 4260be69d00dSThomas Gleixner wq->unbound_attrs = alloc_workqueue_attrs(); 42616029a918STejun Heo if (!wq->unbound_attrs) 42626029a918STejun Heo goto err_free_wq; 42636029a918STejun Heo } 42646029a918STejun Heo 4265669de8bdSBart Van Assche va_start(args, max_active); 4266ecf6881fSTejun Heo vsnprintf(wq->name, sizeof(wq->name), fmt, args); 4267b196be89STejun Heo va_end(args); 42683af24433SOleg Nesterov 4269d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 4270b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 42713af24433SOleg Nesterov 4272b196be89STejun Heo /* init wq */ 427397e37d7bSTejun Heo wq->flags = flags; 4274a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 42753c25a55dSLai Jiangshan mutex_init(&wq->mutex); 4276112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 427730cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 427873f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 427973f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 4280493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 42813af24433SOleg Nesterov 4282669de8bdSBart Van Assche wq_init_lockdep(wq); 4283cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 42843af24433SOleg Nesterov 428530cdf249STejun Heo if (alloc_and_link_pwqs(wq) < 0) 428682efcab3SBart Van Assche goto err_unreg_lockdep; 42871537663fSTejun Heo 428840c17f75STejun Heo if (wq_online && init_rescuer(wq) < 0) 4289d2c1d404STejun Heo goto err_destroy; 4290e22bee78STejun Heo 4291226223abSTejun Heo if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 4292226223abSTejun Heo goto err_destroy; 4293226223abSTejun Heo 42946af8bf3dSOleg Nesterov /* 429568e13a67SLai Jiangshan * wq_pool_mutex protects global freeze state and workqueues list. 429668e13a67SLai Jiangshan * Grab it, adjust max_active and add the new @wq to workqueues 429768e13a67SLai Jiangshan * list. 42986af8bf3dSOleg Nesterov */ 429968e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4300a0a1a5fdSTejun Heo 4301a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 430249e3cf44STejun Heo for_each_pwq(pwq, wq) 4303699ce097STejun Heo pwq_adjust_max_active(pwq); 4304a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4305a0a1a5fdSTejun Heo 4306e2dca7adSTejun Heo list_add_tail_rcu(&wq->list, &workqueues); 4307a0a1a5fdSTejun Heo 430868e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 43093af24433SOleg Nesterov 43103af24433SOleg Nesterov return wq; 4311d2c1d404STejun Heo 431282efcab3SBart Van Assche err_unreg_lockdep: 4313009bb421SBart Van Assche wq_unregister_lockdep(wq); 4314009bb421SBart Van Assche wq_free_lockdep(wq); 431582efcab3SBart Van Assche err_free_wq: 43166029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 43174690c4abSTejun Heo kfree(wq); 4318d2c1d404STejun Heo return NULL; 4319d2c1d404STejun Heo err_destroy: 4320d2c1d404STejun Heo destroy_workqueue(wq); 43214690c4abSTejun Heo return NULL; 43221da177e4SLinus Torvalds } 4323669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue); 43241da177e4SLinus Torvalds 4325c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq) 4326c29eb853STejun Heo { 4327c29eb853STejun Heo int i; 4328c29eb853STejun Heo 4329c29eb853STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 4330c29eb853STejun Heo if (pwq->nr_in_flight[i]) 4331c29eb853STejun Heo return true; 4332c29eb853STejun Heo 4333c29eb853STejun Heo if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1)) 4334c29eb853STejun Heo return true; 4335c29eb853STejun Heo if (pwq->nr_active || !list_empty(&pwq->delayed_works)) 4336c29eb853STejun Heo return true; 4337c29eb853STejun Heo 4338c29eb853STejun Heo return false; 4339c29eb853STejun Heo } 4340c29eb853STejun Heo 43413af24433SOleg Nesterov /** 43423af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 43433af24433SOleg Nesterov * @wq: target workqueue 43443af24433SOleg Nesterov * 43453af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 43463af24433SOleg Nesterov */ 43473af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 43483af24433SOleg Nesterov { 434949e3cf44STejun Heo struct pool_workqueue *pwq; 43504c16bd32STejun Heo int node; 43513af24433SOleg Nesterov 4352def98c84STejun Heo /* 4353def98c84STejun Heo * Remove it from sysfs first so that sanity check failure doesn't 4354def98c84STejun Heo * lead to sysfs name conflicts. 4355def98c84STejun Heo */ 4356def98c84STejun Heo workqueue_sysfs_unregister(wq); 4357def98c84STejun Heo 43589c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 43599c5a2ba7STejun Heo drain_workqueue(wq); 4360c8efcc25STejun Heo 4361def98c84STejun Heo /* kill rescuer, if sanity checks fail, leave it w/o rescuer */ 4362def98c84STejun Heo if (wq->rescuer) { 4363def98c84STejun Heo struct worker *rescuer = wq->rescuer; 4364def98c84STejun Heo 4365def98c84STejun Heo /* this prevents new queueing */ 4366def98c84STejun Heo spin_lock_irq(&wq_mayday_lock); 4367def98c84STejun Heo wq->rescuer = NULL; 4368def98c84STejun Heo spin_unlock_irq(&wq_mayday_lock); 4369def98c84STejun Heo 4370def98c84STejun Heo /* rescuer will empty maydays list before exiting */ 4371def98c84STejun Heo kthread_stop(rescuer->task); 43728efe1223STejun Heo kfree(rescuer); 4373def98c84STejun Heo } 4374def98c84STejun Heo 4375c29eb853STejun Heo /* 4376c29eb853STejun Heo * Sanity checks - grab all the locks so that we wait for all 4377c29eb853STejun Heo * in-flight operations which may do put_pwq(). 4378c29eb853STejun Heo */ 4379c29eb853STejun Heo mutex_lock(&wq_pool_mutex); 4380b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 438149e3cf44STejun Heo for_each_pwq(pwq, wq) { 4382c29eb853STejun Heo spin_lock_irq(&pwq->pool->lock); 4383c29eb853STejun Heo if (WARN_ON(pwq_busy(pwq))) { 4384e66b39afSTejun Heo pr_warning("%s: %s has the following busy pwq\n", 4385e66b39afSTejun Heo __func__, wq->name); 4386c29eb853STejun Heo show_pwq(pwq); 4387c29eb853STejun Heo spin_unlock_irq(&pwq->pool->lock); 4388b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 4389c29eb853STejun Heo mutex_unlock(&wq_pool_mutex); 4390fa07fb6aSTejun Heo show_workqueue_state(); 43916183c009STejun Heo return; 439276af4d93STejun Heo } 4393c29eb853STejun Heo spin_unlock_irq(&pwq->pool->lock); 439476af4d93STejun Heo } 4395b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 4396c29eb853STejun Heo mutex_unlock(&wq_pool_mutex); 43976183c009STejun Heo 4398a0a1a5fdSTejun Heo /* 4399a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 4400a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 4401a0a1a5fdSTejun Heo */ 440268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4403e2dca7adSTejun Heo list_del_rcu(&wq->list); 440468e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 44053af24433SOleg Nesterov 44068864b4e5STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 4407669de8bdSBart Van Assche wq_unregister_lockdep(wq); 440829c91e99STejun Heo /* 44098864b4e5STejun Heo * The base ref is never dropped on per-cpu pwqs. Directly 4410e2dca7adSTejun Heo * schedule RCU free. 441129c91e99STejun Heo */ 441225b00775SPaul E. McKenney call_rcu(&wq->rcu, rcu_free_wq); 44138864b4e5STejun Heo } else { 44148864b4e5STejun Heo /* 44158864b4e5STejun Heo * We're the sole accessor of @wq at this point. Directly 44164c16bd32STejun Heo * access numa_pwq_tbl[] and dfl_pwq to put the base refs. 44174c16bd32STejun Heo * @wq will be freed when the last pwq is released. 44188864b4e5STejun Heo */ 44194c16bd32STejun Heo for_each_node(node) { 44204c16bd32STejun Heo pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); 44214c16bd32STejun Heo RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL); 44224c16bd32STejun Heo put_pwq_unlocked(pwq); 44234c16bd32STejun Heo } 44244c16bd32STejun Heo 44254c16bd32STejun Heo /* 44264c16bd32STejun Heo * Put dfl_pwq. @wq may be freed any time after dfl_pwq is 44274c16bd32STejun Heo * put. Don't access it afterwards. 44284c16bd32STejun Heo */ 44294c16bd32STejun Heo pwq = wq->dfl_pwq; 44304c16bd32STejun Heo wq->dfl_pwq = NULL; 4431dce90d47STejun Heo put_pwq_unlocked(pwq); 443229c91e99STejun Heo } 44333af24433SOleg Nesterov } 44343af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 44353af24433SOleg Nesterov 4436dcd989cbSTejun Heo /** 4437dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 4438dcd989cbSTejun Heo * @wq: target workqueue 4439dcd989cbSTejun Heo * @max_active: new max_active value. 4440dcd989cbSTejun Heo * 4441dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 4442dcd989cbSTejun Heo * 4443dcd989cbSTejun Heo * CONTEXT: 4444dcd989cbSTejun Heo * Don't call from IRQ context. 4445dcd989cbSTejun Heo */ 4446dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 4447dcd989cbSTejun Heo { 444849e3cf44STejun Heo struct pool_workqueue *pwq; 4449dcd989cbSTejun Heo 44508719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 44510a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 44528719dceaSTejun Heo return; 44538719dceaSTejun Heo 4454f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 4455dcd989cbSTejun Heo 4456a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4457dcd989cbSTejun Heo 44580a94efb5STejun Heo wq->flags &= ~__WQ_ORDERED; 4459dcd989cbSTejun Heo wq->saved_max_active = max_active; 4460dcd989cbSTejun Heo 4461699ce097STejun Heo for_each_pwq(pwq, wq) 4462699ce097STejun Heo pwq_adjust_max_active(pwq); 4463dcd989cbSTejun Heo 4464a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4465dcd989cbSTejun Heo } 4466dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 4467dcd989cbSTejun Heo 4468dcd989cbSTejun Heo /** 446927d4ee03SLukas Wunner * current_work - retrieve %current task's work struct 447027d4ee03SLukas Wunner * 447127d4ee03SLukas Wunner * Determine if %current task is a workqueue worker and what it's working on. 447227d4ee03SLukas Wunner * Useful to find out the context that the %current task is running in. 447327d4ee03SLukas Wunner * 447427d4ee03SLukas Wunner * Return: work struct if %current task is a workqueue worker, %NULL otherwise. 447527d4ee03SLukas Wunner */ 447627d4ee03SLukas Wunner struct work_struct *current_work(void) 447727d4ee03SLukas Wunner { 447827d4ee03SLukas Wunner struct worker *worker = current_wq_worker(); 447927d4ee03SLukas Wunner 448027d4ee03SLukas Wunner return worker ? worker->current_work : NULL; 448127d4ee03SLukas Wunner } 448227d4ee03SLukas Wunner EXPORT_SYMBOL(current_work); 448327d4ee03SLukas Wunner 448427d4ee03SLukas Wunner /** 4485e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 4486e6267616STejun Heo * 4487e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 4488e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 4489d185af30SYacine Belkadi * 4490d185af30SYacine Belkadi * Return: %true if %current is a workqueue rescuer. %false otherwise. 4491e6267616STejun Heo */ 4492e6267616STejun Heo bool current_is_workqueue_rescuer(void) 4493e6267616STejun Heo { 4494e6267616STejun Heo struct worker *worker = current_wq_worker(); 4495e6267616STejun Heo 44966a092dfdSLai Jiangshan return worker && worker->rescue_wq; 4497e6267616STejun Heo } 4498e6267616STejun Heo 4499e6267616STejun Heo /** 4500dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 4501dcd989cbSTejun Heo * @cpu: CPU in question 4502dcd989cbSTejun Heo * @wq: target workqueue 4503dcd989cbSTejun Heo * 4504dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 4505dcd989cbSTejun Heo * no synchronization around this function and the test result is 4506dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4507dcd989cbSTejun Heo * 4508d3251859STejun Heo * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. 4509d3251859STejun Heo * Note that both per-cpu and unbound workqueues may be associated with 4510d3251859STejun Heo * multiple pool_workqueues which have separate congested states. A 4511d3251859STejun Heo * workqueue being congested on one CPU doesn't mean the workqueue is also 4512d3251859STejun Heo * contested on other CPUs / NUMA nodes. 4513d3251859STejun Heo * 4514d185af30SYacine Belkadi * Return: 4515dcd989cbSTejun Heo * %true if congested, %false otherwise. 4516dcd989cbSTejun Heo */ 4517d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 4518dcd989cbSTejun Heo { 45197fb98ea7STejun Heo struct pool_workqueue *pwq; 452076af4d93STejun Heo bool ret; 452176af4d93STejun Heo 452224acfb71SThomas Gleixner rcu_read_lock(); 452324acfb71SThomas Gleixner preempt_disable(); 45247fb98ea7STejun Heo 4525d3251859STejun Heo if (cpu == WORK_CPU_UNBOUND) 4526d3251859STejun Heo cpu = smp_processor_id(); 4527d3251859STejun Heo 45287fb98ea7STejun Heo if (!(wq->flags & WQ_UNBOUND)) 45297fb98ea7STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 45307fb98ea7STejun Heo else 4531df2d5ae4STejun Heo pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); 4532dcd989cbSTejun Heo 453376af4d93STejun Heo ret = !list_empty(&pwq->delayed_works); 453424acfb71SThomas Gleixner preempt_enable(); 453524acfb71SThomas Gleixner rcu_read_unlock(); 453676af4d93STejun Heo 453776af4d93STejun Heo return ret; 4538dcd989cbSTejun Heo } 4539dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 4540dcd989cbSTejun Heo 4541dcd989cbSTejun Heo /** 4542dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 4543dcd989cbSTejun Heo * @work: the work to be tested 4544dcd989cbSTejun Heo * 4545dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 4546dcd989cbSTejun Heo * synchronization around this function and the test result is 4547dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4548dcd989cbSTejun Heo * 4549d185af30SYacine Belkadi * Return: 4550dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 4551dcd989cbSTejun Heo */ 4552dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 4553dcd989cbSTejun Heo { 4554fa1b54e6STejun Heo struct worker_pool *pool; 4555dcd989cbSTejun Heo unsigned long flags; 4556dcd989cbSTejun Heo unsigned int ret = 0; 4557dcd989cbSTejun Heo 4558dcd989cbSTejun Heo if (work_pending(work)) 4559dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 4560038366c5SLai Jiangshan 456124acfb71SThomas Gleixner rcu_read_lock(); 4562fa1b54e6STejun Heo pool = get_work_pool(work); 4563038366c5SLai Jiangshan if (pool) { 456424acfb71SThomas Gleixner spin_lock_irqsave(&pool->lock, flags); 4565c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 4566dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 456724acfb71SThomas Gleixner spin_unlock_irqrestore(&pool->lock, flags); 4568038366c5SLai Jiangshan } 456924acfb71SThomas Gleixner rcu_read_unlock(); 4570dcd989cbSTejun Heo 4571dcd989cbSTejun Heo return ret; 4572dcd989cbSTejun Heo } 4573dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 4574dcd989cbSTejun Heo 45753d1cb205STejun Heo /** 45763d1cb205STejun Heo * set_worker_desc - set description for the current work item 45773d1cb205STejun Heo * @fmt: printf-style format string 45783d1cb205STejun Heo * @...: arguments for the format string 45793d1cb205STejun Heo * 45803d1cb205STejun Heo * This function can be called by a running work function to describe what 45813d1cb205STejun Heo * the work item is about. If the worker task gets dumped, this 45823d1cb205STejun Heo * information will be printed out together to help debugging. The 45833d1cb205STejun Heo * description can be at most WORKER_DESC_LEN including the trailing '\0'. 45843d1cb205STejun Heo */ 45853d1cb205STejun Heo void set_worker_desc(const char *fmt, ...) 45863d1cb205STejun Heo { 45873d1cb205STejun Heo struct worker *worker = current_wq_worker(); 45883d1cb205STejun Heo va_list args; 45893d1cb205STejun Heo 45903d1cb205STejun Heo if (worker) { 45913d1cb205STejun Heo va_start(args, fmt); 45923d1cb205STejun Heo vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); 45933d1cb205STejun Heo va_end(args); 45943d1cb205STejun Heo } 45953d1cb205STejun Heo } 45965c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc); 45973d1cb205STejun Heo 45983d1cb205STejun Heo /** 45993d1cb205STejun Heo * print_worker_info - print out worker information and description 46003d1cb205STejun Heo * @log_lvl: the log level to use when printing 46013d1cb205STejun Heo * @task: target task 46023d1cb205STejun Heo * 46033d1cb205STejun Heo * If @task is a worker and currently executing a work item, print out the 46043d1cb205STejun Heo * name of the workqueue being serviced and worker description set with 46053d1cb205STejun Heo * set_worker_desc() by the currently executing work item. 46063d1cb205STejun Heo * 46073d1cb205STejun Heo * This function can be safely called on any task as long as the 46083d1cb205STejun Heo * task_struct itself is accessible. While safe, this function isn't 46093d1cb205STejun Heo * synchronized and may print out mixups or garbages of limited length. 46103d1cb205STejun Heo */ 46113d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task) 46123d1cb205STejun Heo { 46133d1cb205STejun Heo work_func_t *fn = NULL; 46143d1cb205STejun Heo char name[WQ_NAME_LEN] = { }; 46153d1cb205STejun Heo char desc[WORKER_DESC_LEN] = { }; 46163d1cb205STejun Heo struct pool_workqueue *pwq = NULL; 46173d1cb205STejun Heo struct workqueue_struct *wq = NULL; 46183d1cb205STejun Heo struct worker *worker; 46193d1cb205STejun Heo 46203d1cb205STejun Heo if (!(task->flags & PF_WQ_WORKER)) 46213d1cb205STejun Heo return; 46223d1cb205STejun Heo 46233d1cb205STejun Heo /* 46243d1cb205STejun Heo * This function is called without any synchronization and @task 46253d1cb205STejun Heo * could be in any state. Be careful with dereferences. 46263d1cb205STejun Heo */ 4627e700591aSPetr Mladek worker = kthread_probe_data(task); 46283d1cb205STejun Heo 46293d1cb205STejun Heo /* 46308bf89593STejun Heo * Carefully copy the associated workqueue's workfn, name and desc. 46318bf89593STejun Heo * Keep the original last '\0' in case the original is garbage. 46323d1cb205STejun Heo */ 46333d1cb205STejun Heo probe_kernel_read(&fn, &worker->current_func, sizeof(fn)); 46343d1cb205STejun Heo probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq)); 46353d1cb205STejun Heo probe_kernel_read(&wq, &pwq->wq, sizeof(wq)); 46363d1cb205STejun Heo probe_kernel_read(name, wq->name, sizeof(name) - 1); 46373d1cb205STejun Heo probe_kernel_read(desc, worker->desc, sizeof(desc) - 1); 46383d1cb205STejun Heo 46393d1cb205STejun Heo if (fn || name[0] || desc[0]) { 4640d75f773cSSakari Ailus printk("%sWorkqueue: %s %ps", log_lvl, name, fn); 46418bf89593STejun Heo if (strcmp(name, desc)) 46423d1cb205STejun Heo pr_cont(" (%s)", desc); 46433d1cb205STejun Heo pr_cont("\n"); 46443d1cb205STejun Heo } 46453d1cb205STejun Heo } 46463d1cb205STejun Heo 46473494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool) 46483494fc30STejun Heo { 46493494fc30STejun Heo pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask); 46503494fc30STejun Heo if (pool->node != NUMA_NO_NODE) 46513494fc30STejun Heo pr_cont(" node=%d", pool->node); 46523494fc30STejun Heo pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice); 46533494fc30STejun Heo } 46543494fc30STejun Heo 46553494fc30STejun Heo static void pr_cont_work(bool comma, struct work_struct *work) 46563494fc30STejun Heo { 46573494fc30STejun Heo if (work->func == wq_barrier_func) { 46583494fc30STejun Heo struct wq_barrier *barr; 46593494fc30STejun Heo 46603494fc30STejun Heo barr = container_of(work, struct wq_barrier, work); 46613494fc30STejun Heo 46623494fc30STejun Heo pr_cont("%s BAR(%d)", comma ? "," : "", 46633494fc30STejun Heo task_pid_nr(barr->task)); 46643494fc30STejun Heo } else { 4665d75f773cSSakari Ailus pr_cont("%s %ps", comma ? "," : "", work->func); 46663494fc30STejun Heo } 46673494fc30STejun Heo } 46683494fc30STejun Heo 46693494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq) 46703494fc30STejun Heo { 46713494fc30STejun Heo struct worker_pool *pool = pwq->pool; 46723494fc30STejun Heo struct work_struct *work; 46733494fc30STejun Heo struct worker *worker; 46743494fc30STejun Heo bool has_in_flight = false, has_pending = false; 46753494fc30STejun Heo int bkt; 46763494fc30STejun Heo 46773494fc30STejun Heo pr_info(" pwq %d:", pool->id); 46783494fc30STejun Heo pr_cont_pool_info(pool); 46793494fc30STejun Heo 4680e66b39afSTejun Heo pr_cont(" active=%d/%d refcnt=%d%s\n", 4681e66b39afSTejun Heo pwq->nr_active, pwq->max_active, pwq->refcnt, 46823494fc30STejun Heo !list_empty(&pwq->mayday_node) ? " MAYDAY" : ""); 46833494fc30STejun Heo 46843494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 46853494fc30STejun Heo if (worker->current_pwq == pwq) { 46863494fc30STejun Heo has_in_flight = true; 46873494fc30STejun Heo break; 46883494fc30STejun Heo } 46893494fc30STejun Heo } 46903494fc30STejun Heo if (has_in_flight) { 46913494fc30STejun Heo bool comma = false; 46923494fc30STejun Heo 46933494fc30STejun Heo pr_info(" in-flight:"); 46943494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 46953494fc30STejun Heo if (worker->current_pwq != pwq) 46963494fc30STejun Heo continue; 46973494fc30STejun Heo 4698d75f773cSSakari Ailus pr_cont("%s %d%s:%ps", comma ? "," : "", 46993494fc30STejun Heo task_pid_nr(worker->task), 470030ae2fc0STejun Heo worker->rescue_wq ? "(RESCUER)" : "", 47013494fc30STejun Heo worker->current_func); 47023494fc30STejun Heo list_for_each_entry(work, &worker->scheduled, entry) 47033494fc30STejun Heo pr_cont_work(false, work); 47043494fc30STejun Heo comma = true; 47053494fc30STejun Heo } 47063494fc30STejun Heo pr_cont("\n"); 47073494fc30STejun Heo } 47083494fc30STejun Heo 47093494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 47103494fc30STejun Heo if (get_work_pwq(work) == pwq) { 47113494fc30STejun Heo has_pending = true; 47123494fc30STejun Heo break; 47133494fc30STejun Heo } 47143494fc30STejun Heo } 47153494fc30STejun Heo if (has_pending) { 47163494fc30STejun Heo bool comma = false; 47173494fc30STejun Heo 47183494fc30STejun Heo pr_info(" pending:"); 47193494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 47203494fc30STejun Heo if (get_work_pwq(work) != pwq) 47213494fc30STejun Heo continue; 47223494fc30STejun Heo 47233494fc30STejun Heo pr_cont_work(comma, work); 47243494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 47253494fc30STejun Heo } 47263494fc30STejun Heo pr_cont("\n"); 47273494fc30STejun Heo } 47283494fc30STejun Heo 47293494fc30STejun Heo if (!list_empty(&pwq->delayed_works)) { 47303494fc30STejun Heo bool comma = false; 47313494fc30STejun Heo 47323494fc30STejun Heo pr_info(" delayed:"); 47333494fc30STejun Heo list_for_each_entry(work, &pwq->delayed_works, entry) { 47343494fc30STejun Heo pr_cont_work(comma, work); 47353494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 47363494fc30STejun Heo } 47373494fc30STejun Heo pr_cont("\n"); 47383494fc30STejun Heo } 47393494fc30STejun Heo } 47403494fc30STejun Heo 47413494fc30STejun Heo /** 47423494fc30STejun Heo * show_workqueue_state - dump workqueue state 47433494fc30STejun Heo * 47447b776af6SRoger Lu * Called from a sysrq handler or try_to_freeze_tasks() and prints out 47457b776af6SRoger Lu * all busy workqueues and pools. 47463494fc30STejun Heo */ 47473494fc30STejun Heo void show_workqueue_state(void) 47483494fc30STejun Heo { 47493494fc30STejun Heo struct workqueue_struct *wq; 47503494fc30STejun Heo struct worker_pool *pool; 47513494fc30STejun Heo unsigned long flags; 47523494fc30STejun Heo int pi; 47533494fc30STejun Heo 475424acfb71SThomas Gleixner rcu_read_lock(); 47553494fc30STejun Heo 47563494fc30STejun Heo pr_info("Showing busy workqueues and worker pools:\n"); 47573494fc30STejun Heo 47583494fc30STejun Heo list_for_each_entry_rcu(wq, &workqueues, list) { 47593494fc30STejun Heo struct pool_workqueue *pwq; 47603494fc30STejun Heo bool idle = true; 47613494fc30STejun Heo 47623494fc30STejun Heo for_each_pwq(pwq, wq) { 47633494fc30STejun Heo if (pwq->nr_active || !list_empty(&pwq->delayed_works)) { 47643494fc30STejun Heo idle = false; 47653494fc30STejun Heo break; 47663494fc30STejun Heo } 47673494fc30STejun Heo } 47683494fc30STejun Heo if (idle) 47693494fc30STejun Heo continue; 47703494fc30STejun Heo 47713494fc30STejun Heo pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags); 47723494fc30STejun Heo 47733494fc30STejun Heo for_each_pwq(pwq, wq) { 47743494fc30STejun Heo spin_lock_irqsave(&pwq->pool->lock, flags); 47753494fc30STejun Heo if (pwq->nr_active || !list_empty(&pwq->delayed_works)) 47763494fc30STejun Heo show_pwq(pwq); 47773494fc30STejun Heo spin_unlock_irqrestore(&pwq->pool->lock, flags); 477862635ea8SSergey Senozhatsky /* 477962635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 478062635ea8SSergey Senozhatsky * sysrq-t -> show_workqueue_state(). Avoid triggering 478162635ea8SSergey Senozhatsky * hard lockup. 478262635ea8SSergey Senozhatsky */ 478362635ea8SSergey Senozhatsky touch_nmi_watchdog(); 47843494fc30STejun Heo } 47853494fc30STejun Heo } 47863494fc30STejun Heo 47873494fc30STejun Heo for_each_pool(pool, pi) { 47883494fc30STejun Heo struct worker *worker; 47893494fc30STejun Heo bool first = true; 47903494fc30STejun Heo 47913494fc30STejun Heo spin_lock_irqsave(&pool->lock, flags); 47923494fc30STejun Heo if (pool->nr_workers == pool->nr_idle) 47933494fc30STejun Heo goto next_pool; 47943494fc30STejun Heo 47953494fc30STejun Heo pr_info("pool %d:", pool->id); 47963494fc30STejun Heo pr_cont_pool_info(pool); 479782607adcSTejun Heo pr_cont(" hung=%us workers=%d", 479882607adcSTejun Heo jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000, 479982607adcSTejun Heo pool->nr_workers); 48003494fc30STejun Heo if (pool->manager) 48013494fc30STejun Heo pr_cont(" manager: %d", 48023494fc30STejun Heo task_pid_nr(pool->manager->task)); 48033494fc30STejun Heo list_for_each_entry(worker, &pool->idle_list, entry) { 48043494fc30STejun Heo pr_cont(" %s%d", first ? "idle: " : "", 48053494fc30STejun Heo task_pid_nr(worker->task)); 48063494fc30STejun Heo first = false; 48073494fc30STejun Heo } 48083494fc30STejun Heo pr_cont("\n"); 48093494fc30STejun Heo next_pool: 48103494fc30STejun Heo spin_unlock_irqrestore(&pool->lock, flags); 481162635ea8SSergey Senozhatsky /* 481262635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 481362635ea8SSergey Senozhatsky * sysrq-t -> show_workqueue_state(). Avoid triggering 481462635ea8SSergey Senozhatsky * hard lockup. 481562635ea8SSergey Senozhatsky */ 481662635ea8SSergey Senozhatsky touch_nmi_watchdog(); 48173494fc30STejun Heo } 48183494fc30STejun Heo 481924acfb71SThomas Gleixner rcu_read_unlock(); 48203494fc30STejun Heo } 48213494fc30STejun Heo 48226b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */ 48236b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task) 48246b59808bSTejun Heo { 48256b59808bSTejun Heo int off; 48266b59808bSTejun Heo 48276b59808bSTejun Heo /* always show the actual comm */ 48286b59808bSTejun Heo off = strscpy(buf, task->comm, size); 48296b59808bSTejun Heo if (off < 0) 48306b59808bSTejun Heo return; 48316b59808bSTejun Heo 4832197f6accSTejun Heo /* stabilize PF_WQ_WORKER and worker pool association */ 48336b59808bSTejun Heo mutex_lock(&wq_pool_attach_mutex); 48346b59808bSTejun Heo 4835197f6accSTejun Heo if (task->flags & PF_WQ_WORKER) { 4836197f6accSTejun Heo struct worker *worker = kthread_data(task); 4837197f6accSTejun Heo struct worker_pool *pool = worker->pool; 48386b59808bSTejun Heo 48396b59808bSTejun Heo if (pool) { 48406b59808bSTejun Heo spin_lock_irq(&pool->lock); 48416b59808bSTejun Heo /* 4842197f6accSTejun Heo * ->desc tracks information (wq name or 4843197f6accSTejun Heo * set_worker_desc()) for the latest execution. If 4844197f6accSTejun Heo * current, prepend '+', otherwise '-'. 48456b59808bSTejun Heo */ 48466b59808bSTejun Heo if (worker->desc[0] != '\0') { 48476b59808bSTejun Heo if (worker->current_work) 48486b59808bSTejun Heo scnprintf(buf + off, size - off, "+%s", 48496b59808bSTejun Heo worker->desc); 48506b59808bSTejun Heo else 48516b59808bSTejun Heo scnprintf(buf + off, size - off, "-%s", 48526b59808bSTejun Heo worker->desc); 48536b59808bSTejun Heo } 48546b59808bSTejun Heo spin_unlock_irq(&pool->lock); 48556b59808bSTejun Heo } 4856197f6accSTejun Heo } 48576b59808bSTejun Heo 48586b59808bSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 48596b59808bSTejun Heo } 48606b59808bSTejun Heo 486166448bc2SMathieu Malaterre #ifdef CONFIG_SMP 486266448bc2SMathieu Malaterre 4863db7bccf4STejun Heo /* 4864db7bccf4STejun Heo * CPU hotplug. 4865db7bccf4STejun Heo * 4866e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 4867112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 4868706026c2STejun Heo * pool which make migrating pending and scheduled works very 4869e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 487094cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 4871e22bee78STejun Heo * blocked draining impractical. 4872e22bee78STejun Heo * 487324647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 4874628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 4875628c78e7STejun Heo * cpu comes back online. 4876db7bccf4STejun Heo */ 4877db7bccf4STejun Heo 4878e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu) 4879db7bccf4STejun Heo { 48804ce62e9eSTejun Heo struct worker_pool *pool; 4881db7bccf4STejun Heo struct worker *worker; 4882db7bccf4STejun Heo 4883f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 48841258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 488594cf58bbSTejun Heo spin_lock_irq(&pool->lock); 4886e22bee78STejun Heo 4887f2d5a0eeSTejun Heo /* 488892f9c5c4SLai Jiangshan * We've blocked all attach/detach operations. Make all workers 488994cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 489094cf58bbSTejun Heo * except for the ones which are still executing works from 489194cf58bbSTejun Heo * before the last CPU down must be on the cpu. After 489294cf58bbSTejun Heo * this, they may become diasporas. 4893f2d5a0eeSTejun Heo */ 4894da028469SLai Jiangshan for_each_pool_worker(worker, pool) 4895403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 4896db7bccf4STejun Heo 489724647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 4898f2d5a0eeSTejun Heo 489994cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 49001258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 4901e22bee78STejun Heo 4902e22bee78STejun Heo /* 4903eb283428SLai Jiangshan * Call schedule() so that we cross rq->lock and thus can 4904eb283428SLai Jiangshan * guarantee sched callbacks see the %WORKER_UNBOUND flag. 4905eb283428SLai Jiangshan * This is necessary as scheduler callbacks may be invoked 4906eb283428SLai Jiangshan * from other cpus. 4907628c78e7STejun Heo */ 4908628c78e7STejun Heo schedule(); 4909628c78e7STejun Heo 4910628c78e7STejun Heo /* 4911eb283428SLai Jiangshan * Sched callbacks are disabled now. Zap nr_running. 4912eb283428SLai Jiangshan * After this, nr_running stays zero and need_more_worker() 4913eb283428SLai Jiangshan * and keep_working() are always true as long as the 4914eb283428SLai Jiangshan * worklist is not empty. This pool now behaves as an 4915eb283428SLai Jiangshan * unbound (in terms of concurrency management) pool which 4916eb283428SLai Jiangshan * are served by workers tied to the pool. 4917e22bee78STejun Heo */ 4918e19e397aSTejun Heo atomic_set(&pool->nr_running, 0); 4919eb283428SLai Jiangshan 4920eb283428SLai Jiangshan /* 4921eb283428SLai Jiangshan * With concurrency management just turned off, a busy 4922eb283428SLai Jiangshan * worker blocking could lead to lengthy stalls. Kick off 4923eb283428SLai Jiangshan * unbound chain execution of currently pending work items. 4924eb283428SLai Jiangshan */ 4925eb283428SLai Jiangshan spin_lock_irq(&pool->lock); 4926eb283428SLai Jiangshan wake_up_worker(pool); 4927eb283428SLai Jiangshan spin_unlock_irq(&pool->lock); 4928eb283428SLai Jiangshan } 4929db7bccf4STejun Heo } 4930db7bccf4STejun Heo 4931bd7c089eSTejun Heo /** 4932bd7c089eSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 4933bd7c089eSTejun Heo * @pool: pool of interest 4934bd7c089eSTejun Heo * 4935a9ab775bSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. 4936bd7c089eSTejun Heo */ 4937bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool) 4938bd7c089eSTejun Heo { 4939a9ab775bSTejun Heo struct worker *worker; 4940bd7c089eSTejun Heo 49411258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 4942bd7c089eSTejun Heo 4943bd7c089eSTejun Heo /* 4944a9ab775bSTejun Heo * Restore CPU affinity of all workers. As all idle workers should 4945a9ab775bSTejun Heo * be on the run-queue of the associated CPU before any local 4946402dd89dSShailendra Verma * wake-ups for concurrency management happen, restore CPU affinity 4947a9ab775bSTejun Heo * of all workers first and then clear UNBOUND. As we're called 4948a9ab775bSTejun Heo * from CPU_ONLINE, the following shouldn't fail. 4949bd7c089eSTejun Heo */ 4950da028469SLai Jiangshan for_each_pool_worker(worker, pool) 4951a9ab775bSTejun Heo WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 4952a9ab775bSTejun Heo pool->attrs->cpumask) < 0); 4953a9ab775bSTejun Heo 4954a9ab775bSTejun Heo spin_lock_irq(&pool->lock); 4955f7c17d26SWanpeng Li 49563de5e884SLai Jiangshan pool->flags &= ~POOL_DISASSOCIATED; 4957a9ab775bSTejun Heo 4958da028469SLai Jiangshan for_each_pool_worker(worker, pool) { 4959a9ab775bSTejun Heo unsigned int worker_flags = worker->flags; 4960a9ab775bSTejun Heo 4961a9ab775bSTejun Heo /* 4962a9ab775bSTejun Heo * A bound idle worker should actually be on the runqueue 4963a9ab775bSTejun Heo * of the associated CPU for local wake-ups targeting it to 4964a9ab775bSTejun Heo * work. Kick all idle workers so that they migrate to the 4965a9ab775bSTejun Heo * associated CPU. Doing this in the same loop as 4966a9ab775bSTejun Heo * replacing UNBOUND with REBOUND is safe as no worker will 4967a9ab775bSTejun Heo * be bound before @pool->lock is released. 4968a9ab775bSTejun Heo */ 4969a9ab775bSTejun Heo if (worker_flags & WORKER_IDLE) 4970bd7c089eSTejun Heo wake_up_process(worker->task); 4971bd7c089eSTejun Heo 4972bd7c089eSTejun Heo /* 4973a9ab775bSTejun Heo * We want to clear UNBOUND but can't directly call 4974a9ab775bSTejun Heo * worker_clr_flags() or adjust nr_running. Atomically 4975a9ab775bSTejun Heo * replace UNBOUND with another NOT_RUNNING flag REBOUND. 4976a9ab775bSTejun Heo * @worker will clear REBOUND using worker_clr_flags() when 4977a9ab775bSTejun Heo * it initiates the next execution cycle thus restoring 4978a9ab775bSTejun Heo * concurrency management. Note that when or whether 4979a9ab775bSTejun Heo * @worker clears REBOUND doesn't affect correctness. 4980a9ab775bSTejun Heo * 4981c95491edSMark Rutland * WRITE_ONCE() is necessary because @worker->flags may be 4982a9ab775bSTejun Heo * tested without holding any lock in 49836d25be57SThomas Gleixner * wq_worker_running(). Without it, NOT_RUNNING test may 4984a9ab775bSTejun Heo * fail incorrectly leading to premature concurrency 4985a9ab775bSTejun Heo * management operations. 4986bd7c089eSTejun Heo */ 4987a9ab775bSTejun Heo WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); 4988a9ab775bSTejun Heo worker_flags |= WORKER_REBOUND; 4989a9ab775bSTejun Heo worker_flags &= ~WORKER_UNBOUND; 4990c95491edSMark Rutland WRITE_ONCE(worker->flags, worker_flags); 4991bd7c089eSTejun Heo } 4992a9ab775bSTejun Heo 4993a9ab775bSTejun Heo spin_unlock_irq(&pool->lock); 4994bd7c089eSTejun Heo } 4995bd7c089eSTejun Heo 49967dbc725eSTejun Heo /** 49977dbc725eSTejun Heo * restore_unbound_workers_cpumask - restore cpumask of unbound workers 49987dbc725eSTejun Heo * @pool: unbound pool of interest 49997dbc725eSTejun Heo * @cpu: the CPU which is coming up 50007dbc725eSTejun Heo * 50017dbc725eSTejun Heo * An unbound pool may end up with a cpumask which doesn't have any online 50027dbc725eSTejun Heo * CPUs. When a worker of such pool get scheduled, the scheduler resets 50037dbc725eSTejun Heo * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any 50047dbc725eSTejun Heo * online CPU before, cpus_allowed of all its workers should be restored. 50057dbc725eSTejun Heo */ 50067dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) 50077dbc725eSTejun Heo { 50087dbc725eSTejun Heo static cpumask_t cpumask; 50097dbc725eSTejun Heo struct worker *worker; 50107dbc725eSTejun Heo 50111258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 50127dbc725eSTejun Heo 50137dbc725eSTejun Heo /* is @cpu allowed for @pool? */ 50147dbc725eSTejun Heo if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) 50157dbc725eSTejun Heo return; 50167dbc725eSTejun Heo 50177dbc725eSTejun Heo cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); 50187dbc725eSTejun Heo 50197dbc725eSTejun Heo /* as we're called from CPU_ONLINE, the following shouldn't fail */ 5020da028469SLai Jiangshan for_each_pool_worker(worker, pool) 5021d945b5e9SPeter Zijlstra WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0); 50227dbc725eSTejun Heo } 50237dbc725eSTejun Heo 50247ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu) 50251da177e4SLinus Torvalds { 50264ce62e9eSTejun Heo struct worker_pool *pool; 50271da177e4SLinus Torvalds 5028f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 50293ce63377STejun Heo if (pool->nr_workers) 50303ce63377STejun Heo continue; 5031051e1850SLai Jiangshan if (!create_worker(pool)) 50327ee681b2SThomas Gleixner return -ENOMEM; 50333af24433SOleg Nesterov } 50347ee681b2SThomas Gleixner return 0; 50357ee681b2SThomas Gleixner } 50361da177e4SLinus Torvalds 50377ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu) 50387ee681b2SThomas Gleixner { 50397ee681b2SThomas Gleixner struct worker_pool *pool; 50407ee681b2SThomas Gleixner struct workqueue_struct *wq; 50417ee681b2SThomas Gleixner int pi; 50427ee681b2SThomas Gleixner 504368e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 50447dbc725eSTejun Heo 50457dbc725eSTejun Heo for_each_pool(pool, pi) { 50461258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 504794cf58bbSTejun Heo 5048f05b558dSLai Jiangshan if (pool->cpu == cpu) 504994cf58bbSTejun Heo rebind_workers(pool); 5050f05b558dSLai Jiangshan else if (pool->cpu < 0) 50517dbc725eSTejun Heo restore_unbound_workers_cpumask(pool, cpu); 505294cf58bbSTejun Heo 50531258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 505494cf58bbSTejun Heo } 50557dbc725eSTejun Heo 50564c16bd32STejun Heo /* update NUMA affinity of unbound workqueues */ 50574c16bd32STejun Heo list_for_each_entry(wq, &workqueues, list) 50584c16bd32STejun Heo wq_update_unbound_numa(wq, cpu, true); 50594c16bd32STejun Heo 506068e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 50617ee681b2SThomas Gleixner return 0; 506265758202STejun Heo } 506365758202STejun Heo 50647ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu) 506565758202STejun Heo { 50664c16bd32STejun Heo struct workqueue_struct *wq; 50678db25e78STejun Heo 50684c16bd32STejun Heo /* unbinding per-cpu workers should happen on the local CPU */ 5069e8b3f8dbSLai Jiangshan if (WARN_ON(cpu != smp_processor_id())) 5070e8b3f8dbSLai Jiangshan return -1; 5071e8b3f8dbSLai Jiangshan 5072e8b3f8dbSLai Jiangshan unbind_workers(cpu); 50734c16bd32STejun Heo 50744c16bd32STejun Heo /* update NUMA affinity of unbound workqueues */ 50754c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 50764c16bd32STejun Heo list_for_each_entry(wq, &workqueues, list) 50774c16bd32STejun Heo wq_update_unbound_numa(wq, cpu, false); 50784c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 50794c16bd32STejun Heo 50807ee681b2SThomas Gleixner return 0; 508165758202STejun Heo } 508265758202STejun Heo 50832d3854a3SRusty Russell struct work_for_cpu { 5084ed48ece2STejun Heo struct work_struct work; 50852d3854a3SRusty Russell long (*fn)(void *); 50862d3854a3SRusty Russell void *arg; 50872d3854a3SRusty Russell long ret; 50882d3854a3SRusty Russell }; 50892d3854a3SRusty Russell 5090ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 50912d3854a3SRusty Russell { 5092ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 5093ed48ece2STejun Heo 50942d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 50952d3854a3SRusty Russell } 50962d3854a3SRusty Russell 50972d3854a3SRusty Russell /** 509822aceb31SAnna-Maria Gleixner * work_on_cpu - run a function in thread context on a particular cpu 50992d3854a3SRusty Russell * @cpu: the cpu to run on 51002d3854a3SRusty Russell * @fn: the function to run 51012d3854a3SRusty Russell * @arg: the function arg 51022d3854a3SRusty Russell * 510331ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 51046b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 5105d185af30SYacine Belkadi * 5106d185af30SYacine Belkadi * Return: The value @fn returns. 51072d3854a3SRusty Russell */ 5108d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg) 51092d3854a3SRusty Russell { 5110ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 51112d3854a3SRusty Russell 5112ed48ece2STejun Heo INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); 5113ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 511412997d1aSBjorn Helgaas flush_work(&wfc.work); 5115440a1136SChuansheng Liu destroy_work_on_stack(&wfc.work); 51162d3854a3SRusty Russell return wfc.ret; 51172d3854a3SRusty Russell } 51182d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 51190e8d6a93SThomas Gleixner 51200e8d6a93SThomas Gleixner /** 51210e8d6a93SThomas Gleixner * work_on_cpu_safe - run a function in thread context on a particular cpu 51220e8d6a93SThomas Gleixner * @cpu: the cpu to run on 51230e8d6a93SThomas Gleixner * @fn: the function to run 51240e8d6a93SThomas Gleixner * @arg: the function argument 51250e8d6a93SThomas Gleixner * 51260e8d6a93SThomas Gleixner * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold 51270e8d6a93SThomas Gleixner * any locks which would prevent @fn from completing. 51280e8d6a93SThomas Gleixner * 51290e8d6a93SThomas Gleixner * Return: The value @fn returns. 51300e8d6a93SThomas Gleixner */ 51310e8d6a93SThomas Gleixner long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg) 51320e8d6a93SThomas Gleixner { 51330e8d6a93SThomas Gleixner long ret = -ENODEV; 51340e8d6a93SThomas Gleixner 51350e8d6a93SThomas Gleixner get_online_cpus(); 51360e8d6a93SThomas Gleixner if (cpu_online(cpu)) 51370e8d6a93SThomas Gleixner ret = work_on_cpu(cpu, fn, arg); 51380e8d6a93SThomas Gleixner put_online_cpus(); 51390e8d6a93SThomas Gleixner return ret; 51400e8d6a93SThomas Gleixner } 51410e8d6a93SThomas Gleixner EXPORT_SYMBOL_GPL(work_on_cpu_safe); 51422d3854a3SRusty Russell #endif /* CONFIG_SMP */ 51432d3854a3SRusty Russell 5144a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 5145e7577c50SRusty Russell 5146a0a1a5fdSTejun Heo /** 5147a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 5148a0a1a5fdSTejun Heo * 514958a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 5150c5aa87bbSTejun Heo * workqueues will queue new works to their delayed_works list instead of 5151706026c2STejun Heo * pool->worklist. 5152a0a1a5fdSTejun Heo * 5153a0a1a5fdSTejun Heo * CONTEXT: 5154a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 5155a0a1a5fdSTejun Heo */ 5156a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 5157a0a1a5fdSTejun Heo { 515824b8a847STejun Heo struct workqueue_struct *wq; 515924b8a847STejun Heo struct pool_workqueue *pwq; 5160a0a1a5fdSTejun Heo 516168e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5162a0a1a5fdSTejun Heo 51636183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 5164a0a1a5fdSTejun Heo workqueue_freezing = true; 5165a0a1a5fdSTejun Heo 516624b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 5167a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5168699ce097STejun Heo for_each_pwq(pwq, wq) 5169699ce097STejun Heo pwq_adjust_max_active(pwq); 5170a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5171a1056305STejun Heo } 51725bcab335STejun Heo 517368e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5174a0a1a5fdSTejun Heo } 5175a0a1a5fdSTejun Heo 5176a0a1a5fdSTejun Heo /** 517758a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 5178a0a1a5fdSTejun Heo * 5179a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 5180a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 5181a0a1a5fdSTejun Heo * 5182a0a1a5fdSTejun Heo * CONTEXT: 518368e13a67SLai Jiangshan * Grabs and releases wq_pool_mutex. 5184a0a1a5fdSTejun Heo * 5185d185af30SYacine Belkadi * Return: 518658a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 518758a69cb4STejun Heo * is complete. 5188a0a1a5fdSTejun Heo */ 5189a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 5190a0a1a5fdSTejun Heo { 5191a0a1a5fdSTejun Heo bool busy = false; 519224b8a847STejun Heo struct workqueue_struct *wq; 519324b8a847STejun Heo struct pool_workqueue *pwq; 5194a0a1a5fdSTejun Heo 519568e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5196a0a1a5fdSTejun Heo 51976183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 5198a0a1a5fdSTejun Heo 519924b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 520024b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 520124b8a847STejun Heo continue; 5202a0a1a5fdSTejun Heo /* 5203a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 5204a0a1a5fdSTejun Heo * to peek without lock. 5205a0a1a5fdSTejun Heo */ 520624acfb71SThomas Gleixner rcu_read_lock(); 520724b8a847STejun Heo for_each_pwq(pwq, wq) { 52086183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 5209112202d9STejun Heo if (pwq->nr_active) { 5210a0a1a5fdSTejun Heo busy = true; 521124acfb71SThomas Gleixner rcu_read_unlock(); 5212a0a1a5fdSTejun Heo goto out_unlock; 5213a0a1a5fdSTejun Heo } 5214a0a1a5fdSTejun Heo } 521524acfb71SThomas Gleixner rcu_read_unlock(); 5216a0a1a5fdSTejun Heo } 5217a0a1a5fdSTejun Heo out_unlock: 521868e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5219a0a1a5fdSTejun Heo return busy; 5220a0a1a5fdSTejun Heo } 5221a0a1a5fdSTejun Heo 5222a0a1a5fdSTejun Heo /** 5223a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 5224a0a1a5fdSTejun Heo * 5225a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 5226706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 5227a0a1a5fdSTejun Heo * 5228a0a1a5fdSTejun Heo * CONTEXT: 5229a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 5230a0a1a5fdSTejun Heo */ 5231a0a1a5fdSTejun Heo void thaw_workqueues(void) 5232a0a1a5fdSTejun Heo { 523324b8a847STejun Heo struct workqueue_struct *wq; 523424b8a847STejun Heo struct pool_workqueue *pwq; 5235a0a1a5fdSTejun Heo 523668e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5237a0a1a5fdSTejun Heo 5238a0a1a5fdSTejun Heo if (!workqueue_freezing) 5239a0a1a5fdSTejun Heo goto out_unlock; 5240a0a1a5fdSTejun Heo 524174b414eaSLai Jiangshan workqueue_freezing = false; 524224b8a847STejun Heo 524324b8a847STejun Heo /* restore max_active and repopulate worklist */ 524424b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 5245a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5246699ce097STejun Heo for_each_pwq(pwq, wq) 5247699ce097STejun Heo pwq_adjust_max_active(pwq); 5248a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 524924b8a847STejun Heo } 525024b8a847STejun Heo 5251a0a1a5fdSTejun Heo out_unlock: 525268e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5253a0a1a5fdSTejun Heo } 5254a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 5255a0a1a5fdSTejun Heo 5256042f7df1SLai Jiangshan static int workqueue_apply_unbound_cpumask(void) 5257042f7df1SLai Jiangshan { 5258042f7df1SLai Jiangshan LIST_HEAD(ctxs); 5259042f7df1SLai Jiangshan int ret = 0; 5260042f7df1SLai Jiangshan struct workqueue_struct *wq; 5261042f7df1SLai Jiangshan struct apply_wqattrs_ctx *ctx, *n; 5262042f7df1SLai Jiangshan 5263042f7df1SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5264042f7df1SLai Jiangshan 5265042f7df1SLai Jiangshan list_for_each_entry(wq, &workqueues, list) { 5266042f7df1SLai Jiangshan if (!(wq->flags & WQ_UNBOUND)) 5267042f7df1SLai Jiangshan continue; 5268042f7df1SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 5269042f7df1SLai Jiangshan if (wq->flags & __WQ_ORDERED) 5270042f7df1SLai Jiangshan continue; 5271042f7df1SLai Jiangshan 5272042f7df1SLai Jiangshan ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs); 5273042f7df1SLai Jiangshan if (!ctx) { 5274042f7df1SLai Jiangshan ret = -ENOMEM; 5275042f7df1SLai Jiangshan break; 5276042f7df1SLai Jiangshan } 5277042f7df1SLai Jiangshan 5278042f7df1SLai Jiangshan list_add_tail(&ctx->list, &ctxs); 5279042f7df1SLai Jiangshan } 5280042f7df1SLai Jiangshan 5281042f7df1SLai Jiangshan list_for_each_entry_safe(ctx, n, &ctxs, list) { 5282042f7df1SLai Jiangshan if (!ret) 5283042f7df1SLai Jiangshan apply_wqattrs_commit(ctx); 5284042f7df1SLai Jiangshan apply_wqattrs_cleanup(ctx); 5285042f7df1SLai Jiangshan } 5286042f7df1SLai Jiangshan 5287042f7df1SLai Jiangshan return ret; 5288042f7df1SLai Jiangshan } 5289042f7df1SLai Jiangshan 5290042f7df1SLai Jiangshan /** 5291042f7df1SLai Jiangshan * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask 5292042f7df1SLai Jiangshan * @cpumask: the cpumask to set 5293042f7df1SLai Jiangshan * 5294042f7df1SLai Jiangshan * The low-level workqueues cpumask is a global cpumask that limits 5295042f7df1SLai Jiangshan * the affinity of all unbound workqueues. This function check the @cpumask 5296042f7df1SLai Jiangshan * and apply it to all unbound workqueues and updates all pwqs of them. 5297042f7df1SLai Jiangshan * 5298042f7df1SLai Jiangshan * Retun: 0 - Success 5299042f7df1SLai Jiangshan * -EINVAL - Invalid @cpumask 5300042f7df1SLai Jiangshan * -ENOMEM - Failed to allocate memory for attrs or pwqs. 5301042f7df1SLai Jiangshan */ 5302042f7df1SLai Jiangshan int workqueue_set_unbound_cpumask(cpumask_var_t cpumask) 5303042f7df1SLai Jiangshan { 5304042f7df1SLai Jiangshan int ret = -EINVAL; 5305042f7df1SLai Jiangshan cpumask_var_t saved_cpumask; 5306042f7df1SLai Jiangshan 5307042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL)) 5308042f7df1SLai Jiangshan return -ENOMEM; 5309042f7df1SLai Jiangshan 5310c98a9805STal Shorer /* 5311c98a9805STal Shorer * Not excluding isolated cpus on purpose. 5312c98a9805STal Shorer * If the user wishes to include them, we allow that. 5313c98a9805STal Shorer */ 5314042f7df1SLai Jiangshan cpumask_and(cpumask, cpumask, cpu_possible_mask); 5315042f7df1SLai Jiangshan if (!cpumask_empty(cpumask)) { 5316a0111cf6SLai Jiangshan apply_wqattrs_lock(); 5317042f7df1SLai Jiangshan 5318042f7df1SLai Jiangshan /* save the old wq_unbound_cpumask. */ 5319042f7df1SLai Jiangshan cpumask_copy(saved_cpumask, wq_unbound_cpumask); 5320042f7df1SLai Jiangshan 5321042f7df1SLai Jiangshan /* update wq_unbound_cpumask at first and apply it to wqs. */ 5322042f7df1SLai Jiangshan cpumask_copy(wq_unbound_cpumask, cpumask); 5323042f7df1SLai Jiangshan ret = workqueue_apply_unbound_cpumask(); 5324042f7df1SLai Jiangshan 5325042f7df1SLai Jiangshan /* restore the wq_unbound_cpumask when failed. */ 5326042f7df1SLai Jiangshan if (ret < 0) 5327042f7df1SLai Jiangshan cpumask_copy(wq_unbound_cpumask, saved_cpumask); 5328042f7df1SLai Jiangshan 5329a0111cf6SLai Jiangshan apply_wqattrs_unlock(); 5330042f7df1SLai Jiangshan } 5331042f7df1SLai Jiangshan 5332042f7df1SLai Jiangshan free_cpumask_var(saved_cpumask); 5333042f7df1SLai Jiangshan return ret; 5334042f7df1SLai Jiangshan } 5335042f7df1SLai Jiangshan 53366ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS 53376ba94429SFrederic Weisbecker /* 53386ba94429SFrederic Weisbecker * Workqueues with WQ_SYSFS flag set is visible to userland via 53396ba94429SFrederic Weisbecker * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 53406ba94429SFrederic Weisbecker * following attributes. 53416ba94429SFrederic Weisbecker * 53426ba94429SFrederic Weisbecker * per_cpu RO bool : whether the workqueue is per-cpu or unbound 53436ba94429SFrederic Weisbecker * max_active RW int : maximum number of in-flight work items 53446ba94429SFrederic Weisbecker * 53456ba94429SFrederic Weisbecker * Unbound workqueues have the following extra attributes. 53466ba94429SFrederic Weisbecker * 53479a19b463SWang Long * pool_ids RO int : the associated pool IDs for each node 53486ba94429SFrederic Weisbecker * nice RW int : nice value of the workers 53496ba94429SFrederic Weisbecker * cpumask RW mask : bitmask of allowed CPUs for the workers 53509a19b463SWang Long * numa RW bool : whether enable NUMA affinity 53516ba94429SFrederic Weisbecker */ 53526ba94429SFrederic Weisbecker struct wq_device { 53536ba94429SFrederic Weisbecker struct workqueue_struct *wq; 53546ba94429SFrederic Weisbecker struct device dev; 53556ba94429SFrederic Weisbecker }; 53566ba94429SFrederic Weisbecker 53576ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev) 53586ba94429SFrederic Weisbecker { 53596ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 53606ba94429SFrederic Weisbecker 53616ba94429SFrederic Weisbecker return wq_dev->wq; 53626ba94429SFrederic Weisbecker } 53636ba94429SFrederic Weisbecker 53646ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, 53656ba94429SFrederic Weisbecker char *buf) 53666ba94429SFrederic Weisbecker { 53676ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 53686ba94429SFrederic Weisbecker 53696ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 53706ba94429SFrederic Weisbecker } 53716ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu); 53726ba94429SFrederic Weisbecker 53736ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev, 53746ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 53756ba94429SFrederic Weisbecker { 53766ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 53776ba94429SFrederic Weisbecker 53786ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 53796ba94429SFrederic Weisbecker } 53806ba94429SFrederic Weisbecker 53816ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev, 53826ba94429SFrederic Weisbecker struct device_attribute *attr, const char *buf, 53836ba94429SFrederic Weisbecker size_t count) 53846ba94429SFrederic Weisbecker { 53856ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 53866ba94429SFrederic Weisbecker int val; 53876ba94429SFrederic Weisbecker 53886ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &val) != 1 || val <= 0) 53896ba94429SFrederic Weisbecker return -EINVAL; 53906ba94429SFrederic Weisbecker 53916ba94429SFrederic Weisbecker workqueue_set_max_active(wq, val); 53926ba94429SFrederic Weisbecker return count; 53936ba94429SFrederic Weisbecker } 53946ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active); 53956ba94429SFrederic Weisbecker 53966ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = { 53976ba94429SFrederic Weisbecker &dev_attr_per_cpu.attr, 53986ba94429SFrederic Weisbecker &dev_attr_max_active.attr, 53996ba94429SFrederic Weisbecker NULL, 54006ba94429SFrederic Weisbecker }; 54016ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs); 54026ba94429SFrederic Weisbecker 54036ba94429SFrederic Weisbecker static ssize_t wq_pool_ids_show(struct device *dev, 54046ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 54056ba94429SFrederic Weisbecker { 54066ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 54076ba94429SFrederic Weisbecker const char *delim = ""; 54086ba94429SFrederic Weisbecker int node, written = 0; 54096ba94429SFrederic Weisbecker 541024acfb71SThomas Gleixner get_online_cpus(); 541124acfb71SThomas Gleixner rcu_read_lock(); 54126ba94429SFrederic Weisbecker for_each_node(node) { 54136ba94429SFrederic Weisbecker written += scnprintf(buf + written, PAGE_SIZE - written, 54146ba94429SFrederic Weisbecker "%s%d:%d", delim, node, 54156ba94429SFrederic Weisbecker unbound_pwq_by_node(wq, node)->pool->id); 54166ba94429SFrederic Weisbecker delim = " "; 54176ba94429SFrederic Weisbecker } 54186ba94429SFrederic Weisbecker written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); 541924acfb71SThomas Gleixner rcu_read_unlock(); 542024acfb71SThomas Gleixner put_online_cpus(); 54216ba94429SFrederic Weisbecker 54226ba94429SFrederic Weisbecker return written; 54236ba94429SFrederic Weisbecker } 54246ba94429SFrederic Weisbecker 54256ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 54266ba94429SFrederic Weisbecker char *buf) 54276ba94429SFrederic Weisbecker { 54286ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 54296ba94429SFrederic Weisbecker int written; 54306ba94429SFrederic Weisbecker 54316ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 54326ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); 54336ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 54346ba94429SFrederic Weisbecker 54356ba94429SFrederic Weisbecker return written; 54366ba94429SFrederic Weisbecker } 54376ba94429SFrederic Weisbecker 54386ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */ 54396ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 54406ba94429SFrederic Weisbecker { 54416ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 54426ba94429SFrederic Weisbecker 5443899a94feSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5444899a94feSLai Jiangshan 5445be69d00dSThomas Gleixner attrs = alloc_workqueue_attrs(); 54466ba94429SFrederic Weisbecker if (!attrs) 54476ba94429SFrederic Weisbecker return NULL; 54486ba94429SFrederic Weisbecker 54496ba94429SFrederic Weisbecker copy_workqueue_attrs(attrs, wq->unbound_attrs); 54506ba94429SFrederic Weisbecker return attrs; 54516ba94429SFrederic Weisbecker } 54526ba94429SFrederic Weisbecker 54536ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 54546ba94429SFrederic Weisbecker const char *buf, size_t count) 54556ba94429SFrederic Weisbecker { 54566ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 54576ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 5458d4d3e257SLai Jiangshan int ret = -ENOMEM; 5459d4d3e257SLai Jiangshan 5460d4d3e257SLai Jiangshan apply_wqattrs_lock(); 54616ba94429SFrederic Weisbecker 54626ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 54636ba94429SFrederic Weisbecker if (!attrs) 5464d4d3e257SLai Jiangshan goto out_unlock; 54656ba94429SFrederic Weisbecker 54666ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &attrs->nice) == 1 && 54676ba94429SFrederic Weisbecker attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) 5468d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 54696ba94429SFrederic Weisbecker else 54706ba94429SFrederic Weisbecker ret = -EINVAL; 54716ba94429SFrederic Weisbecker 5472d4d3e257SLai Jiangshan out_unlock: 5473d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 54746ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 54756ba94429SFrederic Weisbecker return ret ?: count; 54766ba94429SFrederic Weisbecker } 54776ba94429SFrederic Weisbecker 54786ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev, 54796ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 54806ba94429SFrederic Weisbecker { 54816ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 54826ba94429SFrederic Weisbecker int written; 54836ba94429SFrederic Weisbecker 54846ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 54856ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 54866ba94429SFrederic Weisbecker cpumask_pr_args(wq->unbound_attrs->cpumask)); 54876ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 54886ba94429SFrederic Weisbecker return written; 54896ba94429SFrederic Weisbecker } 54906ba94429SFrederic Weisbecker 54916ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev, 54926ba94429SFrederic Weisbecker struct device_attribute *attr, 54936ba94429SFrederic Weisbecker const char *buf, size_t count) 54946ba94429SFrederic Weisbecker { 54956ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 54966ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 5497d4d3e257SLai Jiangshan int ret = -ENOMEM; 5498d4d3e257SLai Jiangshan 5499d4d3e257SLai Jiangshan apply_wqattrs_lock(); 55006ba94429SFrederic Weisbecker 55016ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 55026ba94429SFrederic Weisbecker if (!attrs) 5503d4d3e257SLai Jiangshan goto out_unlock; 55046ba94429SFrederic Weisbecker 55056ba94429SFrederic Weisbecker ret = cpumask_parse(buf, attrs->cpumask); 55066ba94429SFrederic Weisbecker if (!ret) 5507d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 55086ba94429SFrederic Weisbecker 5509d4d3e257SLai Jiangshan out_unlock: 5510d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 55116ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 55126ba94429SFrederic Weisbecker return ret ?: count; 55136ba94429SFrederic Weisbecker } 55146ba94429SFrederic Weisbecker 55156ba94429SFrederic Weisbecker static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr, 55166ba94429SFrederic Weisbecker char *buf) 55176ba94429SFrederic Weisbecker { 55186ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 55196ba94429SFrederic Weisbecker int written; 55206ba94429SFrederic Weisbecker 55216ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 55226ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", 55236ba94429SFrederic Weisbecker !wq->unbound_attrs->no_numa); 55246ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 55256ba94429SFrederic Weisbecker 55266ba94429SFrederic Weisbecker return written; 55276ba94429SFrederic Weisbecker } 55286ba94429SFrederic Weisbecker 55296ba94429SFrederic Weisbecker static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr, 55306ba94429SFrederic Weisbecker const char *buf, size_t count) 55316ba94429SFrederic Weisbecker { 55326ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 55336ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 5534d4d3e257SLai Jiangshan int v, ret = -ENOMEM; 5535d4d3e257SLai Jiangshan 5536d4d3e257SLai Jiangshan apply_wqattrs_lock(); 55376ba94429SFrederic Weisbecker 55386ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 55396ba94429SFrederic Weisbecker if (!attrs) 5540d4d3e257SLai Jiangshan goto out_unlock; 55416ba94429SFrederic Weisbecker 55426ba94429SFrederic Weisbecker ret = -EINVAL; 55436ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &v) == 1) { 55446ba94429SFrederic Weisbecker attrs->no_numa = !v; 5545d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 55466ba94429SFrederic Weisbecker } 55476ba94429SFrederic Weisbecker 5548d4d3e257SLai Jiangshan out_unlock: 5549d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 55506ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 55516ba94429SFrederic Weisbecker return ret ?: count; 55526ba94429SFrederic Weisbecker } 55536ba94429SFrederic Weisbecker 55546ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = { 55556ba94429SFrederic Weisbecker __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL), 55566ba94429SFrederic Weisbecker __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 55576ba94429SFrederic Weisbecker __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 55586ba94429SFrederic Weisbecker __ATTR(numa, 0644, wq_numa_show, wq_numa_store), 55596ba94429SFrederic Weisbecker __ATTR_NULL, 55606ba94429SFrederic Weisbecker }; 55616ba94429SFrederic Weisbecker 55626ba94429SFrederic Weisbecker static struct bus_type wq_subsys = { 55636ba94429SFrederic Weisbecker .name = "workqueue", 55646ba94429SFrederic Weisbecker .dev_groups = wq_sysfs_groups, 55656ba94429SFrederic Weisbecker }; 55666ba94429SFrederic Weisbecker 5567b05a7928SFrederic Weisbecker static ssize_t wq_unbound_cpumask_show(struct device *dev, 5568b05a7928SFrederic Weisbecker struct device_attribute *attr, char *buf) 5569b05a7928SFrederic Weisbecker { 5570b05a7928SFrederic Weisbecker int written; 5571b05a7928SFrederic Weisbecker 5572042f7df1SLai Jiangshan mutex_lock(&wq_pool_mutex); 5573b05a7928SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 5574b05a7928SFrederic Weisbecker cpumask_pr_args(wq_unbound_cpumask)); 5575042f7df1SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5576b05a7928SFrederic Weisbecker 5577b05a7928SFrederic Weisbecker return written; 5578b05a7928SFrederic Weisbecker } 5579b05a7928SFrederic Weisbecker 5580042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev, 5581042f7df1SLai Jiangshan struct device_attribute *attr, const char *buf, size_t count) 5582042f7df1SLai Jiangshan { 5583042f7df1SLai Jiangshan cpumask_var_t cpumask; 5584042f7df1SLai Jiangshan int ret; 5585042f7df1SLai Jiangshan 5586042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 5587042f7df1SLai Jiangshan return -ENOMEM; 5588042f7df1SLai Jiangshan 5589042f7df1SLai Jiangshan ret = cpumask_parse(buf, cpumask); 5590042f7df1SLai Jiangshan if (!ret) 5591042f7df1SLai Jiangshan ret = workqueue_set_unbound_cpumask(cpumask); 5592042f7df1SLai Jiangshan 5593042f7df1SLai Jiangshan free_cpumask_var(cpumask); 5594042f7df1SLai Jiangshan return ret ? ret : count; 5595042f7df1SLai Jiangshan } 5596042f7df1SLai Jiangshan 5597b05a7928SFrederic Weisbecker static struct device_attribute wq_sysfs_cpumask_attr = 5598042f7df1SLai Jiangshan __ATTR(cpumask, 0644, wq_unbound_cpumask_show, 5599042f7df1SLai Jiangshan wq_unbound_cpumask_store); 5600b05a7928SFrederic Weisbecker 56016ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void) 56026ba94429SFrederic Weisbecker { 5603b05a7928SFrederic Weisbecker int err; 5604b05a7928SFrederic Weisbecker 5605b05a7928SFrederic Weisbecker err = subsys_virtual_register(&wq_subsys, NULL); 5606b05a7928SFrederic Weisbecker if (err) 5607b05a7928SFrederic Weisbecker return err; 5608b05a7928SFrederic Weisbecker 5609b05a7928SFrederic Weisbecker return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr); 56106ba94429SFrederic Weisbecker } 56116ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init); 56126ba94429SFrederic Weisbecker 56136ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev) 56146ba94429SFrederic Weisbecker { 56156ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 56166ba94429SFrederic Weisbecker 56176ba94429SFrederic Weisbecker kfree(wq_dev); 56186ba94429SFrederic Weisbecker } 56196ba94429SFrederic Weisbecker 56206ba94429SFrederic Weisbecker /** 56216ba94429SFrederic Weisbecker * workqueue_sysfs_register - make a workqueue visible in sysfs 56226ba94429SFrederic Weisbecker * @wq: the workqueue to register 56236ba94429SFrederic Weisbecker * 56246ba94429SFrederic Weisbecker * Expose @wq in sysfs under /sys/bus/workqueue/devices. 56256ba94429SFrederic Weisbecker * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 56266ba94429SFrederic Weisbecker * which is the preferred method. 56276ba94429SFrederic Weisbecker * 56286ba94429SFrederic Weisbecker * Workqueue user should use this function directly iff it wants to apply 56296ba94429SFrederic Weisbecker * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 56306ba94429SFrederic Weisbecker * apply_workqueue_attrs() may race against userland updating the 56316ba94429SFrederic Weisbecker * attributes. 56326ba94429SFrederic Weisbecker * 56336ba94429SFrederic Weisbecker * Return: 0 on success, -errno on failure. 56346ba94429SFrederic Weisbecker */ 56356ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq) 56366ba94429SFrederic Weisbecker { 56376ba94429SFrederic Weisbecker struct wq_device *wq_dev; 56386ba94429SFrederic Weisbecker int ret; 56396ba94429SFrederic Weisbecker 56406ba94429SFrederic Weisbecker /* 5641402dd89dSShailendra Verma * Adjusting max_active or creating new pwqs by applying 56426ba94429SFrederic Weisbecker * attributes breaks ordering guarantee. Disallow exposing ordered 56436ba94429SFrederic Weisbecker * workqueues. 56446ba94429SFrederic Weisbecker */ 56450a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 56466ba94429SFrederic Weisbecker return -EINVAL; 56476ba94429SFrederic Weisbecker 56486ba94429SFrederic Weisbecker wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 56496ba94429SFrederic Weisbecker if (!wq_dev) 56506ba94429SFrederic Weisbecker return -ENOMEM; 56516ba94429SFrederic Weisbecker 56526ba94429SFrederic Weisbecker wq_dev->wq = wq; 56536ba94429SFrederic Weisbecker wq_dev->dev.bus = &wq_subsys; 56546ba94429SFrederic Weisbecker wq_dev->dev.release = wq_device_release; 565523217b44SLars-Peter Clausen dev_set_name(&wq_dev->dev, "%s", wq->name); 56566ba94429SFrederic Weisbecker 56576ba94429SFrederic Weisbecker /* 56586ba94429SFrederic Weisbecker * unbound_attrs are created separately. Suppress uevent until 56596ba94429SFrederic Weisbecker * everything is ready. 56606ba94429SFrederic Weisbecker */ 56616ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, true); 56626ba94429SFrederic Weisbecker 56636ba94429SFrederic Weisbecker ret = device_register(&wq_dev->dev); 56646ba94429SFrederic Weisbecker if (ret) { 5665537f4146SArvind Yadav put_device(&wq_dev->dev); 56666ba94429SFrederic Weisbecker wq->wq_dev = NULL; 56676ba94429SFrederic Weisbecker return ret; 56686ba94429SFrederic Weisbecker } 56696ba94429SFrederic Weisbecker 56706ba94429SFrederic Weisbecker if (wq->flags & WQ_UNBOUND) { 56716ba94429SFrederic Weisbecker struct device_attribute *attr; 56726ba94429SFrederic Weisbecker 56736ba94429SFrederic Weisbecker for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 56746ba94429SFrederic Weisbecker ret = device_create_file(&wq_dev->dev, attr); 56756ba94429SFrederic Weisbecker if (ret) { 56766ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 56776ba94429SFrederic Weisbecker wq->wq_dev = NULL; 56786ba94429SFrederic Weisbecker return ret; 56796ba94429SFrederic Weisbecker } 56806ba94429SFrederic Weisbecker } 56816ba94429SFrederic Weisbecker } 56826ba94429SFrederic Weisbecker 56836ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, false); 56846ba94429SFrederic Weisbecker kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 56856ba94429SFrederic Weisbecker return 0; 56866ba94429SFrederic Weisbecker } 56876ba94429SFrederic Weisbecker 56886ba94429SFrederic Weisbecker /** 56896ba94429SFrederic Weisbecker * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 56906ba94429SFrederic Weisbecker * @wq: the workqueue to unregister 56916ba94429SFrederic Weisbecker * 56926ba94429SFrederic Weisbecker * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 56936ba94429SFrederic Weisbecker */ 56946ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 56956ba94429SFrederic Weisbecker { 56966ba94429SFrederic Weisbecker struct wq_device *wq_dev = wq->wq_dev; 56976ba94429SFrederic Weisbecker 56986ba94429SFrederic Weisbecker if (!wq->wq_dev) 56996ba94429SFrederic Weisbecker return; 57006ba94429SFrederic Weisbecker 57016ba94429SFrederic Weisbecker wq->wq_dev = NULL; 57026ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 57036ba94429SFrederic Weisbecker } 57046ba94429SFrederic Weisbecker #else /* CONFIG_SYSFS */ 57056ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 57066ba94429SFrederic Weisbecker #endif /* CONFIG_SYSFS */ 57076ba94429SFrederic Weisbecker 570882607adcSTejun Heo /* 570982607adcSTejun Heo * Workqueue watchdog. 571082607adcSTejun Heo * 571182607adcSTejun Heo * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal 571282607adcSTejun Heo * flush dependency, a concurrency managed work item which stays RUNNING 571382607adcSTejun Heo * indefinitely. Workqueue stalls can be very difficult to debug as the 571482607adcSTejun Heo * usual warning mechanisms don't trigger and internal workqueue state is 571582607adcSTejun Heo * largely opaque. 571682607adcSTejun Heo * 571782607adcSTejun Heo * Workqueue watchdog monitors all worker pools periodically and dumps 571882607adcSTejun Heo * state if some pools failed to make forward progress for a while where 571982607adcSTejun Heo * forward progress is defined as the first item on ->worklist changing. 572082607adcSTejun Heo * 572182607adcSTejun Heo * This mechanism is controlled through the kernel parameter 572282607adcSTejun Heo * "workqueue.watchdog_thresh" which can be updated at runtime through the 572382607adcSTejun Heo * corresponding sysfs parameter file. 572482607adcSTejun Heo */ 572582607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG 572682607adcSTejun Heo 572782607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30; 57285cd79d6aSKees Cook static struct timer_list wq_watchdog_timer; 572982607adcSTejun Heo 573082607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES; 573182607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES; 573282607adcSTejun Heo 573382607adcSTejun Heo static void wq_watchdog_reset_touched(void) 573482607adcSTejun Heo { 573582607adcSTejun Heo int cpu; 573682607adcSTejun Heo 573782607adcSTejun Heo wq_watchdog_touched = jiffies; 573882607adcSTejun Heo for_each_possible_cpu(cpu) 573982607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 574082607adcSTejun Heo } 574182607adcSTejun Heo 57425cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused) 574382607adcSTejun Heo { 574482607adcSTejun Heo unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; 574582607adcSTejun Heo bool lockup_detected = false; 574682607adcSTejun Heo struct worker_pool *pool; 574782607adcSTejun Heo int pi; 574882607adcSTejun Heo 574982607adcSTejun Heo if (!thresh) 575082607adcSTejun Heo return; 575182607adcSTejun Heo 575282607adcSTejun Heo rcu_read_lock(); 575382607adcSTejun Heo 575482607adcSTejun Heo for_each_pool(pool, pi) { 575582607adcSTejun Heo unsigned long pool_ts, touched, ts; 575682607adcSTejun Heo 575782607adcSTejun Heo if (list_empty(&pool->worklist)) 575882607adcSTejun Heo continue; 575982607adcSTejun Heo 576082607adcSTejun Heo /* get the latest of pool and touched timestamps */ 576182607adcSTejun Heo pool_ts = READ_ONCE(pool->watchdog_ts); 576282607adcSTejun Heo touched = READ_ONCE(wq_watchdog_touched); 576382607adcSTejun Heo 576482607adcSTejun Heo if (time_after(pool_ts, touched)) 576582607adcSTejun Heo ts = pool_ts; 576682607adcSTejun Heo else 576782607adcSTejun Heo ts = touched; 576882607adcSTejun Heo 576982607adcSTejun Heo if (pool->cpu >= 0) { 577082607adcSTejun Heo unsigned long cpu_touched = 577182607adcSTejun Heo READ_ONCE(per_cpu(wq_watchdog_touched_cpu, 577282607adcSTejun Heo pool->cpu)); 577382607adcSTejun Heo if (time_after(cpu_touched, ts)) 577482607adcSTejun Heo ts = cpu_touched; 577582607adcSTejun Heo } 577682607adcSTejun Heo 577782607adcSTejun Heo /* did we stall? */ 577882607adcSTejun Heo if (time_after(jiffies, ts + thresh)) { 577982607adcSTejun Heo lockup_detected = true; 578082607adcSTejun Heo pr_emerg("BUG: workqueue lockup - pool"); 578182607adcSTejun Heo pr_cont_pool_info(pool); 578282607adcSTejun Heo pr_cont(" stuck for %us!\n", 578382607adcSTejun Heo jiffies_to_msecs(jiffies - pool_ts) / 1000); 578482607adcSTejun Heo } 578582607adcSTejun Heo } 578682607adcSTejun Heo 578782607adcSTejun Heo rcu_read_unlock(); 578882607adcSTejun Heo 578982607adcSTejun Heo if (lockup_detected) 579082607adcSTejun Heo show_workqueue_state(); 579182607adcSTejun Heo 579282607adcSTejun Heo wq_watchdog_reset_touched(); 579382607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh); 579482607adcSTejun Heo } 579582607adcSTejun Heo 5796cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu) 579782607adcSTejun Heo { 579882607adcSTejun Heo if (cpu >= 0) 579982607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 580082607adcSTejun Heo else 580182607adcSTejun Heo wq_watchdog_touched = jiffies; 580282607adcSTejun Heo } 580382607adcSTejun Heo 580482607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh) 580582607adcSTejun Heo { 580682607adcSTejun Heo wq_watchdog_thresh = 0; 580782607adcSTejun Heo del_timer_sync(&wq_watchdog_timer); 580882607adcSTejun Heo 580982607adcSTejun Heo if (thresh) { 581082607adcSTejun Heo wq_watchdog_thresh = thresh; 581182607adcSTejun Heo wq_watchdog_reset_touched(); 581282607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ); 581382607adcSTejun Heo } 581482607adcSTejun Heo } 581582607adcSTejun Heo 581682607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val, 581782607adcSTejun Heo const struct kernel_param *kp) 581882607adcSTejun Heo { 581982607adcSTejun Heo unsigned long thresh; 582082607adcSTejun Heo int ret; 582182607adcSTejun Heo 582282607adcSTejun Heo ret = kstrtoul(val, 0, &thresh); 582382607adcSTejun Heo if (ret) 582482607adcSTejun Heo return ret; 582582607adcSTejun Heo 582682607adcSTejun Heo if (system_wq) 582782607adcSTejun Heo wq_watchdog_set_thresh(thresh); 582882607adcSTejun Heo else 582982607adcSTejun Heo wq_watchdog_thresh = thresh; 583082607adcSTejun Heo 583182607adcSTejun Heo return 0; 583282607adcSTejun Heo } 583382607adcSTejun Heo 583482607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = { 583582607adcSTejun Heo .set = wq_watchdog_param_set_thresh, 583682607adcSTejun Heo .get = param_get_ulong, 583782607adcSTejun Heo }; 583882607adcSTejun Heo 583982607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh, 584082607adcSTejun Heo 0644); 584182607adcSTejun Heo 584282607adcSTejun Heo static void wq_watchdog_init(void) 584382607adcSTejun Heo { 58445cd79d6aSKees Cook timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE); 584582607adcSTejun Heo wq_watchdog_set_thresh(wq_watchdog_thresh); 584682607adcSTejun Heo } 584782607adcSTejun Heo 584882607adcSTejun Heo #else /* CONFIG_WQ_WATCHDOG */ 584982607adcSTejun Heo 585082607adcSTejun Heo static inline void wq_watchdog_init(void) { } 585182607adcSTejun Heo 585282607adcSTejun Heo #endif /* CONFIG_WQ_WATCHDOG */ 585382607adcSTejun Heo 5854bce90380STejun Heo static void __init wq_numa_init(void) 5855bce90380STejun Heo { 5856bce90380STejun Heo cpumask_var_t *tbl; 5857bce90380STejun Heo int node, cpu; 5858bce90380STejun Heo 5859bce90380STejun Heo if (num_possible_nodes() <= 1) 5860bce90380STejun Heo return; 5861bce90380STejun Heo 5862d55262c4STejun Heo if (wq_disable_numa) { 5863d55262c4STejun Heo pr_info("workqueue: NUMA affinity support disabled\n"); 5864d55262c4STejun Heo return; 5865d55262c4STejun Heo } 5866d55262c4STejun Heo 5867be69d00dSThomas Gleixner wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(); 58684c16bd32STejun Heo BUG_ON(!wq_update_unbound_numa_attrs_buf); 58694c16bd32STejun Heo 5870bce90380STejun Heo /* 5871bce90380STejun Heo * We want masks of possible CPUs of each node which isn't readily 5872bce90380STejun Heo * available. Build one from cpu_to_node() which should have been 5873bce90380STejun Heo * fully initialized by now. 5874bce90380STejun Heo */ 58756396bb22SKees Cook tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL); 5876bce90380STejun Heo BUG_ON(!tbl); 5877bce90380STejun Heo 5878bce90380STejun Heo for_each_node(node) 58795a6024f1SYasuaki Ishimatsu BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL, 58801be0c25dSTejun Heo node_online(node) ? node : NUMA_NO_NODE)); 5881bce90380STejun Heo 5882bce90380STejun Heo for_each_possible_cpu(cpu) { 5883bce90380STejun Heo node = cpu_to_node(cpu); 5884bce90380STejun Heo if (WARN_ON(node == NUMA_NO_NODE)) { 5885bce90380STejun Heo pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu); 5886bce90380STejun Heo /* happens iff arch is bonkers, let's just proceed */ 5887bce90380STejun Heo return; 5888bce90380STejun Heo } 5889bce90380STejun Heo cpumask_set_cpu(cpu, tbl[node]); 5890bce90380STejun Heo } 5891bce90380STejun Heo 5892bce90380STejun Heo wq_numa_possible_cpumask = tbl; 5893bce90380STejun Heo wq_numa_enabled = true; 5894bce90380STejun Heo } 5895bce90380STejun Heo 58963347fa09STejun Heo /** 58973347fa09STejun Heo * workqueue_init_early - early init for workqueue subsystem 58983347fa09STejun Heo * 58993347fa09STejun Heo * This is the first half of two-staged workqueue subsystem initialization 59003347fa09STejun Heo * and invoked as soon as the bare basics - memory allocation, cpumasks and 59013347fa09STejun Heo * idr are up. It sets up all the data structures and system workqueues 59023347fa09STejun Heo * and allows early boot code to create workqueues and queue/cancel work 59033347fa09STejun Heo * items. Actual work item execution starts only after kthreads can be 59043347fa09STejun Heo * created and scheduled right before early initcalls. 59053347fa09STejun Heo */ 59063347fa09STejun Heo int __init workqueue_init_early(void) 59071da177e4SLinus Torvalds { 59087a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 59091bda3f80SFrederic Weisbecker int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ; 59107a4e344cSTejun Heo int i, cpu; 5911c34056a3STejun Heo 5912e904e6c2STejun Heo WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 5913e904e6c2STejun Heo 5914b05a7928SFrederic Weisbecker BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL)); 59151bda3f80SFrederic Weisbecker cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags)); 5916b05a7928SFrederic Weisbecker 5917e904e6c2STejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 5918e904e6c2STejun Heo 5919706026c2STejun Heo /* initialize CPU pools */ 592029c91e99STejun Heo for_each_possible_cpu(cpu) { 59214ce62e9eSTejun Heo struct worker_pool *pool; 59228b03ae3cSTejun Heo 59237a4e344cSTejun Heo i = 0; 5924f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 59257a4e344cSTejun Heo BUG_ON(init_worker_pool(pool)); 5926ec22ca5eSTejun Heo pool->cpu = cpu; 59277a4e344cSTejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 59287a4e344cSTejun Heo pool->attrs->nice = std_nice[i++]; 5929f3f90ad4STejun Heo pool->node = cpu_to_node(cpu); 59307a4e344cSTejun Heo 59319daf9e67STejun Heo /* alloc pool ID */ 593268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 59339daf9e67STejun Heo BUG_ON(worker_pool_assign_id(pool)); 593468e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 59354ce62e9eSTejun Heo } 59368b03ae3cSTejun Heo } 59378b03ae3cSTejun Heo 59388a2b7538STejun Heo /* create default unbound and ordered wq attrs */ 593929c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 594029c91e99STejun Heo struct workqueue_attrs *attrs; 594129c91e99STejun Heo 5942be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 594329c91e99STejun Heo attrs->nice = std_nice[i]; 594429c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 59458a2b7538STejun Heo 59468a2b7538STejun Heo /* 59478a2b7538STejun Heo * An ordered wq should have only one pwq as ordering is 59488a2b7538STejun Heo * guaranteed by max_active which is enforced by pwqs. 59498a2b7538STejun Heo * Turn off NUMA so that dfl_pwq is used for all nodes. 59508a2b7538STejun Heo */ 5951be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 59528a2b7538STejun Heo attrs->nice = std_nice[i]; 59538a2b7538STejun Heo attrs->no_numa = true; 59548a2b7538STejun Heo ordered_wq_attrs[i] = attrs; 595529c91e99STejun Heo } 595629c91e99STejun Heo 5957d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 59581aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 5959d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 5960f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 5961f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 596224d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 596324d51addSTejun Heo WQ_FREEZABLE, 0); 59640668106cSViresh Kumar system_power_efficient_wq = alloc_workqueue("events_power_efficient", 59650668106cSViresh Kumar WQ_POWER_EFFICIENT, 0); 59660668106cSViresh Kumar system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient", 59670668106cSViresh Kumar WQ_FREEZABLE | WQ_POWER_EFFICIENT, 59680668106cSViresh Kumar 0); 59691aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 59700668106cSViresh Kumar !system_unbound_wq || !system_freezable_wq || 59710668106cSViresh Kumar !system_power_efficient_wq || 59720668106cSViresh Kumar !system_freezable_power_efficient_wq); 597382607adcSTejun Heo 59743347fa09STejun Heo return 0; 59753347fa09STejun Heo } 59763347fa09STejun Heo 59773347fa09STejun Heo /** 59783347fa09STejun Heo * workqueue_init - bring workqueue subsystem fully online 59793347fa09STejun Heo * 59803347fa09STejun Heo * This is the latter half of two-staged workqueue subsystem initialization 59813347fa09STejun Heo * and invoked as soon as kthreads can be created and scheduled. 59823347fa09STejun Heo * Workqueues have been created and work items queued on them, but there 59833347fa09STejun Heo * are no kworkers executing the work items yet. Populate the worker pools 59843347fa09STejun Heo * with the initial workers and enable future kworker creations. 59853347fa09STejun Heo */ 59863347fa09STejun Heo int __init workqueue_init(void) 59873347fa09STejun Heo { 59882186d9f9STejun Heo struct workqueue_struct *wq; 59893347fa09STejun Heo struct worker_pool *pool; 59903347fa09STejun Heo int cpu, bkt; 59913347fa09STejun Heo 59922186d9f9STejun Heo /* 59932186d9f9STejun Heo * It'd be simpler to initialize NUMA in workqueue_init_early() but 59942186d9f9STejun Heo * CPU to node mapping may not be available that early on some 59952186d9f9STejun Heo * archs such as power and arm64. As per-cpu pools created 59962186d9f9STejun Heo * previously could be missing node hint and unbound pools NUMA 59972186d9f9STejun Heo * affinity, fix them up. 599840c17f75STejun Heo * 599940c17f75STejun Heo * Also, while iterating workqueues, create rescuers if requested. 60002186d9f9STejun Heo */ 60012186d9f9STejun Heo wq_numa_init(); 60022186d9f9STejun Heo 60032186d9f9STejun Heo mutex_lock(&wq_pool_mutex); 60042186d9f9STejun Heo 60052186d9f9STejun Heo for_each_possible_cpu(cpu) { 60062186d9f9STejun Heo for_each_cpu_worker_pool(pool, cpu) { 60072186d9f9STejun Heo pool->node = cpu_to_node(cpu); 60082186d9f9STejun Heo } 60092186d9f9STejun Heo } 60102186d9f9STejun Heo 601140c17f75STejun Heo list_for_each_entry(wq, &workqueues, list) { 60122186d9f9STejun Heo wq_update_unbound_numa(wq, smp_processor_id(), true); 601340c17f75STejun Heo WARN(init_rescuer(wq), 601440c17f75STejun Heo "workqueue: failed to create early rescuer for %s", 601540c17f75STejun Heo wq->name); 601640c17f75STejun Heo } 60172186d9f9STejun Heo 60182186d9f9STejun Heo mutex_unlock(&wq_pool_mutex); 60192186d9f9STejun Heo 60203347fa09STejun Heo /* create the initial workers */ 60213347fa09STejun Heo for_each_online_cpu(cpu) { 60223347fa09STejun Heo for_each_cpu_worker_pool(pool, cpu) { 60233347fa09STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 60243347fa09STejun Heo BUG_ON(!create_worker(pool)); 60253347fa09STejun Heo } 60263347fa09STejun Heo } 60273347fa09STejun Heo 60283347fa09STejun Heo hash_for_each(unbound_pool_hash, bkt, pool, hash_node) 60293347fa09STejun Heo BUG_ON(!create_worker(pool)); 60303347fa09STejun Heo 60313347fa09STejun Heo wq_online = true; 603282607adcSTejun Heo wq_watchdog_init(); 603382607adcSTejun Heo 60346ee0578bSSuresh Siddha return 0; 60351da177e4SLinus Torvalds } 6036