11da177e4SLinus Torvalds /* 2c54fce6eSTejun Heo * kernel/workqueue.c - generic async execution with shared worker pool 31da177e4SLinus Torvalds * 4c54fce6eSTejun Heo * Copyright (C) 2002 Ingo Molnar 51da177e4SLinus Torvalds * 61da177e4SLinus Torvalds * Derived from the taskqueue/keventd code by: 71da177e4SLinus Torvalds * David Woodhouse <[email protected]> 8e1f8e874SFrancois Cami * Andrew Morton 91da177e4SLinus Torvalds * Kai Petzke <[email protected]> 101da177e4SLinus Torvalds * Theodore Ts'o <[email protected]> 1189ada679SChristoph Lameter * 12cde53535SChristoph Lameter * Made to use alloc_percpu by Christoph Lameter. 13c54fce6eSTejun Heo * 14c54fce6eSTejun Heo * Copyright (C) 2010 SUSE Linux Products GmbH 15c54fce6eSTejun Heo * Copyright (C) 2010 Tejun Heo <[email protected]> 16c54fce6eSTejun Heo * 17c54fce6eSTejun Heo * This is the generic async execution mechanism. Work items as are 18c54fce6eSTejun Heo * executed in process context. The worker pool is shared and 19b11895c4SLibin * automatically managed. There are two worker pools for each CPU (one for 20b11895c4SLibin * normal work items and the other for high priority ones) and some extra 21b11895c4SLibin * pools for workqueues which are not bound to any specific CPU - the 22b11895c4SLibin * number of these backing pools is dynamic. 23c54fce6eSTejun Heo * 24c54fce6eSTejun Heo * Please read Documentation/workqueue.txt for details. 251da177e4SLinus Torvalds */ 261da177e4SLinus Torvalds 279984de1aSPaul Gortmaker #include <linux/export.h> 281da177e4SLinus Torvalds #include <linux/kernel.h> 291da177e4SLinus Torvalds #include <linux/sched.h> 301da177e4SLinus Torvalds #include <linux/init.h> 311da177e4SLinus Torvalds #include <linux/signal.h> 321da177e4SLinus Torvalds #include <linux/completion.h> 331da177e4SLinus Torvalds #include <linux/workqueue.h> 341da177e4SLinus Torvalds #include <linux/slab.h> 351da177e4SLinus Torvalds #include <linux/cpu.h> 361da177e4SLinus Torvalds #include <linux/notifier.h> 371da177e4SLinus Torvalds #include <linux/kthread.h> 381fa44ecaSJames Bottomley #include <linux/hardirq.h> 3946934023SChristoph Lameter #include <linux/mempolicy.h> 40341a5958SRafael J. Wysocki #include <linux/freezer.h> 41d5abe669SPeter Zijlstra #include <linux/kallsyms.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> 51e22bee78STejun Heo 52ea138446STejun Heo #include "workqueue_internal.h" 531da177e4SLinus Torvalds 54c8e55f36STejun Heo enum { 55bc2ae0f5STejun Heo /* 5624647570STejun Heo * worker_pool flags 57bc2ae0f5STejun Heo * 5824647570STejun Heo * A bound pool is either associated or disassociated with its CPU. 59bc2ae0f5STejun Heo * While associated (!DISASSOCIATED), all workers are bound to the 60bc2ae0f5STejun Heo * CPU and none has %WORKER_UNBOUND set and concurrency management 61bc2ae0f5STejun Heo * is in effect. 62bc2ae0f5STejun Heo * 63bc2ae0f5STejun Heo * While DISASSOCIATED, the cpu may be offline and all workers have 64bc2ae0f5STejun Heo * %WORKER_UNBOUND set and concurrency management disabled, and may 6524647570STejun Heo * be executing on any CPU. The pool behaves as an unbound one. 66bc2ae0f5STejun Heo * 67bc3a1afcSTejun Heo * Note that DISASSOCIATED should be flipped only while holding 6892f9c5c4SLai Jiangshan * attach_mutex to avoid changing binding state while 694736cbf7SLai Jiangshan * worker_attach_to_pool() is in progress. 70bc2ae0f5STejun Heo */ 7124647570STejun Heo POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 72db7bccf4STejun Heo 73c8e55f36STejun Heo /* worker flags */ 74c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 75c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 76e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 77fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 78f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 79a9ab775bSTejun Heo WORKER_REBOUND = 1 << 8, /* worker was rebound */ 80e22bee78STejun Heo 81a9ab775bSTejun Heo WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE | 82a9ab775bSTejun Heo WORKER_UNBOUND | WORKER_REBOUND, 83db7bccf4STejun Heo 84e34cdddbSTejun Heo NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ 854ce62e9eSTejun Heo 8629c91e99STejun Heo UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ 87c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 88db7bccf4STejun Heo 89e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 90e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 91e22bee78STejun Heo 923233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 933233cdbdSTejun Heo /* call for help after 10ms 943233cdbdSTejun Heo (min two ticks) */ 95e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 96e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 971da177e4SLinus Torvalds 981da177e4SLinus Torvalds /* 99e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 1008698a745SDongsheng Yang * all cpus. Give MIN_NICE. 101e22bee78STejun Heo */ 1028698a745SDongsheng Yang RESCUER_NICE_LEVEL = MIN_NICE, 1038698a745SDongsheng Yang HIGHPRI_NICE_LEVEL = MIN_NICE, 104ecf6881fSTejun Heo 105ecf6881fSTejun Heo WQ_NAME_LEN = 24, 106c8e55f36STejun Heo }; 107c8e55f36STejun Heo 1081da177e4SLinus Torvalds /* 1094690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1104690c4abSTejun Heo * 111e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 112e41e704bSTejun Heo * everyone else. 1134690c4abSTejun Heo * 114e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 115e22bee78STejun Heo * only be modified and accessed from the local cpu. 116e22bee78STejun Heo * 117d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1184690c4abSTejun Heo * 119d565ed63STejun Heo * X: During normal operation, modification requires pool->lock and should 120d565ed63STejun Heo * be done only from local cpu. Either disabling preemption on local 121d565ed63STejun Heo * cpu or grabbing pool->lock is enough for read access. If 122d565ed63STejun Heo * POOL_DISASSOCIATED is set, it's identical to L. 123e22bee78STejun Heo * 12492f9c5c4SLai Jiangshan * A: pool->attach_mutex protected. 125822d8405STejun Heo * 12668e13a67SLai Jiangshan * PL: wq_pool_mutex protected. 12776af4d93STejun Heo * 12868e13a67SLai Jiangshan * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads. 1295bcab335STejun Heo * 1303c25a55dSLai Jiangshan * WQ: wq->mutex protected. 1313c25a55dSLai Jiangshan * 132b5927605SLai Jiangshan * WR: wq->mutex protected for writes. Sched-RCU protected for reads. 1332e109a28STejun Heo * 1342e109a28STejun Heo * MD: wq_mayday_lock protected. 1354690c4abSTejun Heo */ 1364690c4abSTejun Heo 1372eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 138c34056a3STejun Heo 139bd7bdd43STejun Heo struct worker_pool { 140d565ed63STejun Heo spinlock_t lock; /* the pool lock */ 141d84ff051STejun Heo int cpu; /* I: the associated cpu */ 142f3f90ad4STejun Heo int node; /* I: the associated node ID */ 1439daf9e67STejun Heo int id; /* I: pool ID */ 14411ebea50STejun Heo unsigned int flags; /* X: flags */ 145bd7bdd43STejun Heo 146bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 147bd7bdd43STejun Heo int nr_workers; /* L: total number of workers */ 148ea1abd61SLai Jiangshan 149ea1abd61SLai Jiangshan /* nr_idle includes the ones off idle_list for rebinding */ 150bd7bdd43STejun Heo int nr_idle; /* L: currently idle ones */ 151bd7bdd43STejun Heo 152bd7bdd43STejun Heo struct list_head idle_list; /* X: list of idle workers */ 153bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 154bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 155bd7bdd43STejun Heo 156c5aa87bbSTejun Heo /* a workers is either on busy_hash or idle_list, or the manager */ 157c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 158c9e7cf27STejun Heo /* L: hash of busy workers */ 159c9e7cf27STejun Heo 160bc3a1afcSTejun Heo /* see manage_workers() for details on the two manager mutexes */ 16134a06bd6STejun Heo struct mutex manager_arb; /* manager arbitration */ 1622607d7a6STejun Heo struct worker *manager; /* L: purely informational */ 16392f9c5c4SLai Jiangshan struct mutex attach_mutex; /* attach/detach exclusion */ 16492f9c5c4SLai Jiangshan struct list_head workers; /* A: attached workers */ 16560f5a4bcSLai Jiangshan struct completion *detach_completion; /* all workers detached */ 166e19e397aSTejun Heo 1677cda9aaeSLai Jiangshan struct ida worker_ida; /* worker IDs for task name */ 168e19e397aSTejun Heo 1697a4e344cSTejun Heo struct workqueue_attrs *attrs; /* I: worker attributes */ 17068e13a67SLai Jiangshan struct hlist_node hash_node; /* PL: unbound_pool_hash node */ 17168e13a67SLai Jiangshan int refcnt; /* PL: refcnt for unbound pools */ 1727a4e344cSTejun Heo 173e19e397aSTejun Heo /* 174e19e397aSTejun Heo * The current concurrency level. As it's likely to be accessed 175e19e397aSTejun Heo * from other CPUs during try_to_wake_up(), put it in a separate 176e19e397aSTejun Heo * cacheline. 177e19e397aSTejun Heo */ 178e19e397aSTejun Heo atomic_t nr_running ____cacheline_aligned_in_smp; 17929c91e99STejun Heo 18029c91e99STejun Heo /* 18129c91e99STejun Heo * Destruction of pool is sched-RCU protected to allow dereferences 18229c91e99STejun Heo * from get_work_pool(). 18329c91e99STejun Heo */ 18429c91e99STejun Heo struct rcu_head rcu; 1858b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1868b03ae3cSTejun Heo 1878b03ae3cSTejun Heo /* 188112202d9STejun Heo * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS 189112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 190112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 191112202d9STejun Heo * number of flag bits. 1921da177e4SLinus Torvalds */ 193112202d9STejun Heo struct pool_workqueue { 194bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 1954690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 19673f53c4aSTejun Heo int work_color; /* L: current color */ 19773f53c4aSTejun Heo int flush_color; /* L: flushing color */ 1988864b4e5STejun Heo int refcnt; /* L: reference count */ 19973f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 20073f53c4aSTejun Heo /* L: nr of in_flight works */ 2011e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 202a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 2031e19ffc6STejun Heo struct list_head delayed_works; /* L: delayed works */ 2043c25a55dSLai Jiangshan struct list_head pwqs_node; /* WR: node on wq->pwqs */ 2052e109a28STejun Heo struct list_head mayday_node; /* MD: node on wq->maydays */ 2068864b4e5STejun Heo 2078864b4e5STejun Heo /* 2088864b4e5STejun Heo * Release of unbound pwq is punted to system_wq. See put_pwq() 2098864b4e5STejun Heo * and pwq_unbound_release_workfn() for details. pool_workqueue 2108864b4e5STejun Heo * itself is also sched-RCU protected so that the first pwq can be 211b09f4fd3SLai Jiangshan * determined without grabbing wq->mutex. 2128864b4e5STejun Heo */ 2138864b4e5STejun Heo struct work_struct unbound_release_work; 2148864b4e5STejun Heo struct rcu_head rcu; 215e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS); 2161da177e4SLinus Torvalds 2171da177e4SLinus Torvalds /* 21873f53c4aSTejun Heo * Structure used to wait for workqueue flush. 21973f53c4aSTejun Heo */ 22073f53c4aSTejun Heo struct wq_flusher { 2213c25a55dSLai Jiangshan struct list_head list; /* WQ: list of flushers */ 2223c25a55dSLai Jiangshan int flush_color; /* WQ: flush color waiting for */ 22373f53c4aSTejun Heo struct completion done; /* flush completion */ 22473f53c4aSTejun Heo }; 2251da177e4SLinus Torvalds 226226223abSTejun Heo struct wq_device; 227226223abSTejun Heo 22873f53c4aSTejun Heo /* 229c5aa87bbSTejun Heo * The externally visible workqueue. It relays the issued work items to 230c5aa87bbSTejun Heo * the appropriate worker_pool through its pool_workqueues. 2311da177e4SLinus Torvalds */ 2321da177e4SLinus Torvalds struct workqueue_struct { 2333c25a55dSLai Jiangshan struct list_head pwqs; /* WR: all pwqs of this wq */ 234e2dca7adSTejun Heo struct list_head list; /* PR: list of all workqueues */ 23573f53c4aSTejun Heo 2363c25a55dSLai Jiangshan struct mutex mutex; /* protects this wq */ 2373c25a55dSLai Jiangshan int work_color; /* WQ: current work color */ 2383c25a55dSLai Jiangshan int flush_color; /* WQ: current flush color */ 239112202d9STejun Heo atomic_t nr_pwqs_to_flush; /* flush in progress */ 2403c25a55dSLai Jiangshan struct wq_flusher *first_flusher; /* WQ: first flusher */ 2413c25a55dSLai Jiangshan struct list_head flusher_queue; /* WQ: flush waiters */ 2423c25a55dSLai Jiangshan struct list_head flusher_overflow; /* WQ: flush overflow list */ 24373f53c4aSTejun Heo 2442e109a28STejun Heo struct list_head maydays; /* MD: pwqs requesting rescue */ 245e22bee78STejun Heo struct worker *rescuer; /* I: rescue worker */ 246e22bee78STejun Heo 24787fc741eSLai Jiangshan int nr_drainers; /* WQ: drain in progress */ 248a357fc03SLai Jiangshan int saved_max_active; /* WQ: saved pwq max_active */ 249226223abSTejun Heo 2506029a918STejun Heo struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */ 2514c16bd32STejun Heo struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */ 2526029a918STejun Heo 253226223abSTejun Heo #ifdef CONFIG_SYSFS 254226223abSTejun Heo struct wq_device *wq_dev; /* I: for sysfs interface */ 255226223abSTejun Heo #endif 2564e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 2574e6045f1SJohannes Berg struct lockdep_map lockdep_map; 2584e6045f1SJohannes Berg #endif 259ecf6881fSTejun Heo char name[WQ_NAME_LEN]; /* I: workqueue name */ 2602728fd2fSTejun Heo 261e2dca7adSTejun Heo /* 262e2dca7adSTejun Heo * Destruction of workqueue_struct is sched-RCU protected to allow 263e2dca7adSTejun Heo * walking the workqueues list without grabbing wq_pool_mutex. 264e2dca7adSTejun Heo * This is used to dump all workqueues from sysrq. 265e2dca7adSTejun Heo */ 266e2dca7adSTejun Heo struct rcu_head rcu; 267e2dca7adSTejun Heo 2682728fd2fSTejun Heo /* hot fields used during command issue, aligned to cacheline */ 2692728fd2fSTejun Heo unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ 2702728fd2fSTejun Heo struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */ 271df2d5ae4STejun Heo struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */ 2721da177e4SLinus Torvalds }; 2731da177e4SLinus Torvalds 274e904e6c2STejun Heo static struct kmem_cache *pwq_cache; 275e904e6c2STejun Heo 276bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask; 277bce90380STejun Heo /* possible CPUs of each node */ 278bce90380STejun Heo 279d55262c4STejun Heo static bool wq_disable_numa; 280d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444); 281d55262c4STejun Heo 282cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 283cee22a15SViresh Kumar #ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT 284cee22a15SViresh Kumar static bool wq_power_efficient = true; 285cee22a15SViresh Kumar #else 286cee22a15SViresh Kumar static bool wq_power_efficient; 287cee22a15SViresh Kumar #endif 288cee22a15SViresh Kumar 289cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444); 290cee22a15SViresh Kumar 291bce90380STejun Heo static bool wq_numa_enabled; /* unbound NUMA affinity enabled */ 292bce90380STejun Heo 2934c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */ 2944c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf; 2954c16bd32STejun Heo 29668e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ 2972e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ 2985bcab335STejun Heo 299e2dca7adSTejun Heo static LIST_HEAD(workqueues); /* PR: list of all workqueues */ 30068e13a67SLai Jiangshan static bool workqueue_freezing; /* PL: have wqs started freezing? */ 3017d19c5ceSTejun Heo 302*042f7df1SLai Jiangshan static cpumask_var_t wq_unbound_cpumask; /* PL: low level cpumask for all unbound wqs */ 303b05a7928SFrederic Weisbecker 3047d19c5ceSTejun Heo /* the per-cpu worker pools */ 3057d19c5ceSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], 3067d19c5ceSTejun Heo cpu_worker_pools); 3077d19c5ceSTejun Heo 30868e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ 3097d19c5ceSTejun Heo 31068e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */ 31129c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); 31229c91e99STejun Heo 313c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */ 31429c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; 31529c91e99STejun Heo 3168a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */ 3178a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS]; 3188a2b7538STejun Heo 319d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 320ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq); 321044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly; 3221aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 323044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly; 324d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 325044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly; 326f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 327044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly; 32824d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 3290668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly; 3300668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq); 3310668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly; 3320668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq); 333d320c038STejun Heo 3347d19c5ceSTejun Heo static int worker_thread(void *__worker); 3357d19c5ceSTejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 3367d19c5ceSTejun Heo const struct workqueue_attrs *from); 3376ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq); 3387d19c5ceSTejun Heo 33997bd2347STejun Heo #define CREATE_TRACE_POINTS 34097bd2347STejun Heo #include <trace/events/workqueue.h> 34197bd2347STejun Heo 34268e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex() \ 3435bcab335STejun Heo rcu_lockdep_assert(rcu_read_lock_sched_held() || \ 34468e13a67SLai Jiangshan lockdep_is_held(&wq_pool_mutex), \ 34568e13a67SLai Jiangshan "sched RCU or wq_pool_mutex should be held") 3465bcab335STejun Heo 347b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq) \ 34876af4d93STejun Heo rcu_lockdep_assert(rcu_read_lock_sched_held() || \ 349b5927605SLai Jiangshan lockdep_is_held(&wq->mutex), \ 350b09f4fd3SLai Jiangshan "sched RCU or wq->mutex should be held") 35176af4d93STejun Heo 352f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu) \ 353f02ae73aSTejun Heo for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ 354f02ae73aSTejun Heo (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 3557a62c2c8STejun Heo (pool)++) 3564ce62e9eSTejun Heo 35749e3cf44STejun Heo /** 35817116969STejun Heo * for_each_pool - iterate through all worker_pools in the system 35917116969STejun Heo * @pool: iteration cursor 360611c92a0STejun Heo * @pi: integer used for iteration 361fa1b54e6STejun Heo * 36268e13a67SLai Jiangshan * This must be called either with wq_pool_mutex held or sched RCU read 36368e13a67SLai Jiangshan * locked. If the pool needs to be used beyond the locking in effect, the 36468e13a67SLai Jiangshan * caller is responsible for guaranteeing that the pool stays online. 365fa1b54e6STejun Heo * 366fa1b54e6STejun Heo * The if/else clause exists only for the lockdep assertion and can be 367fa1b54e6STejun Heo * ignored. 36817116969STejun Heo */ 369611c92a0STejun Heo #define for_each_pool(pool, pi) \ 370611c92a0STejun Heo idr_for_each_entry(&worker_pool_idr, pool, pi) \ 37168e13a67SLai Jiangshan if (({ assert_rcu_or_pool_mutex(); false; })) { } \ 372fa1b54e6STejun Heo else 37317116969STejun Heo 37417116969STejun Heo /** 375822d8405STejun Heo * for_each_pool_worker - iterate through all workers of a worker_pool 376822d8405STejun Heo * @worker: iteration cursor 377822d8405STejun Heo * @pool: worker_pool to iterate workers of 378822d8405STejun Heo * 37992f9c5c4SLai Jiangshan * This must be called with @pool->attach_mutex. 380822d8405STejun Heo * 381822d8405STejun Heo * The if/else clause exists only for the lockdep assertion and can be 382822d8405STejun Heo * ignored. 383822d8405STejun Heo */ 384da028469SLai Jiangshan #define for_each_pool_worker(worker, pool) \ 385da028469SLai Jiangshan list_for_each_entry((worker), &(pool)->workers, node) \ 38692f9c5c4SLai Jiangshan if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \ 387822d8405STejun Heo else 388822d8405STejun Heo 389822d8405STejun Heo /** 39049e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 39149e3cf44STejun Heo * @pwq: iteration cursor 39249e3cf44STejun Heo * @wq: the target workqueue 39376af4d93STejun Heo * 394b09f4fd3SLai Jiangshan * This must be called either with wq->mutex held or sched RCU read locked. 395794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 396794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 39776af4d93STejun Heo * 39876af4d93STejun Heo * The if/else clause exists only for the lockdep assertion and can be 39976af4d93STejun Heo * ignored. 40049e3cf44STejun Heo */ 40149e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 40276af4d93STejun Heo list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \ 403b09f4fd3SLai Jiangshan if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \ 40476af4d93STejun Heo else 405f3421797STejun Heo 406dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 407dc186ad7SThomas Gleixner 408dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr; 409dc186ad7SThomas Gleixner 41099777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 41199777288SStanislaw Gruszka { 41299777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 41399777288SStanislaw Gruszka } 41499777288SStanislaw Gruszka 415dc186ad7SThomas Gleixner /* 416dc186ad7SThomas Gleixner * fixup_init is called when: 417dc186ad7SThomas Gleixner * - an active object is initialized 418dc186ad7SThomas Gleixner */ 419dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state) 420dc186ad7SThomas Gleixner { 421dc186ad7SThomas Gleixner struct work_struct *work = addr; 422dc186ad7SThomas Gleixner 423dc186ad7SThomas Gleixner switch (state) { 424dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 425dc186ad7SThomas Gleixner cancel_work_sync(work); 426dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 427dc186ad7SThomas Gleixner return 1; 428dc186ad7SThomas Gleixner default: 429dc186ad7SThomas Gleixner return 0; 430dc186ad7SThomas Gleixner } 431dc186ad7SThomas Gleixner } 432dc186ad7SThomas Gleixner 433dc186ad7SThomas Gleixner /* 434dc186ad7SThomas Gleixner * fixup_activate is called when: 435dc186ad7SThomas Gleixner * - an active object is activated 436dc186ad7SThomas Gleixner * - an unknown object is activated (might be a statically initialized object) 437dc186ad7SThomas Gleixner */ 438dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state) 439dc186ad7SThomas Gleixner { 440dc186ad7SThomas Gleixner struct work_struct *work = addr; 441dc186ad7SThomas Gleixner 442dc186ad7SThomas Gleixner switch (state) { 443dc186ad7SThomas Gleixner 444dc186ad7SThomas Gleixner case ODEBUG_STATE_NOTAVAILABLE: 445dc186ad7SThomas Gleixner /* 446dc186ad7SThomas Gleixner * This is not really a fixup. The work struct was 447dc186ad7SThomas Gleixner * statically initialized. We just make sure that it 448dc186ad7SThomas Gleixner * is tracked in the object tracker. 449dc186ad7SThomas Gleixner */ 45022df02bbSTejun Heo if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) { 451dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 452dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 453dc186ad7SThomas Gleixner return 0; 454dc186ad7SThomas Gleixner } 455dc186ad7SThomas Gleixner WARN_ON_ONCE(1); 456dc186ad7SThomas Gleixner return 0; 457dc186ad7SThomas Gleixner 458dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 459dc186ad7SThomas Gleixner WARN_ON(1); 460dc186ad7SThomas Gleixner 461dc186ad7SThomas Gleixner default: 462dc186ad7SThomas Gleixner return 0; 463dc186ad7SThomas Gleixner } 464dc186ad7SThomas Gleixner } 465dc186ad7SThomas Gleixner 466dc186ad7SThomas Gleixner /* 467dc186ad7SThomas Gleixner * fixup_free is called when: 468dc186ad7SThomas Gleixner * - an active object is freed 469dc186ad7SThomas Gleixner */ 470dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state) 471dc186ad7SThomas Gleixner { 472dc186ad7SThomas Gleixner struct work_struct *work = addr; 473dc186ad7SThomas Gleixner 474dc186ad7SThomas Gleixner switch (state) { 475dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 476dc186ad7SThomas Gleixner cancel_work_sync(work); 477dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 478dc186ad7SThomas Gleixner return 1; 479dc186ad7SThomas Gleixner default: 480dc186ad7SThomas Gleixner return 0; 481dc186ad7SThomas Gleixner } 482dc186ad7SThomas Gleixner } 483dc186ad7SThomas Gleixner 484dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = { 485dc186ad7SThomas Gleixner .name = "work_struct", 48699777288SStanislaw Gruszka .debug_hint = work_debug_hint, 487dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 488dc186ad7SThomas Gleixner .fixup_activate = work_fixup_activate, 489dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 490dc186ad7SThomas Gleixner }; 491dc186ad7SThomas Gleixner 492dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 493dc186ad7SThomas Gleixner { 494dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 495dc186ad7SThomas Gleixner } 496dc186ad7SThomas Gleixner 497dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 498dc186ad7SThomas Gleixner { 499dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 500dc186ad7SThomas Gleixner } 501dc186ad7SThomas Gleixner 502dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 503dc186ad7SThomas Gleixner { 504dc186ad7SThomas Gleixner if (onstack) 505dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 506dc186ad7SThomas Gleixner else 507dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 508dc186ad7SThomas Gleixner } 509dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 510dc186ad7SThomas Gleixner 511dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 512dc186ad7SThomas Gleixner { 513dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 514dc186ad7SThomas Gleixner } 515dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 516dc186ad7SThomas Gleixner 517ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work) 518ea2e64f2SThomas Gleixner { 519ea2e64f2SThomas Gleixner destroy_timer_on_stack(&work->timer); 520ea2e64f2SThomas Gleixner debug_object_free(&work->work, &work_debug_descr); 521ea2e64f2SThomas Gleixner } 522ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack); 523ea2e64f2SThomas Gleixner 524dc186ad7SThomas Gleixner #else 525dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 526dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 527dc186ad7SThomas Gleixner #endif 528dc186ad7SThomas Gleixner 5294e8b22bdSLi Bin /** 5304e8b22bdSLi Bin * worker_pool_assign_id - allocate ID and assing it to @pool 5314e8b22bdSLi Bin * @pool: the pool pointer of interest 5324e8b22bdSLi Bin * 5334e8b22bdSLi Bin * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned 5344e8b22bdSLi Bin * successfully, -errno on failure. 5354e8b22bdSLi Bin */ 5369daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 5379daf9e67STejun Heo { 5389daf9e67STejun Heo int ret; 5399daf9e67STejun Heo 54068e13a67SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5415bcab335STejun Heo 5424e8b22bdSLi Bin ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE, 5434e8b22bdSLi Bin GFP_KERNEL); 544229641a6STejun Heo if (ret >= 0) { 545e68035fbSTejun Heo pool->id = ret; 546229641a6STejun Heo return 0; 547229641a6STejun Heo } 5489daf9e67STejun Heo return ret; 5499daf9e67STejun Heo } 5509daf9e67STejun Heo 55176af4d93STejun Heo /** 552df2d5ae4STejun Heo * unbound_pwq_by_node - return the unbound pool_workqueue for the given node 553df2d5ae4STejun Heo * @wq: the target workqueue 554df2d5ae4STejun Heo * @node: the node ID 555df2d5ae4STejun Heo * 556df2d5ae4STejun Heo * This must be called either with pwq_lock held or sched RCU read locked. 557df2d5ae4STejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 558df2d5ae4STejun Heo * responsible for guaranteeing that the pwq stays online. 559d185af30SYacine Belkadi * 560d185af30SYacine Belkadi * Return: The unbound pool_workqueue for @node. 561df2d5ae4STejun Heo */ 562df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq, 563df2d5ae4STejun Heo int node) 564df2d5ae4STejun Heo { 565df2d5ae4STejun Heo assert_rcu_or_wq_mutex(wq); 566df2d5ae4STejun Heo return rcu_dereference_raw(wq->numa_pwq_tbl[node]); 567df2d5ae4STejun Heo } 568df2d5ae4STejun Heo 56973f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 57073f53c4aSTejun Heo { 57173f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 57273f53c4aSTejun Heo } 57373f53c4aSTejun Heo 57473f53c4aSTejun Heo static int get_work_color(struct work_struct *work) 57573f53c4aSTejun Heo { 57673f53c4aSTejun Heo return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & 57773f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 57873f53c4aSTejun Heo } 57973f53c4aSTejun Heo 58073f53c4aSTejun Heo static int work_next_color(int color) 58173f53c4aSTejun Heo { 58273f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 583a848e3b6SOleg Nesterov } 584a848e3b6SOleg Nesterov 5854594bf15SDavid Howells /* 586112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 587112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 5887c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 5897a22ad75STejun Heo * 590112202d9STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 591112202d9STejun Heo * and clear_work_data() can be used to set the pwq, pool or clear 592bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 593bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 5947a22ad75STejun Heo * 595112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 5967c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 597112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 5987c3eed5cSTejun Heo * available only while the work item is queued. 599bbb68dfaSTejun Heo * 600bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 601bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 602bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 603bbb68dfaSTejun Heo * try to steal the PENDING bit. 6044594bf15SDavid Howells */ 6057a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 6067a22ad75STejun Heo unsigned long flags) 6077a22ad75STejun Heo { 6086183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 6097a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 6107a22ad75STejun Heo } 6117a22ad75STejun Heo 612112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 6134690c4abSTejun Heo unsigned long extra_flags) 614365970a1SDavid Howells { 615112202d9STejun Heo set_work_data(work, (unsigned long)pwq, 616112202d9STejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); 617365970a1SDavid Howells } 618365970a1SDavid Howells 6194468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 6204468a00fSLai Jiangshan int pool_id) 6214468a00fSLai Jiangshan { 6224468a00fSLai Jiangshan set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 6234468a00fSLai Jiangshan WORK_STRUCT_PENDING); 6244468a00fSLai Jiangshan } 6254468a00fSLai Jiangshan 6267c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 6277c3eed5cSTejun Heo int pool_id) 6284d707b9fSOleg Nesterov { 62923657bb1STejun Heo /* 63023657bb1STejun Heo * The following wmb is paired with the implied mb in 63123657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 63223657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 63323657bb1STejun Heo * owner. 63423657bb1STejun Heo */ 63523657bb1STejun Heo smp_wmb(); 6367c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 6374d707b9fSOleg Nesterov } 6384d707b9fSOleg Nesterov 6397a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 640365970a1SDavid Howells { 6417c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 6427c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 6437a22ad75STejun Heo } 6447a22ad75STejun Heo 645112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 6467a22ad75STejun Heo { 647e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 6487a22ad75STejun Heo 649112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 650e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 651e120153dSTejun Heo else 652e120153dSTejun Heo return NULL; 6537a22ad75STejun Heo } 6547a22ad75STejun Heo 6557c3eed5cSTejun Heo /** 6567c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 6577c3eed5cSTejun Heo * @work: the work item of interest 6587c3eed5cSTejun Heo * 65968e13a67SLai Jiangshan * Pools are created and destroyed under wq_pool_mutex, and allows read 66068e13a67SLai Jiangshan * access under sched-RCU read lock. As such, this function should be 66168e13a67SLai Jiangshan * called under wq_pool_mutex or with preemption disabled. 662fa1b54e6STejun Heo * 663fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 664fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 665fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 666fa1b54e6STejun Heo * returned pool is and stays online. 667d185af30SYacine Belkadi * 668d185af30SYacine Belkadi * Return: The worker_pool @work was last associated with. %NULL if none. 6697c3eed5cSTejun Heo */ 6707c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 6717a22ad75STejun Heo { 672e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 6737c3eed5cSTejun Heo int pool_id; 6747a22ad75STejun Heo 67568e13a67SLai Jiangshan assert_rcu_or_pool_mutex(); 676fa1b54e6STejun Heo 677112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 678112202d9STejun Heo return ((struct pool_workqueue *) 6797c3eed5cSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->pool; 6807a22ad75STejun Heo 6817c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 6827c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 6837a22ad75STejun Heo return NULL; 6847a22ad75STejun Heo 685fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 6867c3eed5cSTejun Heo } 6877c3eed5cSTejun Heo 6887c3eed5cSTejun Heo /** 6897c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 6907c3eed5cSTejun Heo * @work: the work item of interest 6917c3eed5cSTejun Heo * 692d185af30SYacine Belkadi * Return: The worker_pool ID @work was last associated with. 6937c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 6947c3eed5cSTejun Heo */ 6957c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 6967c3eed5cSTejun Heo { 69754d5b7d0SLai Jiangshan unsigned long data = atomic_long_read(&work->data); 6987c3eed5cSTejun Heo 699112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 700112202d9STejun Heo return ((struct pool_workqueue *) 70154d5b7d0SLai Jiangshan (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id; 70254d5b7d0SLai Jiangshan 70354d5b7d0SLai Jiangshan return data >> WORK_OFFQ_POOL_SHIFT; 7047c3eed5cSTejun Heo } 7057c3eed5cSTejun Heo 706bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 707bbb68dfaSTejun Heo { 7087c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 709bbb68dfaSTejun Heo 7107c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 7117c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 712bbb68dfaSTejun Heo } 713bbb68dfaSTejun Heo 714bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 715bbb68dfaSTejun Heo { 716bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 717bbb68dfaSTejun Heo 718112202d9STejun Heo return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); 719bbb68dfaSTejun Heo } 720bbb68dfaSTejun Heo 721e22bee78STejun Heo /* 7223270476aSTejun Heo * Policy functions. These define the policies on how the global worker 7233270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 724d565ed63STejun Heo * they're being called with pool->lock held. 725e22bee78STejun Heo */ 726e22bee78STejun Heo 72763d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool) 728649027d7STejun Heo { 729e19e397aSTejun Heo return !atomic_read(&pool->nr_running); 730649027d7STejun Heo } 731649027d7STejun Heo 732e22bee78STejun Heo /* 733e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 734e22bee78STejun Heo * running workers. 735974271c4STejun Heo * 736974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 737706026c2STejun Heo * function will always return %true for unbound pools as long as the 738974271c4STejun Heo * worklist isn't empty. 739e22bee78STejun Heo */ 74063d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 741e22bee78STejun Heo { 74263d95a91STejun Heo return !list_empty(&pool->worklist) && __need_more_worker(pool); 743e22bee78STejun Heo } 744e22bee78STejun Heo 745e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 74663d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 747e22bee78STejun Heo { 74863d95a91STejun Heo return pool->nr_idle; 749e22bee78STejun Heo } 750e22bee78STejun Heo 751e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 75263d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 753e22bee78STejun Heo { 754e19e397aSTejun Heo return !list_empty(&pool->worklist) && 755e19e397aSTejun Heo atomic_read(&pool->nr_running) <= 1; 756e22bee78STejun Heo } 757e22bee78STejun Heo 758e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 75963d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 760e22bee78STejun Heo { 76163d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 762e22bee78STejun Heo } 763e22bee78STejun Heo 764e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 76563d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 766e22bee78STejun Heo { 76734a06bd6STejun Heo bool managing = mutex_is_locked(&pool->manager_arb); 76863d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 76963d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 770e22bee78STejun Heo 771e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 772e22bee78STejun Heo } 773e22bee78STejun Heo 774e22bee78STejun Heo /* 775e22bee78STejun Heo * Wake up functions. 776e22bee78STejun Heo */ 777e22bee78STejun Heo 7781037de36SLai Jiangshan /* Return the first idle worker. Safe with preemption disabled */ 7791037de36SLai Jiangshan static struct worker *first_idle_worker(struct worker_pool *pool) 7807e11629dSTejun Heo { 78163d95a91STejun Heo if (unlikely(list_empty(&pool->idle_list))) 7827e11629dSTejun Heo return NULL; 7837e11629dSTejun Heo 78463d95a91STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 7857e11629dSTejun Heo } 7867e11629dSTejun Heo 7877e11629dSTejun Heo /** 7887e11629dSTejun Heo * wake_up_worker - wake up an idle worker 78963d95a91STejun Heo * @pool: worker pool to wake worker from 7907e11629dSTejun Heo * 79163d95a91STejun Heo * Wake up the first idle worker of @pool. 7927e11629dSTejun Heo * 7937e11629dSTejun Heo * CONTEXT: 794d565ed63STejun Heo * spin_lock_irq(pool->lock). 7957e11629dSTejun Heo */ 79663d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool) 7977e11629dSTejun Heo { 7981037de36SLai Jiangshan struct worker *worker = first_idle_worker(pool); 7997e11629dSTejun Heo 8007e11629dSTejun Heo if (likely(worker)) 8017e11629dSTejun Heo wake_up_process(worker->task); 8027e11629dSTejun Heo } 8037e11629dSTejun Heo 8044690c4abSTejun Heo /** 805e22bee78STejun Heo * wq_worker_waking_up - a worker is waking up 806e22bee78STejun Heo * @task: task waking up 807e22bee78STejun Heo * @cpu: CPU @task is waking up to 808e22bee78STejun Heo * 809e22bee78STejun Heo * This function is called during try_to_wake_up() when a worker is 810e22bee78STejun Heo * being awoken. 811e22bee78STejun Heo * 812e22bee78STejun Heo * CONTEXT: 813e22bee78STejun Heo * spin_lock_irq(rq->lock) 814e22bee78STejun Heo */ 815d84ff051STejun Heo void wq_worker_waking_up(struct task_struct *task, int cpu) 816e22bee78STejun Heo { 817e22bee78STejun Heo struct worker *worker = kthread_data(task); 818e22bee78STejun Heo 81936576000SJoonsoo Kim if (!(worker->flags & WORKER_NOT_RUNNING)) { 820ec22ca5eSTejun Heo WARN_ON_ONCE(worker->pool->cpu != cpu); 821e19e397aSTejun Heo atomic_inc(&worker->pool->nr_running); 822e22bee78STejun Heo } 82336576000SJoonsoo Kim } 824e22bee78STejun Heo 825e22bee78STejun Heo /** 826e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 827e22bee78STejun Heo * @task: task going to sleep 828e22bee78STejun Heo * @cpu: CPU in question, must be the current CPU number 829e22bee78STejun Heo * 830e22bee78STejun Heo * This function is called during schedule() when a busy worker is 831e22bee78STejun Heo * going to sleep. Worker on the same cpu can be woken up by 832e22bee78STejun Heo * returning pointer to its task. 833e22bee78STejun Heo * 834e22bee78STejun Heo * CONTEXT: 835e22bee78STejun Heo * spin_lock_irq(rq->lock) 836e22bee78STejun Heo * 837d185af30SYacine Belkadi * Return: 838e22bee78STejun Heo * Worker task on @cpu to wake up, %NULL if none. 839e22bee78STejun Heo */ 840d84ff051STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu) 841e22bee78STejun Heo { 842e22bee78STejun Heo struct worker *worker = kthread_data(task), *to_wakeup = NULL; 843111c225aSTejun Heo struct worker_pool *pool; 844e22bee78STejun Heo 845111c225aSTejun Heo /* 846111c225aSTejun Heo * Rescuers, which may not have all the fields set up like normal 847111c225aSTejun Heo * workers, also reach here, let's not access anything before 848111c225aSTejun Heo * checking NOT_RUNNING. 849111c225aSTejun Heo */ 8502d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 851e22bee78STejun Heo return NULL; 852e22bee78STejun Heo 853111c225aSTejun Heo pool = worker->pool; 854111c225aSTejun Heo 855e22bee78STejun Heo /* this can only happen on the local cpu */ 85692b69f50SLai Jiangshan if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu)) 8576183c009STejun Heo return NULL; 858e22bee78STejun Heo 859e22bee78STejun Heo /* 860e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 861e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 862e22bee78STejun Heo * Please read comment there. 863e22bee78STejun Heo * 864628c78e7STejun Heo * NOT_RUNNING is clear. This means that we're bound to and 865628c78e7STejun Heo * running on the local cpu w/ rq lock held and preemption 866628c78e7STejun Heo * disabled, which in turn means that none else could be 867d565ed63STejun Heo * manipulating idle_list, so dereferencing idle_list without pool 868628c78e7STejun Heo * lock is safe. 869e22bee78STejun Heo */ 870e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 871e19e397aSTejun Heo !list_empty(&pool->worklist)) 8721037de36SLai Jiangshan to_wakeup = first_idle_worker(pool); 873e22bee78STejun Heo return to_wakeup ? to_wakeup->task : NULL; 874e22bee78STejun Heo } 875e22bee78STejun Heo 876e22bee78STejun Heo /** 877e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 878cb444766STejun Heo * @worker: self 879d302f017STejun Heo * @flags: flags to set 880d302f017STejun Heo * 881228f1d00SLai Jiangshan * Set @flags in @worker->flags and adjust nr_running accordingly. 882d302f017STejun Heo * 883cb444766STejun Heo * CONTEXT: 884d565ed63STejun Heo * spin_lock_irq(pool->lock) 885d302f017STejun Heo */ 886228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags) 887d302f017STejun Heo { 888bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 889e22bee78STejun Heo 890cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 891cb444766STejun Heo 892228f1d00SLai Jiangshan /* If transitioning into NOT_RUNNING, adjust nr_running. */ 893e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 894e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 895e19e397aSTejun Heo atomic_dec(&pool->nr_running); 896e22bee78STejun Heo } 897e22bee78STejun Heo 898d302f017STejun Heo worker->flags |= flags; 899d302f017STejun Heo } 900d302f017STejun Heo 901d302f017STejun Heo /** 902e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 903cb444766STejun Heo * @worker: self 904d302f017STejun Heo * @flags: flags to clear 905d302f017STejun Heo * 906e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 907d302f017STejun Heo * 908cb444766STejun Heo * CONTEXT: 909d565ed63STejun Heo * spin_lock_irq(pool->lock) 910d302f017STejun Heo */ 911d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 912d302f017STejun Heo { 91363d95a91STejun Heo struct worker_pool *pool = worker->pool; 914e22bee78STejun Heo unsigned int oflags = worker->flags; 915e22bee78STejun Heo 916cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 917cb444766STejun Heo 918d302f017STejun Heo worker->flags &= ~flags; 919e22bee78STejun Heo 92042c025f3STejun Heo /* 92142c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 92242c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 92342c025f3STejun Heo * of multiple flags, not a single flag. 92442c025f3STejun Heo */ 925e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 926e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 927e19e397aSTejun Heo atomic_inc(&pool->nr_running); 928d302f017STejun Heo } 929d302f017STejun Heo 930d302f017STejun Heo /** 9318cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 932c9e7cf27STejun Heo * @pool: pool of interest 9338cca0eeaSTejun Heo * @work: work to find worker for 9348cca0eeaSTejun Heo * 935c9e7cf27STejun Heo * Find a worker which is executing @work on @pool by searching 936c9e7cf27STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 937a2c1c57bSTejun Heo * to match, its current execution should match the address of @work and 938a2c1c57bSTejun Heo * its work function. This is to avoid unwanted dependency between 939a2c1c57bSTejun Heo * unrelated work executions through a work item being recycled while still 940a2c1c57bSTejun Heo * being executed. 941a2c1c57bSTejun Heo * 942a2c1c57bSTejun Heo * This is a bit tricky. A work item may be freed once its execution 943a2c1c57bSTejun Heo * starts and nothing prevents the freed area from being recycled for 944a2c1c57bSTejun Heo * another work item. If the same work item address ends up being reused 945a2c1c57bSTejun Heo * before the original execution finishes, workqueue will identify the 946a2c1c57bSTejun Heo * recycled work item as currently executing and make it wait until the 947a2c1c57bSTejun Heo * current execution finishes, introducing an unwanted dependency. 948a2c1c57bSTejun Heo * 949c5aa87bbSTejun Heo * This function checks the work item address and work function to avoid 950c5aa87bbSTejun Heo * false positives. Note that this isn't complete as one may construct a 951c5aa87bbSTejun Heo * work function which can introduce dependency onto itself through a 952c5aa87bbSTejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 953c5aa87bbSTejun Heo * foot that badly, there's only so much we can do, and if such deadlock 954c5aa87bbSTejun Heo * actually occurs, it should be easy to locate the culprit work function. 9558cca0eeaSTejun Heo * 9568cca0eeaSTejun Heo * CONTEXT: 957d565ed63STejun Heo * spin_lock_irq(pool->lock). 9588cca0eeaSTejun Heo * 959d185af30SYacine Belkadi * Return: 960d185af30SYacine Belkadi * Pointer to worker which is executing @work if found, %NULL 9618cca0eeaSTejun Heo * otherwise. 9628cca0eeaSTejun Heo */ 963c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 9648cca0eeaSTejun Heo struct work_struct *work) 9658cca0eeaSTejun Heo { 96642f8570fSSasha Levin struct worker *worker; 96742f8570fSSasha Levin 968b67bfe0dSSasha Levin hash_for_each_possible(pool->busy_hash, worker, hentry, 969a2c1c57bSTejun Heo (unsigned long)work) 970a2c1c57bSTejun Heo if (worker->current_work == work && 971a2c1c57bSTejun Heo worker->current_func == work->func) 97242f8570fSSasha Levin return worker; 97342f8570fSSasha Levin 97442f8570fSSasha Levin return NULL; 9758cca0eeaSTejun Heo } 9768cca0eeaSTejun Heo 9778cca0eeaSTejun Heo /** 978bf4ede01STejun Heo * move_linked_works - move linked works to a list 979bf4ede01STejun Heo * @work: start of series of works to be scheduled 980bf4ede01STejun Heo * @head: target list to append @work to 981bf4ede01STejun Heo * @nextp: out paramter for nested worklist walking 982bf4ede01STejun Heo * 983bf4ede01STejun Heo * Schedule linked works starting from @work to @head. Work series to 984bf4ede01STejun Heo * be scheduled starts at @work and includes any consecutive work with 985bf4ede01STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 986bf4ede01STejun Heo * 987bf4ede01STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 988bf4ede01STejun Heo * the last scheduled work. This allows move_linked_works() to be 989bf4ede01STejun Heo * nested inside outer list_for_each_entry_safe(). 990bf4ede01STejun Heo * 991bf4ede01STejun Heo * CONTEXT: 992d565ed63STejun Heo * spin_lock_irq(pool->lock). 993bf4ede01STejun Heo */ 994bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 995bf4ede01STejun Heo struct work_struct **nextp) 996bf4ede01STejun Heo { 997bf4ede01STejun Heo struct work_struct *n; 998bf4ede01STejun Heo 999bf4ede01STejun Heo /* 1000bf4ede01STejun Heo * Linked worklist will always end before the end of the list, 1001bf4ede01STejun Heo * use NULL for list head. 1002bf4ede01STejun Heo */ 1003bf4ede01STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1004bf4ede01STejun Heo list_move_tail(&work->entry, head); 1005bf4ede01STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1006bf4ede01STejun Heo break; 1007bf4ede01STejun Heo } 1008bf4ede01STejun Heo 1009bf4ede01STejun Heo /* 1010bf4ede01STejun Heo * If we're already inside safe list traversal and have moved 1011bf4ede01STejun Heo * multiple works to the scheduled queue, the next position 1012bf4ede01STejun Heo * needs to be updated. 1013bf4ede01STejun Heo */ 1014bf4ede01STejun Heo if (nextp) 1015bf4ede01STejun Heo *nextp = n; 1016bf4ede01STejun Heo } 1017bf4ede01STejun Heo 10188864b4e5STejun Heo /** 10198864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 10208864b4e5STejun Heo * @pwq: pool_workqueue to get 10218864b4e5STejun Heo * 10228864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 10238864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 10248864b4e5STejun Heo */ 10258864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 10268864b4e5STejun Heo { 10278864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 10288864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 10298864b4e5STejun Heo pwq->refcnt++; 10308864b4e5STejun Heo } 10318864b4e5STejun Heo 10328864b4e5STejun Heo /** 10338864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 10348864b4e5STejun Heo * @pwq: pool_workqueue to put 10358864b4e5STejun Heo * 10368864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 10378864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 10388864b4e5STejun Heo */ 10398864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 10408864b4e5STejun Heo { 10418864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 10428864b4e5STejun Heo if (likely(--pwq->refcnt)) 10438864b4e5STejun Heo return; 10448864b4e5STejun Heo if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND))) 10458864b4e5STejun Heo return; 10468864b4e5STejun Heo /* 10478864b4e5STejun Heo * @pwq can't be released under pool->lock, bounce to 10488864b4e5STejun Heo * pwq_unbound_release_workfn(). This never recurses on the same 10498864b4e5STejun Heo * pool->lock as this path is taken only for unbound workqueues and 10508864b4e5STejun Heo * the release work item is scheduled on a per-cpu workqueue. To 10518864b4e5STejun Heo * avoid lockdep warning, unbound pool->locks are given lockdep 10528864b4e5STejun Heo * subclass of 1 in get_unbound_pool(). 10538864b4e5STejun Heo */ 10548864b4e5STejun Heo schedule_work(&pwq->unbound_release_work); 10558864b4e5STejun Heo } 10568864b4e5STejun Heo 1057dce90d47STejun Heo /** 1058dce90d47STejun Heo * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock 1059dce90d47STejun Heo * @pwq: pool_workqueue to put (can be %NULL) 1060dce90d47STejun Heo * 1061dce90d47STejun Heo * put_pwq() with locking. This function also allows %NULL @pwq. 1062dce90d47STejun Heo */ 1063dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq) 1064dce90d47STejun Heo { 1065dce90d47STejun Heo if (pwq) { 1066dce90d47STejun Heo /* 1067dce90d47STejun Heo * As both pwqs and pools are sched-RCU protected, the 1068dce90d47STejun Heo * following lock operations are safe. 1069dce90d47STejun Heo */ 1070dce90d47STejun Heo spin_lock_irq(&pwq->pool->lock); 1071dce90d47STejun Heo put_pwq(pwq); 1072dce90d47STejun Heo spin_unlock_irq(&pwq->pool->lock); 1073dce90d47STejun Heo } 1074dce90d47STejun Heo } 1075dce90d47STejun Heo 1076112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work) 1077bf4ede01STejun Heo { 1078112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1079bf4ede01STejun Heo 1080bf4ede01STejun Heo trace_workqueue_activate_work(work); 1081112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 1082bf4ede01STejun Heo __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); 1083112202d9STejun Heo pwq->nr_active++; 1084bf4ede01STejun Heo } 1085bf4ede01STejun Heo 1086112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq) 10873aa62497SLai Jiangshan { 1088112202d9STejun Heo struct work_struct *work = list_first_entry(&pwq->delayed_works, 10893aa62497SLai Jiangshan struct work_struct, entry); 10903aa62497SLai Jiangshan 1091112202d9STejun Heo pwq_activate_delayed_work(work); 10923aa62497SLai Jiangshan } 10933aa62497SLai Jiangshan 1094bf4ede01STejun Heo /** 1095112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1096112202d9STejun Heo * @pwq: pwq of interest 1097bf4ede01STejun Heo * @color: color of work which left the queue 1098bf4ede01STejun Heo * 1099bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1100112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1101bf4ede01STejun Heo * 1102bf4ede01STejun Heo * CONTEXT: 1103d565ed63STejun Heo * spin_lock_irq(pool->lock). 1104bf4ede01STejun Heo */ 1105112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color) 1106bf4ede01STejun Heo { 11078864b4e5STejun Heo /* uncolored work items don't participate in flushing or nr_active */ 1108bf4ede01STejun Heo if (color == WORK_NO_COLOR) 11098864b4e5STejun Heo goto out_put; 1110bf4ede01STejun Heo 1111112202d9STejun Heo pwq->nr_in_flight[color]--; 1112bf4ede01STejun Heo 1113112202d9STejun Heo pwq->nr_active--; 1114112202d9STejun Heo if (!list_empty(&pwq->delayed_works)) { 1115bf4ede01STejun Heo /* one down, submit a delayed one */ 1116112202d9STejun Heo if (pwq->nr_active < pwq->max_active) 1117112202d9STejun Heo pwq_activate_first_delayed(pwq); 1118bf4ede01STejun Heo } 1119bf4ede01STejun Heo 1120bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1121112202d9STejun Heo if (likely(pwq->flush_color != color)) 11228864b4e5STejun Heo goto out_put; 1123bf4ede01STejun Heo 1124bf4ede01STejun Heo /* are there still in-flight works? */ 1125112202d9STejun Heo if (pwq->nr_in_flight[color]) 11268864b4e5STejun Heo goto out_put; 1127bf4ede01STejun Heo 1128112202d9STejun Heo /* this pwq is done, clear flush_color */ 1129112202d9STejun Heo pwq->flush_color = -1; 1130bf4ede01STejun Heo 1131bf4ede01STejun Heo /* 1132112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 1133bf4ede01STejun Heo * will handle the rest. 1134bf4ede01STejun Heo */ 1135112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 1136112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 11378864b4e5STejun Heo out_put: 11388864b4e5STejun Heo put_pwq(pwq); 1139bf4ede01STejun Heo } 1140bf4ede01STejun Heo 114136e227d2STejun Heo /** 1142bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 114336e227d2STejun Heo * @work: work item to steal 114436e227d2STejun Heo * @is_dwork: @work is a delayed_work 1145bbb68dfaSTejun Heo * @flags: place to store irq state 114636e227d2STejun Heo * 114736e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 1148d185af30SYacine Belkadi * stable state - idle, on timer or on worklist. 114936e227d2STejun Heo * 1150d185af30SYacine Belkadi * Return: 115136e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 115236e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 115336e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1154bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1155bbb68dfaSTejun Heo * for arbitrarily long 115636e227d2STejun Heo * 1157d185af30SYacine Belkadi * Note: 1158bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1159e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1160e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1161e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1162bbb68dfaSTejun Heo * 1163bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1164bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1165bbb68dfaSTejun Heo * 1166e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1167bf4ede01STejun Heo */ 1168bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1169bbb68dfaSTejun Heo unsigned long *flags) 1170bf4ede01STejun Heo { 1171d565ed63STejun Heo struct worker_pool *pool; 1172112202d9STejun Heo struct pool_workqueue *pwq; 1173bf4ede01STejun Heo 1174bbb68dfaSTejun Heo local_irq_save(*flags); 1175bbb68dfaSTejun Heo 117636e227d2STejun Heo /* try to steal the timer if it exists */ 117736e227d2STejun Heo if (is_dwork) { 117836e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 117936e227d2STejun Heo 1180e0aecdd8STejun Heo /* 1181e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1182e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1183e0aecdd8STejun Heo * running on the local CPU. 1184e0aecdd8STejun Heo */ 118536e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 118636e227d2STejun Heo return 1; 118736e227d2STejun Heo } 118836e227d2STejun Heo 118936e227d2STejun Heo /* try to claim PENDING the normal way */ 1190bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1191bf4ede01STejun Heo return 0; 1192bf4ede01STejun Heo 1193bf4ede01STejun Heo /* 1194bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1195bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1196bf4ede01STejun Heo */ 1197d565ed63STejun Heo pool = get_work_pool(work); 1198d565ed63STejun Heo if (!pool) 1199bbb68dfaSTejun Heo goto fail; 1200bf4ede01STejun Heo 1201d565ed63STejun Heo spin_lock(&pool->lock); 1202bf4ede01STejun Heo /* 1203112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 1204112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 1205112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 1206112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 1207112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 12080b3dae68SLai Jiangshan * item is currently queued on that pool. 1209bf4ede01STejun Heo */ 1210112202d9STejun Heo pwq = get_work_pwq(work); 1211112202d9STejun Heo if (pwq && pwq->pool == pool) { 1212bf4ede01STejun Heo debug_work_deactivate(work); 12133aa62497SLai Jiangshan 12143aa62497SLai Jiangshan /* 121516062836STejun Heo * A delayed work item cannot be grabbed directly because 121616062836STejun Heo * it might have linked NO_COLOR work items which, if left 1217112202d9STejun Heo * on the delayed_list, will confuse pwq->nr_active 121816062836STejun Heo * management later on and cause stall. Make sure the work 121916062836STejun Heo * item is activated before grabbing. 12203aa62497SLai Jiangshan */ 12213aa62497SLai Jiangshan if (*work_data_bits(work) & WORK_STRUCT_DELAYED) 1222112202d9STejun Heo pwq_activate_delayed_work(work); 12233aa62497SLai Jiangshan 1224bf4ede01STejun Heo list_del_init(&work->entry); 12259c34a704SLai Jiangshan pwq_dec_nr_in_flight(pwq, get_work_color(work)); 122636e227d2STejun Heo 1227112202d9STejun Heo /* work->data points to pwq iff queued, point to pool */ 12284468a00fSLai Jiangshan set_work_pool_and_keep_pending(work, pool->id); 12294468a00fSLai Jiangshan 1230d565ed63STejun Heo spin_unlock(&pool->lock); 123136e227d2STejun Heo return 1; 1232bf4ede01STejun Heo } 1233d565ed63STejun Heo spin_unlock(&pool->lock); 1234bbb68dfaSTejun Heo fail: 1235bbb68dfaSTejun Heo local_irq_restore(*flags); 1236bbb68dfaSTejun Heo if (work_is_canceling(work)) 1237bbb68dfaSTejun Heo return -ENOENT; 1238bbb68dfaSTejun Heo cpu_relax(); 123936e227d2STejun Heo return -EAGAIN; 1240bf4ede01STejun Heo } 1241bf4ede01STejun Heo 1242bf4ede01STejun Heo /** 1243706026c2STejun Heo * insert_work - insert a work into a pool 1244112202d9STejun Heo * @pwq: pwq @work belongs to 12454690c4abSTejun Heo * @work: work to insert 12464690c4abSTejun Heo * @head: insertion point 12474690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 12484690c4abSTejun Heo * 1249112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 1250706026c2STejun Heo * work_struct flags. 12514690c4abSTejun Heo * 12524690c4abSTejun Heo * CONTEXT: 1253d565ed63STejun Heo * spin_lock_irq(pool->lock). 1254365970a1SDavid Howells */ 1255112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 1256112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 1257b89deed3SOleg Nesterov { 1258112202d9STejun Heo struct worker_pool *pool = pwq->pool; 1259e1d8aa9fSFrederic Weisbecker 12604690c4abSTejun Heo /* we own @work, set data and link */ 1261112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 12621a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 12638864b4e5STejun Heo get_pwq(pwq); 1264e22bee78STejun Heo 1265e22bee78STejun Heo /* 1266c5aa87bbSTejun Heo * Ensure either wq_worker_sleeping() sees the above 1267c5aa87bbSTejun Heo * list_add_tail() or we see zero nr_running to avoid workers lying 1268c5aa87bbSTejun Heo * around lazily while there are works to be processed. 1269e22bee78STejun Heo */ 1270e22bee78STejun Heo smp_mb(); 1271e22bee78STejun Heo 127263d95a91STejun Heo if (__need_more_worker(pool)) 127363d95a91STejun Heo wake_up_worker(pool); 1274b89deed3SOleg Nesterov } 1275b89deed3SOleg Nesterov 1276c8efcc25STejun Heo /* 1277c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 12788d03ecfeSTejun Heo * same workqueue. 1279c8efcc25STejun Heo */ 1280c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1281c8efcc25STejun Heo { 1282c8efcc25STejun Heo struct worker *worker; 1283c8efcc25STejun Heo 12848d03ecfeSTejun Heo worker = current_wq_worker(); 1285c8efcc25STejun Heo /* 12868d03ecfeSTejun Heo * Return %true iff I'm a worker execuing a work item on @wq. If 12878d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 1288c8efcc25STejun Heo */ 1289112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 1290c8efcc25STejun Heo } 1291c8efcc25STejun Heo 1292d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 12931da177e4SLinus Torvalds struct work_struct *work) 12941da177e4SLinus Torvalds { 1295112202d9STejun Heo struct pool_workqueue *pwq; 1296c9178087STejun Heo struct worker_pool *last_pool; 12971e19ffc6STejun Heo struct list_head *worklist; 12988a2e8e5dSTejun Heo unsigned int work_flags; 1299b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 13008930cabaSTejun Heo 13018930cabaSTejun Heo /* 13028930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 13038930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 13048930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 13058930cabaSTejun Heo * happen with IRQ disabled. 13068930cabaSTejun Heo */ 13078930cabaSTejun Heo WARN_ON_ONCE(!irqs_disabled()); 13081da177e4SLinus Torvalds 1309dc186ad7SThomas Gleixner debug_work_activate(work); 13101e19ffc6STejun Heo 13119ef28a73SLi Bin /* if draining, only works from the same workqueue are allowed */ 1312618b01ebSTejun Heo if (unlikely(wq->flags & __WQ_DRAINING) && 1313c8efcc25STejun Heo WARN_ON_ONCE(!is_chained_work(wq))) 1314e41e704bSTejun Heo return; 13159e8cd2f5STejun Heo retry: 1316df2d5ae4STejun Heo if (req_cpu == WORK_CPU_UNBOUND) 1317f3421797STejun Heo cpu = raw_smp_processor_id(); 1318df2d5ae4STejun Heo 1319df2d5ae4STejun Heo /* pwq which will be used unless @work is executing elsewhere */ 1320df2d5ae4STejun Heo if (!(wq->flags & WQ_UNBOUND)) 1321c9178087STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 1322df2d5ae4STejun Heo else 1323df2d5ae4STejun Heo pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); 1324f3421797STejun Heo 132518aa9effSTejun Heo /* 1326c9178087STejun Heo * If @work was previously on a different pool, it might still be 1327c9178087STejun Heo * running there, in which case the work needs to be queued on that 1328c9178087STejun Heo * pool to guarantee non-reentrancy. 132918aa9effSTejun Heo */ 1330c9e7cf27STejun Heo last_pool = get_work_pool(work); 1331112202d9STejun Heo if (last_pool && last_pool != pwq->pool) { 133218aa9effSTejun Heo struct worker *worker; 133318aa9effSTejun Heo 1334d565ed63STejun Heo spin_lock(&last_pool->lock); 133518aa9effSTejun Heo 1336c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 133718aa9effSTejun Heo 1338112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 1339c9178087STejun Heo pwq = worker->current_pwq; 13408594fadeSLai Jiangshan } else { 134118aa9effSTejun Heo /* meh... not running there, queue here */ 1342d565ed63STejun Heo spin_unlock(&last_pool->lock); 1343112202d9STejun Heo spin_lock(&pwq->pool->lock); 134418aa9effSTejun Heo } 13458930cabaSTejun Heo } else { 1346112202d9STejun Heo spin_lock(&pwq->pool->lock); 13478930cabaSTejun Heo } 1348502ca9d8STejun Heo 13499e8cd2f5STejun Heo /* 13509e8cd2f5STejun Heo * pwq is determined and locked. For unbound pools, we could have 13519e8cd2f5STejun Heo * raced with pwq release and it could already be dead. If its 13529e8cd2f5STejun Heo * refcnt is zero, repeat pwq selection. Note that pwqs never die 1353df2d5ae4STejun Heo * without another pwq replacing it in the numa_pwq_tbl or while 1354df2d5ae4STejun Heo * work items are executing on it, so the retrying is guaranteed to 13559e8cd2f5STejun Heo * make forward-progress. 13569e8cd2f5STejun Heo */ 13579e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 13589e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 13599e8cd2f5STejun Heo spin_unlock(&pwq->pool->lock); 13609e8cd2f5STejun Heo cpu_relax(); 13619e8cd2f5STejun Heo goto retry; 13629e8cd2f5STejun Heo } 13639e8cd2f5STejun Heo /* oops */ 13649e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 13659e8cd2f5STejun Heo wq->name, cpu); 13669e8cd2f5STejun Heo } 13679e8cd2f5STejun Heo 1368112202d9STejun Heo /* pwq determined, queue */ 1369112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 1370502ca9d8STejun Heo 1371f5b2552bSDan Carpenter if (WARN_ON(!list_empty(&work->entry))) { 1372112202d9STejun Heo spin_unlock(&pwq->pool->lock); 1373f5b2552bSDan Carpenter return; 1374f5b2552bSDan Carpenter } 13751e19ffc6STejun Heo 1376112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 1377112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 13781e19ffc6STejun Heo 1379112202d9STejun Heo if (likely(pwq->nr_active < pwq->max_active)) { 1380cdadf009STejun Heo trace_workqueue_activate_work(work); 1381112202d9STejun Heo pwq->nr_active++; 1382112202d9STejun Heo worklist = &pwq->pool->worklist; 13838a2e8e5dSTejun Heo } else { 13848a2e8e5dSTejun Heo work_flags |= WORK_STRUCT_DELAYED; 1385112202d9STejun Heo worklist = &pwq->delayed_works; 13868a2e8e5dSTejun Heo } 13871e19ffc6STejun Heo 1388112202d9STejun Heo insert_work(pwq, work, worklist, work_flags); 13891e19ffc6STejun Heo 1390112202d9STejun Heo spin_unlock(&pwq->pool->lock); 13911da177e4SLinus Torvalds } 13921da177e4SLinus Torvalds 13930fcb78c2SRolf Eike Beer /** 1394c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1395c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1396c1a220e7SZhang Rui * @wq: workqueue to use 1397c1a220e7SZhang Rui * @work: work to queue 1398c1a220e7SZhang Rui * 1399c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1400c1a220e7SZhang Rui * can't go away. 1401d185af30SYacine Belkadi * 1402d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. 1403c1a220e7SZhang Rui */ 1404d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1405d4283e93STejun Heo struct work_struct *work) 1406c1a220e7SZhang Rui { 1407d4283e93STejun Heo bool ret = false; 14088930cabaSTejun Heo unsigned long flags; 14098930cabaSTejun Heo 14108930cabaSTejun Heo local_irq_save(flags); 1411c1a220e7SZhang Rui 141222df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 14134690c4abSTejun Heo __queue_work(cpu, wq, work); 1414d4283e93STejun Heo ret = true; 1415c1a220e7SZhang Rui } 14168930cabaSTejun Heo 14178930cabaSTejun Heo local_irq_restore(flags); 1418c1a220e7SZhang Rui return ret; 1419c1a220e7SZhang Rui } 1420ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on); 1421c1a220e7SZhang Rui 1422d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data) 14231da177e4SLinus Torvalds { 142452bad64dSDavid Howells struct delayed_work *dwork = (struct delayed_work *)__data; 14251da177e4SLinus Torvalds 1426e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 142760c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 14281da177e4SLinus Torvalds } 14291438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 14301da177e4SLinus Torvalds 14317beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 143252bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 14331da177e4SLinus Torvalds { 14347beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 14357beb2edfSTejun Heo struct work_struct *work = &dwork->work; 14361da177e4SLinus Torvalds 14377beb2edfSTejun Heo WARN_ON_ONCE(timer->function != delayed_work_timer_fn || 14387beb2edfSTejun Heo timer->data != (unsigned long)dwork); 1439fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 1440fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 14417beb2edfSTejun Heo 14428852aac2STejun Heo /* 14438852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 14448852aac2STejun Heo * both optimization and correctness. The earliest @timer can 14458852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 14468852aac2STejun Heo * on that there's no such delay when @delay is 0. 14478852aac2STejun Heo */ 14488852aac2STejun Heo if (!delay) { 14498852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 14508852aac2STejun Heo return; 14518852aac2STejun Heo } 14528852aac2STejun Heo 14537beb2edfSTejun Heo timer_stats_timer_set_start_info(&dwork->timer); 14547beb2edfSTejun Heo 145560c057bcSLai Jiangshan dwork->wq = wq; 14561265057fSTejun Heo dwork->cpu = cpu; 14577beb2edfSTejun Heo timer->expires = jiffies + delay; 14587beb2edfSTejun Heo 14597beb2edfSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 14607beb2edfSTejun Heo add_timer_on(timer, cpu); 14617beb2edfSTejun Heo else 14627beb2edfSTejun Heo add_timer(timer); 14637beb2edfSTejun Heo } 14641da177e4SLinus Torvalds 14650fcb78c2SRolf Eike Beer /** 14660fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 14670fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 14680fcb78c2SRolf Eike Beer * @wq: workqueue to use 1469af9997e4SRandy Dunlap * @dwork: work to queue 14700fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 14710fcb78c2SRolf Eike Beer * 1472d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. If 1473715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 1474715f1300STejun Heo * execution. 14750fcb78c2SRolf Eike Beer */ 1476d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 147752bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 14787a6bc1cdSVenkatesh Pallipadi { 147952bad64dSDavid Howells struct work_struct *work = &dwork->work; 1480d4283e93STejun Heo bool ret = false; 14818930cabaSTejun Heo unsigned long flags; 14828930cabaSTejun Heo 14838930cabaSTejun Heo /* read the comment in __queue_work() */ 14848930cabaSTejun Heo local_irq_save(flags); 14857a6bc1cdSVenkatesh Pallipadi 148622df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 14877beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 1488d4283e93STejun Heo ret = true; 14897a6bc1cdSVenkatesh Pallipadi } 14908930cabaSTejun Heo 14918930cabaSTejun Heo local_irq_restore(flags); 14927a6bc1cdSVenkatesh Pallipadi return ret; 14937a6bc1cdSVenkatesh Pallipadi } 1494ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on); 14951da177e4SLinus Torvalds 1496c8e55f36STejun Heo /** 14978376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 14988376fe22STejun Heo * @cpu: CPU number to execute work on 14998376fe22STejun Heo * @wq: workqueue to use 15008376fe22STejun Heo * @dwork: work to queue 15018376fe22STejun Heo * @delay: number of jiffies to wait before queueing 15028376fe22STejun Heo * 15038376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 15048376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 15058376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 15068376fe22STejun Heo * current state. 15078376fe22STejun Heo * 1508d185af30SYacine Belkadi * Return: %false if @dwork was idle and queued, %true if @dwork was 15098376fe22STejun Heo * pending and its timer was modified. 15108376fe22STejun Heo * 1511e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 15128376fe22STejun Heo * See try_to_grab_pending() for details. 15138376fe22STejun Heo */ 15148376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 15158376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 15168376fe22STejun Heo { 15178376fe22STejun Heo unsigned long flags; 15188376fe22STejun Heo int ret; 15198376fe22STejun Heo 15208376fe22STejun Heo do { 15218376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 15228376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 15238376fe22STejun Heo 15248376fe22STejun Heo if (likely(ret >= 0)) { 15258376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 15268376fe22STejun Heo local_irq_restore(flags); 15278376fe22STejun Heo } 15288376fe22STejun Heo 15298376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 15308376fe22STejun Heo return ret; 15318376fe22STejun Heo } 15328376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 15338376fe22STejun Heo 15348376fe22STejun Heo /** 1535c8e55f36STejun Heo * worker_enter_idle - enter idle state 1536c8e55f36STejun Heo * @worker: worker which is entering idle state 1537c8e55f36STejun Heo * 1538c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1539c8e55f36STejun Heo * necessary. 1540c8e55f36STejun Heo * 1541c8e55f36STejun Heo * LOCKING: 1542d565ed63STejun Heo * spin_lock_irq(pool->lock). 1543c8e55f36STejun Heo */ 1544c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 15451da177e4SLinus Torvalds { 1546bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1547c8e55f36STejun Heo 15486183c009STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 15496183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 15506183c009STejun Heo (worker->hentry.next || worker->hentry.pprev))) 15516183c009STejun Heo return; 1552c8e55f36STejun Heo 1553051e1850SLai Jiangshan /* can't use worker_set_flags(), also called from create_worker() */ 1554cb444766STejun Heo worker->flags |= WORKER_IDLE; 1555bd7bdd43STejun Heo pool->nr_idle++; 1556e22bee78STejun Heo worker->last_active = jiffies; 1557c8e55f36STejun Heo 1558c8e55f36STejun Heo /* idle_list is LIFO */ 1559bd7bdd43STejun Heo list_add(&worker->entry, &pool->idle_list); 1560db7bccf4STejun Heo 156163d95a91STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1562628c78e7STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1563cb444766STejun Heo 1564544ecf31STejun Heo /* 1565706026c2STejun Heo * Sanity check nr_running. Because wq_unbind_fn() releases 1566d565ed63STejun Heo * pool->lock between setting %WORKER_UNBOUND and zapping 1567628c78e7STejun Heo * nr_running, the warning may trigger spuriously. Check iff 1568628c78e7STejun Heo * unbind is not in progress. 1569544ecf31STejun Heo */ 157024647570STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 1571bd7bdd43STejun Heo pool->nr_workers == pool->nr_idle && 1572e19e397aSTejun Heo atomic_read(&pool->nr_running)); 1573c8e55f36STejun Heo } 1574c8e55f36STejun Heo 1575c8e55f36STejun Heo /** 1576c8e55f36STejun Heo * worker_leave_idle - leave idle state 1577c8e55f36STejun Heo * @worker: worker which is leaving idle state 1578c8e55f36STejun Heo * 1579c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1580c8e55f36STejun Heo * 1581c8e55f36STejun Heo * LOCKING: 1582d565ed63STejun Heo * spin_lock_irq(pool->lock). 1583c8e55f36STejun Heo */ 1584c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1585c8e55f36STejun Heo { 1586bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1587c8e55f36STejun Heo 15886183c009STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 15896183c009STejun Heo return; 1590d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1591bd7bdd43STejun Heo pool->nr_idle--; 1592c8e55f36STejun Heo list_del_init(&worker->entry); 1593c8e55f36STejun Heo } 1594c8e55f36STejun Heo 1595f7537df5SLai Jiangshan static struct worker *alloc_worker(int node) 1596c34056a3STejun Heo { 1597c34056a3STejun Heo struct worker *worker; 1598c34056a3STejun Heo 1599f7537df5SLai Jiangshan worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node); 1600c8e55f36STejun Heo if (worker) { 1601c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1602affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 1603da028469SLai Jiangshan INIT_LIST_HEAD(&worker->node); 1604e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1605e22bee78STejun Heo worker->flags = WORKER_PREP; 1606c8e55f36STejun Heo } 1607c34056a3STejun Heo return worker; 1608c34056a3STejun Heo } 1609c34056a3STejun Heo 1610c34056a3STejun Heo /** 16114736cbf7SLai Jiangshan * worker_attach_to_pool() - attach a worker to a pool 16124736cbf7SLai Jiangshan * @worker: worker to be attached 16134736cbf7SLai Jiangshan * @pool: the target pool 16144736cbf7SLai Jiangshan * 16154736cbf7SLai Jiangshan * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and 16164736cbf7SLai Jiangshan * cpu-binding of @worker are kept coordinated with the pool across 16174736cbf7SLai Jiangshan * cpu-[un]hotplugs. 16184736cbf7SLai Jiangshan */ 16194736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker, 16204736cbf7SLai Jiangshan struct worker_pool *pool) 16214736cbf7SLai Jiangshan { 16224736cbf7SLai Jiangshan mutex_lock(&pool->attach_mutex); 16234736cbf7SLai Jiangshan 16244736cbf7SLai Jiangshan /* 16254736cbf7SLai Jiangshan * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any 16264736cbf7SLai Jiangshan * online CPUs. It'll be re-applied when any of the CPUs come up. 16274736cbf7SLai Jiangshan */ 16284736cbf7SLai Jiangshan set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask); 16294736cbf7SLai Jiangshan 16304736cbf7SLai Jiangshan /* 16314736cbf7SLai Jiangshan * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains 16324736cbf7SLai Jiangshan * stable across this function. See the comments above the 16334736cbf7SLai Jiangshan * flag definition for details. 16344736cbf7SLai Jiangshan */ 16354736cbf7SLai Jiangshan if (pool->flags & POOL_DISASSOCIATED) 16364736cbf7SLai Jiangshan worker->flags |= WORKER_UNBOUND; 16374736cbf7SLai Jiangshan 16384736cbf7SLai Jiangshan list_add_tail(&worker->node, &pool->workers); 16394736cbf7SLai Jiangshan 16404736cbf7SLai Jiangshan mutex_unlock(&pool->attach_mutex); 16414736cbf7SLai Jiangshan } 16424736cbf7SLai Jiangshan 16434736cbf7SLai Jiangshan /** 164460f5a4bcSLai Jiangshan * worker_detach_from_pool() - detach a worker from its pool 164560f5a4bcSLai Jiangshan * @worker: worker which is attached to its pool 164660f5a4bcSLai Jiangshan * @pool: the pool @worker is attached to 164760f5a4bcSLai Jiangshan * 16484736cbf7SLai Jiangshan * Undo the attaching which had been done in worker_attach_to_pool(). The 16494736cbf7SLai Jiangshan * caller worker shouldn't access to the pool after detached except it has 16504736cbf7SLai Jiangshan * other reference to the pool. 165160f5a4bcSLai Jiangshan */ 165260f5a4bcSLai Jiangshan static void worker_detach_from_pool(struct worker *worker, 165360f5a4bcSLai Jiangshan struct worker_pool *pool) 165460f5a4bcSLai Jiangshan { 165560f5a4bcSLai Jiangshan struct completion *detach_completion = NULL; 165660f5a4bcSLai Jiangshan 165792f9c5c4SLai Jiangshan mutex_lock(&pool->attach_mutex); 1658da028469SLai Jiangshan list_del(&worker->node); 1659da028469SLai Jiangshan if (list_empty(&pool->workers)) 166060f5a4bcSLai Jiangshan detach_completion = pool->detach_completion; 166192f9c5c4SLai Jiangshan mutex_unlock(&pool->attach_mutex); 166260f5a4bcSLai Jiangshan 1663b62c0751SLai Jiangshan /* clear leftover flags without pool->lock after it is detached */ 1664b62c0751SLai Jiangshan worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND); 1665b62c0751SLai Jiangshan 166660f5a4bcSLai Jiangshan if (detach_completion) 166760f5a4bcSLai Jiangshan complete(detach_completion); 166860f5a4bcSLai Jiangshan } 166960f5a4bcSLai Jiangshan 167060f5a4bcSLai Jiangshan /** 1671c34056a3STejun Heo * create_worker - create a new workqueue worker 167263d95a91STejun Heo * @pool: pool the new worker will belong to 1673c34056a3STejun Heo * 1674051e1850SLai Jiangshan * Create and start a new worker which is attached to @pool. 1675c34056a3STejun Heo * 1676c34056a3STejun Heo * CONTEXT: 1677c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1678c34056a3STejun Heo * 1679d185af30SYacine Belkadi * Return: 1680c34056a3STejun Heo * Pointer to the newly created worker. 1681c34056a3STejun Heo */ 1682bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 1683c34056a3STejun Heo { 1684c34056a3STejun Heo struct worker *worker = NULL; 1685f3421797STejun Heo int id = -1; 1686e3c916a4STejun Heo char id_buf[16]; 1687c34056a3STejun Heo 16887cda9aaeSLai Jiangshan /* ID is needed to determine kthread name */ 16897cda9aaeSLai Jiangshan id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL); 1690822d8405STejun Heo if (id < 0) 1691c34056a3STejun Heo goto fail; 1692c34056a3STejun Heo 1693f7537df5SLai Jiangshan worker = alloc_worker(pool->node); 1694c34056a3STejun Heo if (!worker) 1695c34056a3STejun Heo goto fail; 1696c34056a3STejun Heo 1697bd7bdd43STejun Heo worker->pool = pool; 1698c34056a3STejun Heo worker->id = id; 1699c34056a3STejun Heo 170029c91e99STejun Heo if (pool->cpu >= 0) 1701e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, 1702e3c916a4STejun Heo pool->attrs->nice < 0 ? "H" : ""); 1703f3421797STejun Heo else 1704e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); 1705e3c916a4STejun Heo 1706f3f90ad4STejun Heo worker->task = kthread_create_on_node(worker_thread, worker, pool->node, 1707e3c916a4STejun Heo "kworker/%s", id_buf); 1708c34056a3STejun Heo if (IS_ERR(worker->task)) 1709c34056a3STejun Heo goto fail; 1710c34056a3STejun Heo 171191151228SOleg Nesterov set_user_nice(worker->task, pool->attrs->nice); 171291151228SOleg Nesterov 171391151228SOleg Nesterov /* prevent userland from meddling with cpumask of workqueue workers */ 171491151228SOleg Nesterov worker->task->flags |= PF_NO_SETAFFINITY; 171591151228SOleg Nesterov 1716da028469SLai Jiangshan /* successful, attach the worker to the pool */ 17174736cbf7SLai Jiangshan worker_attach_to_pool(worker, pool); 1718822d8405STejun Heo 1719051e1850SLai Jiangshan /* start the newly created worker */ 1720051e1850SLai Jiangshan spin_lock_irq(&pool->lock); 1721051e1850SLai Jiangshan worker->pool->nr_workers++; 1722051e1850SLai Jiangshan worker_enter_idle(worker); 1723051e1850SLai Jiangshan wake_up_process(worker->task); 1724051e1850SLai Jiangshan spin_unlock_irq(&pool->lock); 1725051e1850SLai Jiangshan 1726c34056a3STejun Heo return worker; 1727822d8405STejun Heo 1728c34056a3STejun Heo fail: 17299625ab17SLai Jiangshan if (id >= 0) 17307cda9aaeSLai Jiangshan ida_simple_remove(&pool->worker_ida, id); 1731c34056a3STejun Heo kfree(worker); 1732c34056a3STejun Heo return NULL; 1733c34056a3STejun Heo } 1734c34056a3STejun Heo 1735c34056a3STejun Heo /** 1736c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1737c34056a3STejun Heo * @worker: worker to be destroyed 1738c34056a3STejun Heo * 173973eb7fe7SLai Jiangshan * Destroy @worker and adjust @pool stats accordingly. The worker should 174073eb7fe7SLai Jiangshan * be idle. 1741c8e55f36STejun Heo * 1742c8e55f36STejun Heo * CONTEXT: 174360f5a4bcSLai Jiangshan * spin_lock_irq(pool->lock). 1744c34056a3STejun Heo */ 1745c34056a3STejun Heo static void destroy_worker(struct worker *worker) 1746c34056a3STejun Heo { 1747bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1748c34056a3STejun Heo 1749cd549687STejun Heo lockdep_assert_held(&pool->lock); 1750cd549687STejun Heo 1751c34056a3STejun Heo /* sanity check frenzy */ 17526183c009STejun Heo if (WARN_ON(worker->current_work) || 175373eb7fe7SLai Jiangshan WARN_ON(!list_empty(&worker->scheduled)) || 175473eb7fe7SLai Jiangshan WARN_ON(!(worker->flags & WORKER_IDLE))) 17556183c009STejun Heo return; 1756c34056a3STejun Heo 1757bd7bdd43STejun Heo pool->nr_workers--; 1758bd7bdd43STejun Heo pool->nr_idle--; 1759c8e55f36STejun Heo 1760c8e55f36STejun Heo list_del_init(&worker->entry); 1761cb444766STejun Heo worker->flags |= WORKER_DIE; 176260f5a4bcSLai Jiangshan wake_up_process(worker->task); 1763c34056a3STejun Heo } 1764c34056a3STejun Heo 176563d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool) 1766e22bee78STejun Heo { 176763d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1768e22bee78STejun Heo 1769d565ed63STejun Heo spin_lock_irq(&pool->lock); 1770e22bee78STejun Heo 17713347fc9fSLai Jiangshan while (too_many_workers(pool)) { 1772e22bee78STejun Heo struct worker *worker; 1773e22bee78STejun Heo unsigned long expires; 1774e22bee78STejun Heo 1775e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 177663d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 1777e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1778e22bee78STejun Heo 17793347fc9fSLai Jiangshan if (time_before(jiffies, expires)) { 178063d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 17813347fc9fSLai Jiangshan break; 1782e22bee78STejun Heo } 17833347fc9fSLai Jiangshan 17843347fc9fSLai Jiangshan destroy_worker(worker); 1785e22bee78STejun Heo } 1786e22bee78STejun Heo 1787d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1788e22bee78STejun Heo } 1789e22bee78STejun Heo 1790493a1724STejun Heo static void send_mayday(struct work_struct *work) 1791e22bee78STejun Heo { 1792112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1793112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 1794493a1724STejun Heo 17952e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 1796e22bee78STejun Heo 1797493008a8STejun Heo if (!wq->rescuer) 1798493a1724STejun Heo return; 1799e22bee78STejun Heo 1800e22bee78STejun Heo /* mayday mayday mayday */ 1801493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 180277668c8bSLai Jiangshan /* 180377668c8bSLai Jiangshan * If @pwq is for an unbound wq, its base ref may be put at 180477668c8bSLai Jiangshan * any time due to an attribute change. Pin @pwq until the 180577668c8bSLai Jiangshan * rescuer is done with it. 180677668c8bSLai Jiangshan */ 180777668c8bSLai Jiangshan get_pwq(pwq); 1808493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 1809e22bee78STejun Heo wake_up_process(wq->rescuer->task); 1810493a1724STejun Heo } 1811e22bee78STejun Heo } 1812e22bee78STejun Heo 1813706026c2STejun Heo static void pool_mayday_timeout(unsigned long __pool) 1814e22bee78STejun Heo { 181563d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1816e22bee78STejun Heo struct work_struct *work; 1817e22bee78STejun Heo 1818b2d82909STejun Heo spin_lock_irq(&pool->lock); 1819b2d82909STejun Heo spin_lock(&wq_mayday_lock); /* for wq->maydays */ 1820e22bee78STejun Heo 182163d95a91STejun Heo if (need_to_create_worker(pool)) { 1822e22bee78STejun Heo /* 1823e22bee78STejun Heo * We've been trying to create a new worker but 1824e22bee78STejun Heo * haven't been successful. We might be hitting an 1825e22bee78STejun Heo * allocation deadlock. Send distress signals to 1826e22bee78STejun Heo * rescuers. 1827e22bee78STejun Heo */ 182863d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 1829e22bee78STejun Heo send_mayday(work); 1830e22bee78STejun Heo } 1831e22bee78STejun Heo 1832b2d82909STejun Heo spin_unlock(&wq_mayday_lock); 1833b2d82909STejun Heo spin_unlock_irq(&pool->lock); 1834e22bee78STejun Heo 183563d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 1836e22bee78STejun Heo } 1837e22bee78STejun Heo 1838e22bee78STejun Heo /** 1839e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 184063d95a91STejun Heo * @pool: pool to create a new worker for 1841e22bee78STejun Heo * 184263d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 1843e22bee78STejun Heo * have at least one idle worker on return from this function. If 1844e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 184563d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 1846e22bee78STejun Heo * possible allocation deadlock. 1847e22bee78STejun Heo * 1848c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 1849c5aa87bbSTejun Heo * may_start_working() %true. 1850e22bee78STejun Heo * 1851e22bee78STejun Heo * LOCKING: 1852d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 1853e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 1854e22bee78STejun Heo * manager. 1855e22bee78STejun Heo */ 185629187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool) 1857d565ed63STejun Heo __releases(&pool->lock) 1858d565ed63STejun Heo __acquires(&pool->lock) 1859e22bee78STejun Heo { 1860e22bee78STejun Heo restart: 1861d565ed63STejun Heo spin_unlock_irq(&pool->lock); 18629f9c2364STejun Heo 1863e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 186463d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 1865e22bee78STejun Heo 1866e22bee78STejun Heo while (true) { 1867051e1850SLai Jiangshan if (create_worker(pool) || !need_to_create_worker(pool)) 1868e22bee78STejun Heo break; 1869e22bee78STejun Heo 1870e212f361SLai Jiangshan schedule_timeout_interruptible(CREATE_COOLDOWN); 18719f9c2364STejun Heo 187263d95a91STejun Heo if (!need_to_create_worker(pool)) 1873e22bee78STejun Heo break; 1874e22bee78STejun Heo } 1875e22bee78STejun Heo 187663d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 1877d565ed63STejun Heo spin_lock_irq(&pool->lock); 1878051e1850SLai Jiangshan /* 1879051e1850SLai Jiangshan * This is necessary even after a new worker was just successfully 1880051e1850SLai Jiangshan * created as @pool->lock was dropped and the new worker might have 1881051e1850SLai Jiangshan * already become busy. 1882051e1850SLai Jiangshan */ 188363d95a91STejun Heo if (need_to_create_worker(pool)) 1884e22bee78STejun Heo goto restart; 1885e22bee78STejun Heo } 1886e22bee78STejun Heo 1887e22bee78STejun Heo /** 1888e22bee78STejun Heo * manage_workers - manage worker pool 1889e22bee78STejun Heo * @worker: self 1890e22bee78STejun Heo * 1891706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 1892e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 1893706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 1894e22bee78STejun Heo * 1895e22bee78STejun Heo * The caller can safely start processing works on false return. On 1896e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 1897e22bee78STejun Heo * and may_start_working() is true. 1898e22bee78STejun Heo * 1899e22bee78STejun Heo * CONTEXT: 1900d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 1901e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 1902e22bee78STejun Heo * 1903d185af30SYacine Belkadi * Return: 190429187a9eSTejun Heo * %false if the pool doesn't need management and the caller can safely 190529187a9eSTejun Heo * start processing works, %true if management function was performed and 190629187a9eSTejun Heo * the conditions that the caller verified before calling the function may 190729187a9eSTejun Heo * no longer be true. 1908e22bee78STejun Heo */ 1909e22bee78STejun Heo static bool manage_workers(struct worker *worker) 1910e22bee78STejun Heo { 191163d95a91STejun Heo struct worker_pool *pool = worker->pool; 1912e22bee78STejun Heo 1913bc3a1afcSTejun Heo /* 1914bc3a1afcSTejun Heo * Anyone who successfully grabs manager_arb wins the arbitration 1915bc3a1afcSTejun Heo * and becomes the manager. mutex_trylock() on pool->manager_arb 1916bc3a1afcSTejun Heo * failure while holding pool->lock reliably indicates that someone 1917bc3a1afcSTejun Heo * else is managing the pool and the worker which failed trylock 1918bc3a1afcSTejun Heo * can proceed to executing work items. This means that anyone 1919bc3a1afcSTejun Heo * grabbing manager_arb is responsible for actually performing 1920bc3a1afcSTejun Heo * manager duties. If manager_arb is grabbed and released without 1921bc3a1afcSTejun Heo * actual management, the pool may stall indefinitely. 1922bc3a1afcSTejun Heo */ 192334a06bd6STejun Heo if (!mutex_trylock(&pool->manager_arb)) 192429187a9eSTejun Heo return false; 19252607d7a6STejun Heo pool->manager = worker; 1926e22bee78STejun Heo 192729187a9eSTejun Heo maybe_create_worker(pool); 1928e22bee78STejun Heo 19292607d7a6STejun Heo pool->manager = NULL; 193034a06bd6STejun Heo mutex_unlock(&pool->manager_arb); 193129187a9eSTejun Heo return true; 1932e22bee78STejun Heo } 1933e22bee78STejun Heo 1934a62428c0STejun Heo /** 1935a62428c0STejun Heo * process_one_work - process single work 1936c34056a3STejun Heo * @worker: self 1937a62428c0STejun Heo * @work: work to process 1938a62428c0STejun Heo * 1939a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 1940a62428c0STejun Heo * process a single work including synchronization against and 1941a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 1942a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 1943a62428c0STejun Heo * call this function to process a work. 1944a62428c0STejun Heo * 1945a62428c0STejun Heo * CONTEXT: 1946d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 1947a62428c0STejun Heo */ 1948c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 1949d565ed63STejun Heo __releases(&pool->lock) 1950d565ed63STejun Heo __acquires(&pool->lock) 19511da177e4SLinus Torvalds { 1952112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1953bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1954112202d9STejun Heo bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE; 195573f53c4aSTejun Heo int work_color; 19567e11629dSTejun Heo struct worker *collision; 19574e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 19584e6045f1SJohannes Berg /* 1959a62428c0STejun Heo * It is permissible to free the struct work_struct from 1960a62428c0STejun Heo * inside the function that is called from it, this we need to 1961a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 1962a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 1963a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 19644e6045f1SJohannes Berg */ 19654d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 19664d82a1deSPeter Zijlstra 19674d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 19684e6045f1SJohannes Berg #endif 1969807407c0SLai Jiangshan /* ensure we're on the correct CPU */ 197085327af6SLai Jiangshan WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 1971ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 197225511a47STejun Heo 19737e11629dSTejun Heo /* 19747e11629dSTejun Heo * A single work shouldn't be executed concurrently by 19757e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 19767e11629dSTejun Heo * already processing the work. If so, defer the work to the 19777e11629dSTejun Heo * currently executing one. 19787e11629dSTejun Heo */ 1979c9e7cf27STejun Heo collision = find_worker_executing_work(pool, work); 19807e11629dSTejun Heo if (unlikely(collision)) { 19817e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 19827e11629dSTejun Heo return; 19837e11629dSTejun Heo } 19841da177e4SLinus Torvalds 19858930cabaSTejun Heo /* claim and dequeue */ 19861da177e4SLinus Torvalds debug_work_deactivate(work); 1987c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 1988c34056a3STejun Heo worker->current_work = work; 1989a2c1c57bSTejun Heo worker->current_func = work->func; 1990112202d9STejun Heo worker->current_pwq = pwq; 199173f53c4aSTejun Heo work_color = get_work_color(work); 19927a22ad75STejun Heo 1993a62428c0STejun Heo list_del_init(&work->entry); 1994a62428c0STejun Heo 1995649027d7STejun Heo /* 1996228f1d00SLai Jiangshan * CPU intensive works don't participate in concurrency management. 1997228f1d00SLai Jiangshan * They're the scheduler's responsibility. This takes @worker out 1998228f1d00SLai Jiangshan * of concurrency management and the next code block will chain 1999228f1d00SLai Jiangshan * execution of the pending work items. 2000fb0e7bebSTejun Heo */ 2001fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2002228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_CPU_INTENSIVE); 2003fb0e7bebSTejun Heo 2004974271c4STejun Heo /* 2005a489a03eSLai Jiangshan * Wake up another worker if necessary. The condition is always 2006a489a03eSLai Jiangshan * false for normal per-cpu workers since nr_running would always 2007a489a03eSLai Jiangshan * be >= 1 at this point. This is used to chain execution of the 2008a489a03eSLai Jiangshan * pending work items for WORKER_NOT_RUNNING workers such as the 2009228f1d00SLai Jiangshan * UNBOUND and CPU_INTENSIVE ones. 2010974271c4STejun Heo */ 2011a489a03eSLai Jiangshan if (need_more_worker(pool)) 201263d95a91STejun Heo wake_up_worker(pool); 2013974271c4STejun Heo 20148930cabaSTejun Heo /* 20157c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2016d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 201723657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 201823657bb1STejun Heo * disabled. 20198930cabaSTejun Heo */ 20207c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 20211da177e4SLinus Torvalds 2022d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2023365970a1SDavid Howells 2024112202d9STejun Heo lock_map_acquire_read(&pwq->wq->lockdep_map); 20253295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2026e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2027a2c1c57bSTejun Heo worker->current_func(work); 2028e36c886aSArjan van de Ven /* 2029e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2030e36c886aSArjan van de Ven * point will only record its address. 2031e36c886aSArjan van de Ven */ 2032e36c886aSArjan van de Ven trace_workqueue_execute_end(work); 20333295f0efSIngo Molnar lock_map_release(&lockdep_map); 2034112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 20351da177e4SLinus Torvalds 2036d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 2037044c782cSValentin Ilie pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" 2038044c782cSValentin Ilie " last function: %pf\n", 2039a2c1c57bSTejun Heo current->comm, preempt_count(), task_pid_nr(current), 2040a2c1c57bSTejun Heo worker->current_func); 2041d5abe669SPeter Zijlstra debug_show_held_locks(current); 2042d5abe669SPeter Zijlstra dump_stack(); 2043d5abe669SPeter Zijlstra } 2044d5abe669SPeter Zijlstra 2045b22ce278STejun Heo /* 2046b22ce278STejun Heo * The following prevents a kworker from hogging CPU on !PREEMPT 2047b22ce278STejun Heo * kernels, where a requeueing work item waiting for something to 2048b22ce278STejun Heo * happen could deadlock with stop_machine as such work item could 2049b22ce278STejun Heo * indefinitely requeue itself while all other CPUs are trapped in 2050789cbbecSJoe Lawrence * stop_machine. At the same time, report a quiescent RCU state so 2051789cbbecSJoe Lawrence * the same condition doesn't freeze RCU. 2052b22ce278STejun Heo */ 20533e28e377SJoe Lawrence cond_resched_rcu_qs(); 2054b22ce278STejun Heo 2055d565ed63STejun Heo spin_lock_irq(&pool->lock); 2056a62428c0STejun Heo 2057fb0e7bebSTejun Heo /* clear cpu intensive status */ 2058fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2059fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2060fb0e7bebSTejun Heo 2061a62428c0STejun Heo /* we're done with it, release */ 206242f8570fSSasha Levin hash_del(&worker->hentry); 2063c34056a3STejun Heo worker->current_work = NULL; 2064a2c1c57bSTejun Heo worker->current_func = NULL; 2065112202d9STejun Heo worker->current_pwq = NULL; 20663d1cb205STejun Heo worker->desc_valid = false; 2067112202d9STejun Heo pwq_dec_nr_in_flight(pwq, work_color); 20681da177e4SLinus Torvalds } 20691da177e4SLinus Torvalds 2070affee4b2STejun Heo /** 2071affee4b2STejun Heo * process_scheduled_works - process scheduled works 2072affee4b2STejun Heo * @worker: self 2073affee4b2STejun Heo * 2074affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2075affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2076affee4b2STejun Heo * fetches a work from the top and executes it. 2077affee4b2STejun Heo * 2078affee4b2STejun Heo * CONTEXT: 2079d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2080affee4b2STejun Heo * multiple times. 2081affee4b2STejun Heo */ 2082affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 20831da177e4SLinus Torvalds { 2084affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 2085affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 2086a62428c0STejun Heo struct work_struct, entry); 2087c34056a3STejun Heo process_one_work(worker, work); 2088a62428c0STejun Heo } 20891da177e4SLinus Torvalds } 20901da177e4SLinus Torvalds 20914690c4abSTejun Heo /** 20924690c4abSTejun Heo * worker_thread - the worker thread function 2093c34056a3STejun Heo * @__worker: self 20944690c4abSTejun Heo * 2095c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 2096c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 2097c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 2098c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 2099c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 2100d185af30SYacine Belkadi * 2101d185af30SYacine Belkadi * Return: 0 21024690c4abSTejun Heo */ 2103c34056a3STejun Heo static int worker_thread(void *__worker) 21041da177e4SLinus Torvalds { 2105c34056a3STejun Heo struct worker *worker = __worker; 2106bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 21071da177e4SLinus Torvalds 2108e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2109e22bee78STejun Heo worker->task->flags |= PF_WQ_WORKER; 2110c8e55f36STejun Heo woke_up: 2111d565ed63STejun Heo spin_lock_irq(&pool->lock); 2112affee4b2STejun Heo 2113a9ab775bSTejun Heo /* am I supposed to die? */ 2114a9ab775bSTejun Heo if (unlikely(worker->flags & WORKER_DIE)) { 2115d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2116a9ab775bSTejun Heo WARN_ON_ONCE(!list_empty(&worker->entry)); 2117e22bee78STejun Heo worker->task->flags &= ~PF_WQ_WORKER; 211860f5a4bcSLai Jiangshan 211960f5a4bcSLai Jiangshan set_task_comm(worker->task, "kworker/dying"); 21207cda9aaeSLai Jiangshan ida_simple_remove(&pool->worker_ida, worker->id); 212160f5a4bcSLai Jiangshan worker_detach_from_pool(worker, pool); 212260f5a4bcSLai Jiangshan kfree(worker); 2123c8e55f36STejun Heo return 0; 2124c8e55f36STejun Heo } 2125c8e55f36STejun Heo 2126c8e55f36STejun Heo worker_leave_idle(worker); 2127db7bccf4STejun Heo recheck: 2128e22bee78STejun Heo /* no more worker necessary? */ 212963d95a91STejun Heo if (!need_more_worker(pool)) 2130e22bee78STejun Heo goto sleep; 2131e22bee78STejun Heo 2132e22bee78STejun Heo /* do we need to manage? */ 213363d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2134e22bee78STejun Heo goto recheck; 2135e22bee78STejun Heo 2136c8e55f36STejun Heo /* 2137c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2138c8e55f36STejun Heo * preparing to process a work or actually processing it. 2139c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2140c8e55f36STejun Heo */ 21416183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 2142c8e55f36STejun Heo 2143e22bee78STejun Heo /* 2144a9ab775bSTejun Heo * Finish PREP stage. We're guaranteed to have at least one idle 2145a9ab775bSTejun Heo * worker or that someone else has already assumed the manager 2146a9ab775bSTejun Heo * role. This is where @worker starts participating in concurrency 2147a9ab775bSTejun Heo * management if applicable and concurrency management is restored 2148a9ab775bSTejun Heo * after being rebound. See rebind_workers() for details. 2149e22bee78STejun Heo */ 2150a9ab775bSTejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 2151e22bee78STejun Heo 2152e22bee78STejun Heo do { 2153affee4b2STejun Heo struct work_struct *work = 2154bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2155affee4b2STejun Heo struct work_struct, entry); 2156affee4b2STejun Heo 2157c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 2158affee4b2STejun Heo /* optimization path, not strictly necessary */ 2159affee4b2STejun Heo process_one_work(worker, work); 2160affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 2161affee4b2STejun Heo process_scheduled_works(worker); 2162affee4b2STejun Heo } else { 2163c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 2164affee4b2STejun Heo process_scheduled_works(worker); 2165affee4b2STejun Heo } 216663d95a91STejun Heo } while (keep_working(pool)); 2167affee4b2STejun Heo 2168228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_PREP); 2169d313dd85STejun Heo sleep: 2170c8e55f36STejun Heo /* 2171d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2172d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2173d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2174d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2175d565ed63STejun Heo * event. 2176c8e55f36STejun Heo */ 2177c8e55f36STejun Heo worker_enter_idle(worker); 2178c8e55f36STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 2179d565ed63STejun Heo spin_unlock_irq(&pool->lock); 21801da177e4SLinus Torvalds schedule(); 2181c8e55f36STejun Heo goto woke_up; 21821da177e4SLinus Torvalds } 21831da177e4SLinus Torvalds 2184e22bee78STejun Heo /** 2185e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2186111c225aSTejun Heo * @__rescuer: self 2187e22bee78STejun Heo * 2188e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2189493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 2190e22bee78STejun Heo * 2191706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 2192e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2193e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2194e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2195e22bee78STejun Heo * the problem rescuer solves. 2196e22bee78STejun Heo * 2197706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 2198706026c2STejun Heo * workqueues which have works queued on the pool and let them process 2199e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2200e22bee78STejun Heo * 2201e22bee78STejun Heo * This should happen rarely. 2202d185af30SYacine Belkadi * 2203d185af30SYacine Belkadi * Return: 0 2204e22bee78STejun Heo */ 2205111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2206e22bee78STejun Heo { 2207111c225aSTejun Heo struct worker *rescuer = __rescuer; 2208111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 2209e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 22104d595b86SLai Jiangshan bool should_stop; 2211e22bee78STejun Heo 2212e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2213111c225aSTejun Heo 2214111c225aSTejun Heo /* 2215111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2216111c225aSTejun Heo * doesn't participate in concurrency management. 2217111c225aSTejun Heo */ 2218111c225aSTejun Heo rescuer->task->flags |= PF_WQ_WORKER; 2219e22bee78STejun Heo repeat: 2220e22bee78STejun Heo set_current_state(TASK_INTERRUPTIBLE); 22211da177e4SLinus Torvalds 22224d595b86SLai Jiangshan /* 22234d595b86SLai Jiangshan * By the time the rescuer is requested to stop, the workqueue 22244d595b86SLai Jiangshan * shouldn't have any work pending, but @wq->maydays may still have 22254d595b86SLai Jiangshan * pwq(s) queued. This can happen by non-rescuer workers consuming 22264d595b86SLai Jiangshan * all the work items before the rescuer got to them. Go through 22274d595b86SLai Jiangshan * @wq->maydays processing before acting on should_stop so that the 22284d595b86SLai Jiangshan * list is always empty on exit. 22294d595b86SLai Jiangshan */ 22304d595b86SLai Jiangshan should_stop = kthread_should_stop(); 22311da177e4SLinus Torvalds 2232493a1724STejun Heo /* see whether any pwq is asking for help */ 22332e109a28STejun Heo spin_lock_irq(&wq_mayday_lock); 2234493a1724STejun Heo 2235493a1724STejun Heo while (!list_empty(&wq->maydays)) { 2236493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 2237493a1724STejun Heo struct pool_workqueue, mayday_node); 2238112202d9STejun Heo struct worker_pool *pool = pwq->pool; 2239e22bee78STejun Heo struct work_struct *work, *n; 2240e22bee78STejun Heo 2241e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2242493a1724STejun Heo list_del_init(&pwq->mayday_node); 2243493a1724STejun Heo 22442e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 2245e22bee78STejun Heo 224651697d39SLai Jiangshan worker_attach_to_pool(rescuer, pool); 224751697d39SLai Jiangshan 224851697d39SLai Jiangshan spin_lock_irq(&pool->lock); 2249b3104104SLai Jiangshan rescuer->pool = pool; 2250e22bee78STejun Heo 2251e22bee78STejun Heo /* 2252e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2253e22bee78STejun Heo * process'em. 2254e22bee78STejun Heo */ 22550479c8c5STejun Heo WARN_ON_ONCE(!list_empty(scheduled)); 2256bd7bdd43STejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) 2257112202d9STejun Heo if (get_work_pwq(work) == pwq) 2258e22bee78STejun Heo move_linked_works(work, scheduled, &n); 2259e22bee78STejun Heo 2260008847f6SNeilBrown if (!list_empty(scheduled)) { 2261e22bee78STejun Heo process_scheduled_works(rescuer); 22627576958aSTejun Heo 22637576958aSTejun Heo /* 2264008847f6SNeilBrown * The above execution of rescued work items could 2265008847f6SNeilBrown * have created more to rescue through 2266008847f6SNeilBrown * pwq_activate_first_delayed() or chained 2267008847f6SNeilBrown * queueing. Let's put @pwq back on mayday list so 2268008847f6SNeilBrown * that such back-to-back work items, which may be 2269008847f6SNeilBrown * being used to relieve memory pressure, don't 2270008847f6SNeilBrown * incur MAYDAY_INTERVAL delay inbetween. 2271008847f6SNeilBrown */ 2272008847f6SNeilBrown if (need_to_create_worker(pool)) { 2273008847f6SNeilBrown spin_lock(&wq_mayday_lock); 2274008847f6SNeilBrown get_pwq(pwq); 2275008847f6SNeilBrown list_move_tail(&pwq->mayday_node, &wq->maydays); 2276008847f6SNeilBrown spin_unlock(&wq_mayday_lock); 2277008847f6SNeilBrown } 2278008847f6SNeilBrown } 2279008847f6SNeilBrown 2280008847f6SNeilBrown /* 228177668c8bSLai Jiangshan * Put the reference grabbed by send_mayday(). @pool won't 228213b1d625SLai Jiangshan * go away while we're still attached to it. 228377668c8bSLai Jiangshan */ 228477668c8bSLai Jiangshan put_pwq(pwq); 228577668c8bSLai Jiangshan 228677668c8bSLai Jiangshan /* 2287d8ca83e6SLai Jiangshan * Leave this pool. If need_more_worker() is %true, notify a 22887576958aSTejun Heo * regular worker; otherwise, we end up with 0 concurrency 22897576958aSTejun Heo * and stalling the execution. 22907576958aSTejun Heo */ 2291d8ca83e6SLai Jiangshan if (need_more_worker(pool)) 229263d95a91STejun Heo wake_up_worker(pool); 22937576958aSTejun Heo 2294b3104104SLai Jiangshan rescuer->pool = NULL; 229513b1d625SLai Jiangshan spin_unlock_irq(&pool->lock); 229613b1d625SLai Jiangshan 229713b1d625SLai Jiangshan worker_detach_from_pool(rescuer, pool); 229813b1d625SLai Jiangshan 229913b1d625SLai Jiangshan spin_lock_irq(&wq_mayday_lock); 23001da177e4SLinus Torvalds } 23011da177e4SLinus Torvalds 23022e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 2303493a1724STejun Heo 23044d595b86SLai Jiangshan if (should_stop) { 23054d595b86SLai Jiangshan __set_current_state(TASK_RUNNING); 23064d595b86SLai Jiangshan rescuer->task->flags &= ~PF_WQ_WORKER; 23074d595b86SLai Jiangshan return 0; 23084d595b86SLai Jiangshan } 23094d595b86SLai Jiangshan 2310111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 2311111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 2312e22bee78STejun Heo schedule(); 2313e22bee78STejun Heo goto repeat; 23141da177e4SLinus Torvalds } 23151da177e4SLinus Torvalds 2316fc2e4d70SOleg Nesterov struct wq_barrier { 2317fc2e4d70SOleg Nesterov struct work_struct work; 2318fc2e4d70SOleg Nesterov struct completion done; 23192607d7a6STejun Heo struct task_struct *task; /* purely informational */ 2320fc2e4d70SOleg Nesterov }; 2321fc2e4d70SOleg Nesterov 2322fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2323fc2e4d70SOleg Nesterov { 2324fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2325fc2e4d70SOleg Nesterov complete(&barr->done); 2326fc2e4d70SOleg Nesterov } 2327fc2e4d70SOleg Nesterov 23284690c4abSTejun Heo /** 23294690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 2330112202d9STejun Heo * @pwq: pwq to insert barrier into 23314690c4abSTejun Heo * @barr: wq_barrier to insert 2332affee4b2STejun Heo * @target: target work to attach @barr to 2333affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 23344690c4abSTejun Heo * 2335affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2336affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2337affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2338affee4b2STejun Heo * cpu. 2339affee4b2STejun Heo * 2340affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2341affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2342affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2343affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2344affee4b2STejun Heo * after a work with LINKED flag set. 2345affee4b2STejun Heo * 2346affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2347112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 23484690c4abSTejun Heo * 23494690c4abSTejun Heo * CONTEXT: 2350d565ed63STejun Heo * spin_lock_irq(pool->lock). 23514690c4abSTejun Heo */ 2352112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 2353affee4b2STejun Heo struct wq_barrier *barr, 2354affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2355fc2e4d70SOleg Nesterov { 2356affee4b2STejun Heo struct list_head *head; 2357affee4b2STejun Heo unsigned int linked = 0; 2358affee4b2STejun Heo 2359dc186ad7SThomas Gleixner /* 2360d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 2361dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2362dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2363dc186ad7SThomas Gleixner * might deadlock. 2364dc186ad7SThomas Gleixner */ 2365ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 236622df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 2367fc2e4d70SOleg Nesterov init_completion(&barr->done); 23682607d7a6STejun Heo barr->task = current; 236983c22520SOleg Nesterov 2370affee4b2STejun Heo /* 2371affee4b2STejun Heo * If @target is currently being executed, schedule the 2372affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2373affee4b2STejun Heo */ 2374affee4b2STejun Heo if (worker) 2375affee4b2STejun Heo head = worker->scheduled.next; 2376affee4b2STejun Heo else { 2377affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2378affee4b2STejun Heo 2379affee4b2STejun Heo head = target->entry.next; 2380affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2381affee4b2STejun Heo linked = *bits & WORK_STRUCT_LINKED; 2382affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2383affee4b2STejun Heo } 2384affee4b2STejun Heo 2385dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2386112202d9STejun Heo insert_work(pwq, &barr->work, head, 2387affee4b2STejun Heo work_color_to_flags(WORK_NO_COLOR) | linked); 2388fc2e4d70SOleg Nesterov } 2389fc2e4d70SOleg Nesterov 239073f53c4aSTejun Heo /** 2391112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 239273f53c4aSTejun Heo * @wq: workqueue being flushed 239373f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 239473f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 239573f53c4aSTejun Heo * 2396112202d9STejun Heo * Prepare pwqs for workqueue flushing. 239773f53c4aSTejun Heo * 2398112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 2399112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 2400112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 2401112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 2402112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 240373f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 240473f53c4aSTejun Heo * 240573f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 240673f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 240773f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 240873f53c4aSTejun Heo * is returned. 240973f53c4aSTejun Heo * 2410112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 241173f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 241273f53c4aSTejun Heo * advanced to @work_color. 241373f53c4aSTejun Heo * 241473f53c4aSTejun Heo * CONTEXT: 24153c25a55dSLai Jiangshan * mutex_lock(wq->mutex). 241673f53c4aSTejun Heo * 2417d185af30SYacine Belkadi * Return: 241873f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 241973f53c4aSTejun Heo * otherwise. 242073f53c4aSTejun Heo */ 2421112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 242273f53c4aSTejun Heo int flush_color, int work_color) 24231da177e4SLinus Torvalds { 242473f53c4aSTejun Heo bool wait = false; 242549e3cf44STejun Heo struct pool_workqueue *pwq; 24261da177e4SLinus Torvalds 242773f53c4aSTejun Heo if (flush_color >= 0) { 24286183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 2429112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 2430dc186ad7SThomas Gleixner } 243114441960SOleg Nesterov 243249e3cf44STejun Heo for_each_pwq(pwq, wq) { 2433112202d9STejun Heo struct worker_pool *pool = pwq->pool; 24341da177e4SLinus Torvalds 2435b09f4fd3SLai Jiangshan spin_lock_irq(&pool->lock); 243673f53c4aSTejun Heo 243773f53c4aSTejun Heo if (flush_color >= 0) { 24386183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 243973f53c4aSTejun Heo 2440112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 2441112202d9STejun Heo pwq->flush_color = flush_color; 2442112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 244373f53c4aSTejun Heo wait = true; 24441da177e4SLinus Torvalds } 244573f53c4aSTejun Heo } 244673f53c4aSTejun Heo 244773f53c4aSTejun Heo if (work_color >= 0) { 24486183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 2449112202d9STejun Heo pwq->work_color = work_color; 245073f53c4aSTejun Heo } 245173f53c4aSTejun Heo 2452b09f4fd3SLai Jiangshan spin_unlock_irq(&pool->lock); 24531da177e4SLinus Torvalds } 24541da177e4SLinus Torvalds 2455112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 245673f53c4aSTejun Heo complete(&wq->first_flusher->done); 245773f53c4aSTejun Heo 245873f53c4aSTejun Heo return wait; 245983c22520SOleg Nesterov } 24601da177e4SLinus Torvalds 24610fcb78c2SRolf Eike Beer /** 24621da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 24630fcb78c2SRolf Eike Beer * @wq: workqueue to flush 24641da177e4SLinus Torvalds * 2465c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 2466c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 24671da177e4SLinus Torvalds */ 24687ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 24691da177e4SLinus Torvalds { 247073f53c4aSTejun Heo struct wq_flusher this_flusher = { 247173f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 247273f53c4aSTejun Heo .flush_color = -1, 247373f53c4aSTejun Heo .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done), 247473f53c4aSTejun Heo }; 247573f53c4aSTejun Heo int next_color; 2476b1f4ec17SOleg Nesterov 24773295f0efSIngo Molnar lock_map_acquire(&wq->lockdep_map); 24783295f0efSIngo Molnar lock_map_release(&wq->lockdep_map); 247973f53c4aSTejun Heo 24803c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 248173f53c4aSTejun Heo 248273f53c4aSTejun Heo /* 248373f53c4aSTejun Heo * Start-to-wait phase 248473f53c4aSTejun Heo */ 248573f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 248673f53c4aSTejun Heo 248773f53c4aSTejun Heo if (next_color != wq->flush_color) { 248873f53c4aSTejun Heo /* 248973f53c4aSTejun Heo * Color space is not full. The current work_color 249073f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 249173f53c4aSTejun Heo * by one. 249273f53c4aSTejun Heo */ 24936183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 249473f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 249573f53c4aSTejun Heo wq->work_color = next_color; 249673f53c4aSTejun Heo 249773f53c4aSTejun Heo if (!wq->first_flusher) { 249873f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 24996183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 250073f53c4aSTejun Heo 250173f53c4aSTejun Heo wq->first_flusher = &this_flusher; 250273f53c4aSTejun Heo 2503112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 250473f53c4aSTejun Heo wq->work_color)) { 250573f53c4aSTejun Heo /* nothing to flush, done */ 250673f53c4aSTejun Heo wq->flush_color = next_color; 250773f53c4aSTejun Heo wq->first_flusher = NULL; 250873f53c4aSTejun Heo goto out_unlock; 250973f53c4aSTejun Heo } 251073f53c4aSTejun Heo } else { 251173f53c4aSTejun Heo /* wait in queue */ 25126183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 251373f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 2514112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 251573f53c4aSTejun Heo } 251673f53c4aSTejun Heo } else { 251773f53c4aSTejun Heo /* 251873f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 251973f53c4aSTejun Heo * The next flush completion will assign us 252073f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 252173f53c4aSTejun Heo */ 252273f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 252373f53c4aSTejun Heo } 252473f53c4aSTejun Heo 25253c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 252673f53c4aSTejun Heo 252773f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 252873f53c4aSTejun Heo 252973f53c4aSTejun Heo /* 253073f53c4aSTejun Heo * Wake-up-and-cascade phase 253173f53c4aSTejun Heo * 253273f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 253373f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 253473f53c4aSTejun Heo */ 253573f53c4aSTejun Heo if (wq->first_flusher != &this_flusher) 253673f53c4aSTejun Heo return; 253773f53c4aSTejun Heo 25383c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 253973f53c4aSTejun Heo 25404ce48b37STejun Heo /* we might have raced, check again with mutex held */ 25414ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 25424ce48b37STejun Heo goto out_unlock; 25434ce48b37STejun Heo 254473f53c4aSTejun Heo wq->first_flusher = NULL; 254573f53c4aSTejun Heo 25466183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 25476183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 254873f53c4aSTejun Heo 254973f53c4aSTejun Heo while (true) { 255073f53c4aSTejun Heo struct wq_flusher *next, *tmp; 255173f53c4aSTejun Heo 255273f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 255373f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 255473f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 255573f53c4aSTejun Heo break; 255673f53c4aSTejun Heo list_del_init(&next->list); 255773f53c4aSTejun Heo complete(&next->done); 255873f53c4aSTejun Heo } 255973f53c4aSTejun Heo 25606183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 256173f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 256273f53c4aSTejun Heo 256373f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 256473f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 256573f53c4aSTejun Heo 256673f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 256773f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 256873f53c4aSTejun Heo /* 256973f53c4aSTejun Heo * Assign the same color to all overflowed 257073f53c4aSTejun Heo * flushers, advance work_color and append to 257173f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 257273f53c4aSTejun Heo * phase for these overflowed flushers. 257373f53c4aSTejun Heo */ 257473f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 257573f53c4aSTejun Heo tmp->flush_color = wq->work_color; 257673f53c4aSTejun Heo 257773f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 257873f53c4aSTejun Heo 257973f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 258073f53c4aSTejun Heo &wq->flusher_queue); 2581112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 258273f53c4aSTejun Heo } 258373f53c4aSTejun Heo 258473f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 25856183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 258673f53c4aSTejun Heo break; 258773f53c4aSTejun Heo } 258873f53c4aSTejun Heo 258973f53c4aSTejun Heo /* 259073f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 2591112202d9STejun Heo * the new first flusher and arm pwqs. 259273f53c4aSTejun Heo */ 25936183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 25946183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 259573f53c4aSTejun Heo 259673f53c4aSTejun Heo list_del_init(&next->list); 259773f53c4aSTejun Heo wq->first_flusher = next; 259873f53c4aSTejun Heo 2599112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 260073f53c4aSTejun Heo break; 260173f53c4aSTejun Heo 260273f53c4aSTejun Heo /* 260373f53c4aSTejun Heo * Meh... this color is already done, clear first 260473f53c4aSTejun Heo * flusher and repeat cascading. 260573f53c4aSTejun Heo */ 260673f53c4aSTejun Heo wq->first_flusher = NULL; 260773f53c4aSTejun Heo } 260873f53c4aSTejun Heo 260973f53c4aSTejun Heo out_unlock: 26103c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 26111da177e4SLinus Torvalds } 2612ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue); 26131da177e4SLinus Torvalds 26149c5a2ba7STejun Heo /** 26159c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 26169c5a2ba7STejun Heo * @wq: workqueue to drain 26179c5a2ba7STejun Heo * 26189c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 26199c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 26209c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 26219c5a2ba7STejun Heo * repeatedly until it becomes empty. The number of flushing is detemined 26229c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 26239c5a2ba7STejun Heo * takes too long. 26249c5a2ba7STejun Heo */ 26259c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 26269c5a2ba7STejun Heo { 26279c5a2ba7STejun Heo unsigned int flush_cnt = 0; 262849e3cf44STejun Heo struct pool_workqueue *pwq; 26299c5a2ba7STejun Heo 26309c5a2ba7STejun Heo /* 26319c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 26329c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 2633618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 26349c5a2ba7STejun Heo */ 263587fc741eSLai Jiangshan mutex_lock(&wq->mutex); 26369c5a2ba7STejun Heo if (!wq->nr_drainers++) 2637618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 263887fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 26399c5a2ba7STejun Heo reflush: 26409c5a2ba7STejun Heo flush_workqueue(wq); 26419c5a2ba7STejun Heo 2642b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 264376af4d93STejun Heo 264449e3cf44STejun Heo for_each_pwq(pwq, wq) { 2645fa2563e4SThomas Tuttle bool drained; 26469c5a2ba7STejun Heo 2647b09f4fd3SLai Jiangshan spin_lock_irq(&pwq->pool->lock); 2648112202d9STejun Heo drained = !pwq->nr_active && list_empty(&pwq->delayed_works); 2649b09f4fd3SLai Jiangshan spin_unlock_irq(&pwq->pool->lock); 2650fa2563e4SThomas Tuttle 2651fa2563e4SThomas Tuttle if (drained) 26529c5a2ba7STejun Heo continue; 26539c5a2ba7STejun Heo 26549c5a2ba7STejun Heo if (++flush_cnt == 10 || 26559c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 2656c5aa87bbSTejun Heo pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n", 26579c5a2ba7STejun Heo wq->name, flush_cnt); 265876af4d93STejun Heo 2659b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 26609c5a2ba7STejun Heo goto reflush; 26619c5a2ba7STejun Heo } 26629c5a2ba7STejun Heo 26639c5a2ba7STejun Heo if (!--wq->nr_drainers) 2664618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 266587fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 26669c5a2ba7STejun Heo } 26679c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 26689c5a2ba7STejun Heo 2669606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr) 2670baf59022STejun Heo { 2671baf59022STejun Heo struct worker *worker = NULL; 2672c9e7cf27STejun Heo struct worker_pool *pool; 2673112202d9STejun Heo struct pool_workqueue *pwq; 2674baf59022STejun Heo 2675baf59022STejun Heo might_sleep(); 2676baf59022STejun Heo 2677fa1b54e6STejun Heo local_irq_disable(); 2678fa1b54e6STejun Heo pool = get_work_pool(work); 2679fa1b54e6STejun Heo if (!pool) { 2680fa1b54e6STejun Heo local_irq_enable(); 2681fa1b54e6STejun Heo return false; 2682fa1b54e6STejun Heo } 2683fa1b54e6STejun Heo 2684fa1b54e6STejun Heo spin_lock(&pool->lock); 26850b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 2686112202d9STejun Heo pwq = get_work_pwq(work); 2687112202d9STejun Heo if (pwq) { 2688112202d9STejun Heo if (unlikely(pwq->pool != pool)) 2689baf59022STejun Heo goto already_gone; 2690606a5020STejun Heo } else { 2691c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 2692baf59022STejun Heo if (!worker) 2693baf59022STejun Heo goto already_gone; 2694112202d9STejun Heo pwq = worker->current_pwq; 2695606a5020STejun Heo } 2696baf59022STejun Heo 2697112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 2698d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2699baf59022STejun Heo 2700e159489bSTejun Heo /* 2701e159489bSTejun Heo * If @max_active is 1 or rescuer is in use, flushing another work 2702e159489bSTejun Heo * item on the same workqueue may lead to deadlock. Make sure the 2703e159489bSTejun Heo * flusher is not running on the same workqueue by verifying write 2704e159489bSTejun Heo * access. 2705e159489bSTejun Heo */ 2706493008a8STejun Heo if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) 2707112202d9STejun Heo lock_map_acquire(&pwq->wq->lockdep_map); 2708e159489bSTejun Heo else 2709112202d9STejun Heo lock_map_acquire_read(&pwq->wq->lockdep_map); 2710112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 2711e159489bSTejun Heo 2712baf59022STejun Heo return true; 2713baf59022STejun Heo already_gone: 2714d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2715baf59022STejun Heo return false; 2716baf59022STejun Heo } 2717baf59022STejun Heo 2718db700897SOleg Nesterov /** 2719401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 2720401a8d04STejun Heo * @work: the work to flush 2721db700897SOleg Nesterov * 2722606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 2723606a5020STejun Heo * on return if it hasn't been requeued since flush started. 2724401a8d04STejun Heo * 2725d185af30SYacine Belkadi * Return: 2726401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2727401a8d04STejun Heo * %false if it was already idle. 2728db700897SOleg Nesterov */ 2729401a8d04STejun Heo bool flush_work(struct work_struct *work) 2730db700897SOleg Nesterov { 273112997d1aSBjorn Helgaas struct wq_barrier barr; 273212997d1aSBjorn Helgaas 27330976dfc1SStephen Boyd lock_map_acquire(&work->lockdep_map); 27340976dfc1SStephen Boyd lock_map_release(&work->lockdep_map); 27350976dfc1SStephen Boyd 273612997d1aSBjorn Helgaas if (start_flush_work(work, &barr)) { 273712997d1aSBjorn Helgaas wait_for_completion(&barr.done); 273812997d1aSBjorn Helgaas destroy_work_on_stack(&barr.work); 273912997d1aSBjorn Helgaas return true; 274012997d1aSBjorn Helgaas } else { 274112997d1aSBjorn Helgaas return false; 274212997d1aSBjorn Helgaas } 2743606a5020STejun Heo } 2744db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 2745db700897SOleg Nesterov 27468603e1b3STejun Heo struct cwt_wait { 27478603e1b3STejun Heo wait_queue_t wait; 27488603e1b3STejun Heo struct work_struct *work; 27498603e1b3STejun Heo }; 27508603e1b3STejun Heo 27518603e1b3STejun Heo static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key) 27528603e1b3STejun Heo { 27538603e1b3STejun Heo struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait); 27548603e1b3STejun Heo 27558603e1b3STejun Heo if (cwait->work != key) 27568603e1b3STejun Heo return 0; 27578603e1b3STejun Heo return autoremove_wake_function(wait, mode, sync, key); 27588603e1b3STejun Heo } 27598603e1b3STejun Heo 276036e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 2761401a8d04STejun Heo { 27628603e1b3STejun Heo static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq); 2763bbb68dfaSTejun Heo unsigned long flags; 27641f1f642eSOleg Nesterov int ret; 27651f1f642eSOleg Nesterov 27661f1f642eSOleg Nesterov do { 2767bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 2768bbb68dfaSTejun Heo /* 27698603e1b3STejun Heo * If someone else is already canceling, wait for it to 27708603e1b3STejun Heo * finish. flush_work() doesn't work for PREEMPT_NONE 27718603e1b3STejun Heo * because we may get scheduled between @work's completion 27728603e1b3STejun Heo * and the other canceling task resuming and clearing 27738603e1b3STejun Heo * CANCELING - flush_work() will return false immediately 27748603e1b3STejun Heo * as @work is no longer busy, try_to_grab_pending() will 27758603e1b3STejun Heo * return -ENOENT as @work is still being canceled and the 27768603e1b3STejun Heo * other canceling task won't be able to clear CANCELING as 27778603e1b3STejun Heo * we're hogging the CPU. 27788603e1b3STejun Heo * 27798603e1b3STejun Heo * Let's wait for completion using a waitqueue. As this 27808603e1b3STejun Heo * may lead to the thundering herd problem, use a custom 27818603e1b3STejun Heo * wake function which matches @work along with exclusive 27828603e1b3STejun Heo * wait and wakeup. 2783bbb68dfaSTejun Heo */ 27848603e1b3STejun Heo if (unlikely(ret == -ENOENT)) { 27858603e1b3STejun Heo struct cwt_wait cwait; 27868603e1b3STejun Heo 27878603e1b3STejun Heo init_wait(&cwait.wait); 27888603e1b3STejun Heo cwait.wait.func = cwt_wakefn; 27898603e1b3STejun Heo cwait.work = work; 27908603e1b3STejun Heo 27918603e1b3STejun Heo prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait, 27928603e1b3STejun Heo TASK_UNINTERRUPTIBLE); 27938603e1b3STejun Heo if (work_is_canceling(work)) 27948603e1b3STejun Heo schedule(); 27958603e1b3STejun Heo finish_wait(&cancel_waitq, &cwait.wait); 27968603e1b3STejun Heo } 27971f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 27981f1f642eSOleg Nesterov 2799bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 2800bbb68dfaSTejun Heo mark_work_canceling(work); 2801bbb68dfaSTejun Heo local_irq_restore(flags); 2802bbb68dfaSTejun Heo 2803606a5020STejun Heo flush_work(work); 28047a22ad75STejun Heo clear_work_data(work); 28058603e1b3STejun Heo 28068603e1b3STejun Heo /* 28078603e1b3STejun Heo * Paired with prepare_to_wait() above so that either 28088603e1b3STejun Heo * waitqueue_active() is visible here or !work_is_canceling() is 28098603e1b3STejun Heo * visible there. 28108603e1b3STejun Heo */ 28118603e1b3STejun Heo smp_mb(); 28128603e1b3STejun Heo if (waitqueue_active(&cancel_waitq)) 28138603e1b3STejun Heo __wake_up(&cancel_waitq, TASK_NORMAL, 1, work); 28148603e1b3STejun Heo 28151f1f642eSOleg Nesterov return ret; 28161f1f642eSOleg Nesterov } 28171f1f642eSOleg Nesterov 28186e84d644SOleg Nesterov /** 2819401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 2820401a8d04STejun Heo * @work: the work to cancel 28216e84d644SOleg Nesterov * 2822401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 2823401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 2824401a8d04STejun Heo * another workqueue. On return from this function, @work is 2825401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 28261f1f642eSOleg Nesterov * 2827401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 2828401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 28296e84d644SOleg Nesterov * 2830401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 28316e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 2832401a8d04STejun Heo * 2833d185af30SYacine Belkadi * Return: 2834401a8d04STejun Heo * %true if @work was pending, %false otherwise. 28356e84d644SOleg Nesterov */ 2836401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 28376e84d644SOleg Nesterov { 283836e227d2STejun Heo return __cancel_work_timer(work, false); 2839b89deed3SOleg Nesterov } 284028e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 2841b89deed3SOleg Nesterov 28426e84d644SOleg Nesterov /** 2843401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 2844401a8d04STejun Heo * @dwork: the delayed work to flush 28456e84d644SOleg Nesterov * 2846401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 2847401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 2848401a8d04STejun Heo * considers the last queueing instance of @dwork. 28491f1f642eSOleg Nesterov * 2850d185af30SYacine Belkadi * Return: 2851401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2852401a8d04STejun Heo * %false if it was already idle. 28536e84d644SOleg Nesterov */ 2854401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 2855401a8d04STejun Heo { 28568930cabaSTejun Heo local_irq_disable(); 2857401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 285860c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 28598930cabaSTejun Heo local_irq_enable(); 2860401a8d04STejun Heo return flush_work(&dwork->work); 2861401a8d04STejun Heo } 2862401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 2863401a8d04STejun Heo 2864401a8d04STejun Heo /** 286557b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 286657b30ae7STejun Heo * @dwork: delayed_work to cancel 286709383498STejun Heo * 2868d185af30SYacine Belkadi * Kill off a pending delayed_work. 2869d185af30SYacine Belkadi * 2870d185af30SYacine Belkadi * Return: %true if @dwork was pending and canceled; %false if it wasn't 2871d185af30SYacine Belkadi * pending. 2872d185af30SYacine Belkadi * 2873d185af30SYacine Belkadi * Note: 2874d185af30SYacine Belkadi * The work callback function may still be running on return, unless 2875d185af30SYacine Belkadi * it returns %true and the work doesn't re-arm itself. Explicitly flush or 2876d185af30SYacine Belkadi * use cancel_delayed_work_sync() to wait on it. 287709383498STejun Heo * 287857b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 287909383498STejun Heo */ 288057b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 288109383498STejun Heo { 288257b30ae7STejun Heo unsigned long flags; 288357b30ae7STejun Heo int ret; 288457b30ae7STejun Heo 288557b30ae7STejun Heo do { 288657b30ae7STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 288757b30ae7STejun Heo } while (unlikely(ret == -EAGAIN)); 288857b30ae7STejun Heo 288957b30ae7STejun Heo if (unlikely(ret < 0)) 289057b30ae7STejun Heo return false; 289157b30ae7STejun Heo 28927c3eed5cSTejun Heo set_work_pool_and_clear_pending(&dwork->work, 28937c3eed5cSTejun Heo get_work_pool_id(&dwork->work)); 289457b30ae7STejun Heo local_irq_restore(flags); 2895c0158ca6SDan Magenheimer return ret; 289609383498STejun Heo } 289757b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 289809383498STejun Heo 289909383498STejun Heo /** 2900401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 2901401a8d04STejun Heo * @dwork: the delayed work cancel 2902401a8d04STejun Heo * 2903401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 2904401a8d04STejun Heo * 2905d185af30SYacine Belkadi * Return: 2906401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 2907401a8d04STejun Heo */ 2908401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 29096e84d644SOleg Nesterov { 291036e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 29116e84d644SOleg Nesterov } 2912f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 29131da177e4SLinus Torvalds 29140fcb78c2SRolf Eike Beer /** 291531ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 2916b6136773SAndrew Morton * @func: the function to call 2917b6136773SAndrew Morton * 291831ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 291931ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 2920b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 292131ddd871STejun Heo * 2922d185af30SYacine Belkadi * Return: 292331ddd871STejun Heo * 0 on success, -errno on failure. 2924b6136773SAndrew Morton */ 292565f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 292615316ba8SChristoph Lameter { 292715316ba8SChristoph Lameter int cpu; 292838f51568SNamhyung Kim struct work_struct __percpu *works; 292915316ba8SChristoph Lameter 2930b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 2931b6136773SAndrew Morton if (!works) 293215316ba8SChristoph Lameter return -ENOMEM; 2933b6136773SAndrew Morton 293495402b38SGautham R Shenoy get_online_cpus(); 293593981800STejun Heo 293615316ba8SChristoph Lameter for_each_online_cpu(cpu) { 29379bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 29389bfb1839SIngo Molnar 29399bfb1839SIngo Molnar INIT_WORK(work, func); 29408de6d308SOleg Nesterov schedule_work_on(cpu, work); 294115316ba8SChristoph Lameter } 294293981800STejun Heo 294393981800STejun Heo for_each_online_cpu(cpu) 29448616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 294593981800STejun Heo 294695402b38SGautham R Shenoy put_online_cpus(); 2947b6136773SAndrew Morton free_percpu(works); 294815316ba8SChristoph Lameter return 0; 294915316ba8SChristoph Lameter } 295015316ba8SChristoph Lameter 2951eef6a7d5SAlan Stern /** 2952eef6a7d5SAlan Stern * flush_scheduled_work - ensure that any scheduled work has run to completion. 2953eef6a7d5SAlan Stern * 2954eef6a7d5SAlan Stern * Forces execution of the kernel-global workqueue and blocks until its 2955eef6a7d5SAlan Stern * completion. 2956eef6a7d5SAlan Stern * 2957eef6a7d5SAlan Stern * Think twice before calling this function! It's very easy to get into 2958eef6a7d5SAlan Stern * trouble if you don't take great care. Either of the following situations 2959eef6a7d5SAlan Stern * will lead to deadlock: 2960eef6a7d5SAlan Stern * 2961eef6a7d5SAlan Stern * One of the work items currently on the workqueue needs to acquire 2962eef6a7d5SAlan Stern * a lock held by your code or its caller. 2963eef6a7d5SAlan Stern * 2964eef6a7d5SAlan Stern * Your code is running in the context of a work routine. 2965eef6a7d5SAlan Stern * 2966eef6a7d5SAlan Stern * They will be detected by lockdep when they occur, but the first might not 2967eef6a7d5SAlan Stern * occur very often. It depends on what work items are on the workqueue and 2968eef6a7d5SAlan Stern * what locks they need, which you have no control over. 2969eef6a7d5SAlan Stern * 2970eef6a7d5SAlan Stern * In most situations flushing the entire workqueue is overkill; you merely 2971eef6a7d5SAlan Stern * need to know that a particular work item isn't queued and isn't running. 2972eef6a7d5SAlan Stern * In such cases you should use cancel_delayed_work_sync() or 2973eef6a7d5SAlan Stern * cancel_work_sync() instead. 2974eef6a7d5SAlan Stern */ 29751da177e4SLinus Torvalds void flush_scheduled_work(void) 29761da177e4SLinus Torvalds { 2977d320c038STejun Heo flush_workqueue(system_wq); 29781da177e4SLinus Torvalds } 2979ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work); 29801da177e4SLinus Torvalds 29811da177e4SLinus Torvalds /** 29821fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 29831fa44ecaSJames Bottomley * @fn: the function to execute 29841fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 29851fa44ecaSJames Bottomley * be available when the work executes) 29861fa44ecaSJames Bottomley * 29871fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 29881fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 29891fa44ecaSJames Bottomley * 2990d185af30SYacine Belkadi * Return: 0 - function was executed 29911fa44ecaSJames Bottomley * 1 - function was scheduled for execution 29921fa44ecaSJames Bottomley */ 299365f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 29941fa44ecaSJames Bottomley { 29951fa44ecaSJames Bottomley if (!in_interrupt()) { 299665f27f38SDavid Howells fn(&ew->work); 29971fa44ecaSJames Bottomley return 0; 29981fa44ecaSJames Bottomley } 29991fa44ecaSJames Bottomley 300065f27f38SDavid Howells INIT_WORK(&ew->work, fn); 30011fa44ecaSJames Bottomley schedule_work(&ew->work); 30021fa44ecaSJames Bottomley 30031fa44ecaSJames Bottomley return 1; 30041fa44ecaSJames Bottomley } 30051fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 30061fa44ecaSJames Bottomley 30077a4e344cSTejun Heo /** 30087a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 30097a4e344cSTejun Heo * @attrs: workqueue_attrs to free 30107a4e344cSTejun Heo * 30117a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 30127a4e344cSTejun Heo */ 30137a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs) 30147a4e344cSTejun Heo { 30157a4e344cSTejun Heo if (attrs) { 30167a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 30177a4e344cSTejun Heo kfree(attrs); 30187a4e344cSTejun Heo } 30197a4e344cSTejun Heo } 30207a4e344cSTejun Heo 30217a4e344cSTejun Heo /** 30227a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 30237a4e344cSTejun Heo * @gfp_mask: allocation mask to use 30247a4e344cSTejun Heo * 30257a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 3026d185af30SYacine Belkadi * return it. 3027d185af30SYacine Belkadi * 3028d185af30SYacine Belkadi * Return: The allocated new workqueue_attr on success. %NULL on failure. 30297a4e344cSTejun Heo */ 30307a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask) 30317a4e344cSTejun Heo { 30327a4e344cSTejun Heo struct workqueue_attrs *attrs; 30337a4e344cSTejun Heo 30347a4e344cSTejun Heo attrs = kzalloc(sizeof(*attrs), gfp_mask); 30357a4e344cSTejun Heo if (!attrs) 30367a4e344cSTejun Heo goto fail; 30377a4e344cSTejun Heo if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask)) 30387a4e344cSTejun Heo goto fail; 30397a4e344cSTejun Heo 304013e2e556STejun Heo cpumask_copy(attrs->cpumask, cpu_possible_mask); 30417a4e344cSTejun Heo return attrs; 30427a4e344cSTejun Heo fail: 30437a4e344cSTejun Heo free_workqueue_attrs(attrs); 30447a4e344cSTejun Heo return NULL; 30457a4e344cSTejun Heo } 30467a4e344cSTejun Heo 304729c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 304829c91e99STejun Heo const struct workqueue_attrs *from) 304929c91e99STejun Heo { 305029c91e99STejun Heo to->nice = from->nice; 305129c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 30522865a8fbSShaohua Li /* 30532865a8fbSShaohua Li * Unlike hash and equality test, this function doesn't ignore 30542865a8fbSShaohua Li * ->no_numa as it is used for both pool and wq attrs. Instead, 30552865a8fbSShaohua Li * get_unbound_pool() explicitly clears ->no_numa after copying. 30562865a8fbSShaohua Li */ 30572865a8fbSShaohua Li to->no_numa = from->no_numa; 305829c91e99STejun Heo } 305929c91e99STejun Heo 306029c91e99STejun Heo /* hash value of the content of @attr */ 306129c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 306229c91e99STejun Heo { 306329c91e99STejun Heo u32 hash = 0; 306429c91e99STejun Heo 306529c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 306613e2e556STejun Heo hash = jhash(cpumask_bits(attrs->cpumask), 306713e2e556STejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 306829c91e99STejun Heo return hash; 306929c91e99STejun Heo } 307029c91e99STejun Heo 307129c91e99STejun Heo /* content equality test */ 307229c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 307329c91e99STejun Heo const struct workqueue_attrs *b) 307429c91e99STejun Heo { 307529c91e99STejun Heo if (a->nice != b->nice) 307629c91e99STejun Heo return false; 307729c91e99STejun Heo if (!cpumask_equal(a->cpumask, b->cpumask)) 307829c91e99STejun Heo return false; 307929c91e99STejun Heo return true; 308029c91e99STejun Heo } 308129c91e99STejun Heo 30827a4e344cSTejun Heo /** 30837a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 30847a4e344cSTejun Heo * @pool: worker_pool to initialize 30857a4e344cSTejun Heo * 30867a4e344cSTejun Heo * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs. 3087d185af30SYacine Belkadi * 3088d185af30SYacine Belkadi * Return: 0 on success, -errno on failure. Even on failure, all fields 308929c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 309029c91e99STejun Heo * on @pool safely to release it. 30917a4e344cSTejun Heo */ 30927a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 30934e1a1f9aSTejun Heo { 30944e1a1f9aSTejun Heo spin_lock_init(&pool->lock); 309529c91e99STejun Heo pool->id = -1; 309629c91e99STejun Heo pool->cpu = -1; 3097f3f90ad4STejun Heo pool->node = NUMA_NO_NODE; 30984e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 30994e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 31004e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 31014e1a1f9aSTejun Heo hash_init(pool->busy_hash); 31024e1a1f9aSTejun Heo 31034e1a1f9aSTejun Heo init_timer_deferrable(&pool->idle_timer); 31044e1a1f9aSTejun Heo pool->idle_timer.function = idle_worker_timeout; 31054e1a1f9aSTejun Heo pool->idle_timer.data = (unsigned long)pool; 31064e1a1f9aSTejun Heo 31074e1a1f9aSTejun Heo setup_timer(&pool->mayday_timer, pool_mayday_timeout, 31084e1a1f9aSTejun Heo (unsigned long)pool); 31094e1a1f9aSTejun Heo 31104e1a1f9aSTejun Heo mutex_init(&pool->manager_arb); 311192f9c5c4SLai Jiangshan mutex_init(&pool->attach_mutex); 3112da028469SLai Jiangshan INIT_LIST_HEAD(&pool->workers); 31137a4e344cSTejun Heo 31147cda9aaeSLai Jiangshan ida_init(&pool->worker_ida); 311529c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 311629c91e99STejun Heo pool->refcnt = 1; 311729c91e99STejun Heo 311829c91e99STejun Heo /* shouldn't fail above this point */ 31197a4e344cSTejun Heo pool->attrs = alloc_workqueue_attrs(GFP_KERNEL); 31207a4e344cSTejun Heo if (!pool->attrs) 31217a4e344cSTejun Heo return -ENOMEM; 31227a4e344cSTejun Heo return 0; 31234e1a1f9aSTejun Heo } 31244e1a1f9aSTejun Heo 3125e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu) 3126e2dca7adSTejun Heo { 3127e2dca7adSTejun Heo struct workqueue_struct *wq = 3128e2dca7adSTejun Heo container_of(rcu, struct workqueue_struct, rcu); 3129e2dca7adSTejun Heo 3130e2dca7adSTejun Heo if (!(wq->flags & WQ_UNBOUND)) 3131e2dca7adSTejun Heo free_percpu(wq->cpu_pwqs); 3132e2dca7adSTejun Heo else 3133e2dca7adSTejun Heo free_workqueue_attrs(wq->unbound_attrs); 3134e2dca7adSTejun Heo 3135e2dca7adSTejun Heo kfree(wq->rescuer); 3136e2dca7adSTejun Heo kfree(wq); 3137e2dca7adSTejun Heo } 3138e2dca7adSTejun Heo 313929c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 314029c91e99STejun Heo { 314129c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 314229c91e99STejun Heo 31437cda9aaeSLai Jiangshan ida_destroy(&pool->worker_ida); 314429c91e99STejun Heo free_workqueue_attrs(pool->attrs); 314529c91e99STejun Heo kfree(pool); 314629c91e99STejun Heo } 314729c91e99STejun Heo 314829c91e99STejun Heo /** 314929c91e99STejun Heo * put_unbound_pool - put a worker_pool 315029c91e99STejun Heo * @pool: worker_pool to put 315129c91e99STejun Heo * 315229c91e99STejun Heo * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU 3153c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 3154c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 3155c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 3156a892caccSTejun Heo * 3157a892caccSTejun Heo * Should be called with wq_pool_mutex held. 315829c91e99STejun Heo */ 315929c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 316029c91e99STejun Heo { 316160f5a4bcSLai Jiangshan DECLARE_COMPLETION_ONSTACK(detach_completion); 316229c91e99STejun Heo struct worker *worker; 316329c91e99STejun Heo 3164a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3165a892caccSTejun Heo 3166a892caccSTejun Heo if (--pool->refcnt) 316729c91e99STejun Heo return; 316829c91e99STejun Heo 316929c91e99STejun Heo /* sanity checks */ 317061d0fbb4SLai Jiangshan if (WARN_ON(!(pool->cpu < 0)) || 3171a892caccSTejun Heo WARN_ON(!list_empty(&pool->worklist))) 317229c91e99STejun Heo return; 317329c91e99STejun Heo 317429c91e99STejun Heo /* release id and unhash */ 317529c91e99STejun Heo if (pool->id >= 0) 317629c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 317729c91e99STejun Heo hash_del(&pool->hash_node); 317829c91e99STejun Heo 3179c5aa87bbSTejun Heo /* 3180c5aa87bbSTejun Heo * Become the manager and destroy all workers. Grabbing 3181c5aa87bbSTejun Heo * manager_arb prevents @pool's workers from blocking on 318292f9c5c4SLai Jiangshan * attach_mutex. 3183c5aa87bbSTejun Heo */ 318429c91e99STejun Heo mutex_lock(&pool->manager_arb); 318529c91e99STejun Heo 318660f5a4bcSLai Jiangshan spin_lock_irq(&pool->lock); 31871037de36SLai Jiangshan while ((worker = first_idle_worker(pool))) 318829c91e99STejun Heo destroy_worker(worker); 318929c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 319029c91e99STejun Heo spin_unlock_irq(&pool->lock); 319160f5a4bcSLai Jiangshan 319292f9c5c4SLai Jiangshan mutex_lock(&pool->attach_mutex); 3193da028469SLai Jiangshan if (!list_empty(&pool->workers)) 319460f5a4bcSLai Jiangshan pool->detach_completion = &detach_completion; 319592f9c5c4SLai Jiangshan mutex_unlock(&pool->attach_mutex); 319660f5a4bcSLai Jiangshan 319760f5a4bcSLai Jiangshan if (pool->detach_completion) 319860f5a4bcSLai Jiangshan wait_for_completion(pool->detach_completion); 319960f5a4bcSLai Jiangshan 320029c91e99STejun Heo mutex_unlock(&pool->manager_arb); 320129c91e99STejun Heo 320229c91e99STejun Heo /* shut down the timers */ 320329c91e99STejun Heo del_timer_sync(&pool->idle_timer); 320429c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 320529c91e99STejun Heo 320629c91e99STejun Heo /* sched-RCU protected to allow dereferences from get_work_pool() */ 320729c91e99STejun Heo call_rcu_sched(&pool->rcu, rcu_free_pool); 320829c91e99STejun Heo } 320929c91e99STejun Heo 321029c91e99STejun Heo /** 321129c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 321229c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 321329c91e99STejun Heo * 321429c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 321529c91e99STejun Heo * reference count and return it. If there already is a matching 321629c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 3217d185af30SYacine Belkadi * create a new one. 3218a892caccSTejun Heo * 3219a892caccSTejun Heo * Should be called with wq_pool_mutex held. 3220d185af30SYacine Belkadi * 3221d185af30SYacine Belkadi * Return: On success, a worker_pool with the same attributes as @attrs. 3222d185af30SYacine Belkadi * On failure, %NULL. 322329c91e99STejun Heo */ 322429c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 322529c91e99STejun Heo { 322629c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 322729c91e99STejun Heo struct worker_pool *pool; 3228f3f90ad4STejun Heo int node; 322929c91e99STejun Heo 3230a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 323129c91e99STejun Heo 323229c91e99STejun Heo /* do we already have a matching pool? */ 323329c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 323429c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 323529c91e99STejun Heo pool->refcnt++; 32363fb1823cSLai Jiangshan return pool; 323729c91e99STejun Heo } 323829c91e99STejun Heo } 323929c91e99STejun Heo 324029c91e99STejun Heo /* nope, create a new one */ 324129c91e99STejun Heo pool = kzalloc(sizeof(*pool), GFP_KERNEL); 324229c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 324329c91e99STejun Heo goto fail; 324429c91e99STejun Heo 32458864b4e5STejun Heo lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */ 324629c91e99STejun Heo copy_workqueue_attrs(pool->attrs, attrs); 324729c91e99STejun Heo 32482865a8fbSShaohua Li /* 32492865a8fbSShaohua Li * no_numa isn't a worker_pool attribute, always clear it. See 32502865a8fbSShaohua Li * 'struct workqueue_attrs' comments for detail. 32512865a8fbSShaohua Li */ 32522865a8fbSShaohua Li pool->attrs->no_numa = false; 32532865a8fbSShaohua Li 3254f3f90ad4STejun Heo /* if cpumask is contained inside a NUMA node, we belong to that node */ 3255f3f90ad4STejun Heo if (wq_numa_enabled) { 3256f3f90ad4STejun Heo for_each_node(node) { 3257f3f90ad4STejun Heo if (cpumask_subset(pool->attrs->cpumask, 3258f3f90ad4STejun Heo wq_numa_possible_cpumask[node])) { 3259f3f90ad4STejun Heo pool->node = node; 3260f3f90ad4STejun Heo break; 3261f3f90ad4STejun Heo } 3262f3f90ad4STejun Heo } 3263f3f90ad4STejun Heo } 3264f3f90ad4STejun Heo 326529c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 326629c91e99STejun Heo goto fail; 326729c91e99STejun Heo 326829c91e99STejun Heo /* create and start the initial worker */ 3269051e1850SLai Jiangshan if (!create_worker(pool)) 327029c91e99STejun Heo goto fail; 327129c91e99STejun Heo 327229c91e99STejun Heo /* install */ 327329c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 32743fb1823cSLai Jiangshan 327529c91e99STejun Heo return pool; 327629c91e99STejun Heo fail: 327729c91e99STejun Heo if (pool) 327829c91e99STejun Heo put_unbound_pool(pool); 327929c91e99STejun Heo return NULL; 328029c91e99STejun Heo } 328129c91e99STejun Heo 32828864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu) 32838864b4e5STejun Heo { 32848864b4e5STejun Heo kmem_cache_free(pwq_cache, 32858864b4e5STejun Heo container_of(rcu, struct pool_workqueue, rcu)); 32868864b4e5STejun Heo } 32878864b4e5STejun Heo 32888864b4e5STejun Heo /* 32898864b4e5STejun Heo * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt 32908864b4e5STejun Heo * and needs to be destroyed. 32918864b4e5STejun Heo */ 32928864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work) 32938864b4e5STejun Heo { 32948864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 32958864b4e5STejun Heo unbound_release_work); 32968864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 32978864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 3298bc0caf09STejun Heo bool is_last; 32998864b4e5STejun Heo 33008864b4e5STejun Heo if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND))) 33018864b4e5STejun Heo return; 33028864b4e5STejun Heo 33033c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 33048864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 3305bc0caf09STejun Heo is_last = list_empty(&wq->pwqs); 33063c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 33078864b4e5STejun Heo 3308a892caccSTejun Heo mutex_lock(&wq_pool_mutex); 33098864b4e5STejun Heo put_unbound_pool(pool); 3310a892caccSTejun Heo mutex_unlock(&wq_pool_mutex); 3311a892caccSTejun Heo 33128864b4e5STejun Heo call_rcu_sched(&pwq->rcu, rcu_free_pwq); 33138864b4e5STejun Heo 33148864b4e5STejun Heo /* 33158864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 3316e2dca7adSTejun Heo * is gonna access it anymore. Schedule RCU free. 33178864b4e5STejun Heo */ 3318e2dca7adSTejun Heo if (is_last) 3319e2dca7adSTejun Heo call_rcu_sched(&wq->rcu, rcu_free_wq); 33206029a918STejun Heo } 33218864b4e5STejun Heo 33220fbd95aaSTejun Heo /** 3323699ce097STejun Heo * pwq_adjust_max_active - update a pwq's max_active to the current setting 33240fbd95aaSTejun Heo * @pwq: target pool_workqueue 33250fbd95aaSTejun Heo * 3326699ce097STejun Heo * If @pwq isn't freezing, set @pwq->max_active to the associated 3327699ce097STejun Heo * workqueue's saved_max_active and activate delayed work items 3328699ce097STejun Heo * accordingly. If @pwq is freezing, clear @pwq->max_active to zero. 33290fbd95aaSTejun Heo */ 3330699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq) 33310fbd95aaSTejun Heo { 3332699ce097STejun Heo struct workqueue_struct *wq = pwq->wq; 3333699ce097STejun Heo bool freezable = wq->flags & WQ_FREEZABLE; 3334699ce097STejun Heo 3335699ce097STejun Heo /* for @wq->saved_max_active */ 3336a357fc03SLai Jiangshan lockdep_assert_held(&wq->mutex); 3337699ce097STejun Heo 3338699ce097STejun Heo /* fast exit for non-freezable wqs */ 3339699ce097STejun Heo if (!freezable && pwq->max_active == wq->saved_max_active) 3340699ce097STejun Heo return; 3341699ce097STejun Heo 3342a357fc03SLai Jiangshan spin_lock_irq(&pwq->pool->lock); 3343699ce097STejun Heo 334474b414eaSLai Jiangshan /* 334574b414eaSLai Jiangshan * During [un]freezing, the caller is responsible for ensuring that 334674b414eaSLai Jiangshan * this function is called at least once after @workqueue_freezing 334774b414eaSLai Jiangshan * is updated and visible. 334874b414eaSLai Jiangshan */ 334974b414eaSLai Jiangshan if (!freezable || !workqueue_freezing) { 3350699ce097STejun Heo pwq->max_active = wq->saved_max_active; 33510fbd95aaSTejun Heo 33520fbd95aaSTejun Heo while (!list_empty(&pwq->delayed_works) && 33530fbd95aaSTejun Heo pwq->nr_active < pwq->max_active) 33540fbd95aaSTejun Heo pwq_activate_first_delayed(pwq); 3355951a078aSLai Jiangshan 3356951a078aSLai Jiangshan /* 3357951a078aSLai Jiangshan * Need to kick a worker after thawed or an unbound wq's 3358951a078aSLai Jiangshan * max_active is bumped. It's a slow path. Do it always. 3359951a078aSLai Jiangshan */ 3360951a078aSLai Jiangshan wake_up_worker(pwq->pool); 3361699ce097STejun Heo } else { 3362699ce097STejun Heo pwq->max_active = 0; 3363699ce097STejun Heo } 3364699ce097STejun Heo 3365a357fc03SLai Jiangshan spin_unlock_irq(&pwq->pool->lock); 33660fbd95aaSTejun Heo } 33670fbd95aaSTejun Heo 3368e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */ 3369f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, 3370f147f29eSTejun Heo struct worker_pool *pool) 3371d2c1d404STejun Heo { 3372d2c1d404STejun Heo BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); 3373d2c1d404STejun Heo 3374e50aba9aSTejun Heo memset(pwq, 0, sizeof(*pwq)); 3375e50aba9aSTejun Heo 3376d2c1d404STejun Heo pwq->pool = pool; 3377d2c1d404STejun Heo pwq->wq = wq; 3378d2c1d404STejun Heo pwq->flush_color = -1; 33798864b4e5STejun Heo pwq->refcnt = 1; 3380d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->delayed_works); 33811befcf30STejun Heo INIT_LIST_HEAD(&pwq->pwqs_node); 3382d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 33838864b4e5STejun Heo INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn); 3384f147f29eSTejun Heo } 3385d2c1d404STejun Heo 3386f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */ 33871befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq) 3388f147f29eSTejun Heo { 3389f147f29eSTejun Heo struct workqueue_struct *wq = pwq->wq; 3390f147f29eSTejun Heo 3391f147f29eSTejun Heo lockdep_assert_held(&wq->mutex); 339275ccf595STejun Heo 33931befcf30STejun Heo /* may be called multiple times, ignore if already linked */ 33941befcf30STejun Heo if (!list_empty(&pwq->pwqs_node)) 33951befcf30STejun Heo return; 33961befcf30STejun Heo 339729b1cb41SLai Jiangshan /* set the matching work_color */ 339875ccf595STejun Heo pwq->work_color = wq->work_color; 3399983ca25eSTejun Heo 3400983ca25eSTejun Heo /* sync max_active to the current setting */ 3401983ca25eSTejun Heo pwq_adjust_max_active(pwq); 3402983ca25eSTejun Heo 3403983ca25eSTejun Heo /* link in @pwq */ 34049e8cd2f5STejun Heo list_add_rcu(&pwq->pwqs_node, &wq->pwqs); 3405df2d5ae4STejun Heo } 34066029a918STejun Heo 3407f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ 3408f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, 3409f147f29eSTejun Heo const struct workqueue_attrs *attrs) 3410f147f29eSTejun Heo { 3411f147f29eSTejun Heo struct worker_pool *pool; 3412f147f29eSTejun Heo struct pool_workqueue *pwq; 3413f147f29eSTejun Heo 3414f147f29eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3415f147f29eSTejun Heo 3416f147f29eSTejun Heo pool = get_unbound_pool(attrs); 3417f147f29eSTejun Heo if (!pool) 3418f147f29eSTejun Heo return NULL; 3419f147f29eSTejun Heo 3420e50aba9aSTejun Heo pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); 3421f147f29eSTejun Heo if (!pwq) { 3422f147f29eSTejun Heo put_unbound_pool(pool); 3423f147f29eSTejun Heo return NULL; 3424f147f29eSTejun Heo } 3425f147f29eSTejun Heo 3426f147f29eSTejun Heo init_pwq(pwq, wq, pool); 3427f147f29eSTejun Heo return pwq; 3428d2c1d404STejun Heo } 3429d2c1d404STejun Heo 34304c16bd32STejun Heo /** 34314c16bd32STejun Heo * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node 3432*042f7df1SLai Jiangshan * @attrs: the wq_attrs of the default pwq of the target workqueue 34334c16bd32STejun Heo * @node: the target NUMA node 34344c16bd32STejun Heo * @cpu_going_down: if >= 0, the CPU to consider as offline 34354c16bd32STejun Heo * @cpumask: outarg, the resulting cpumask 34364c16bd32STejun Heo * 34374c16bd32STejun Heo * Calculate the cpumask a workqueue with @attrs should use on @node. If 34384c16bd32STejun Heo * @cpu_going_down is >= 0, that cpu is considered offline during 3439d185af30SYacine Belkadi * calculation. The result is stored in @cpumask. 34404c16bd32STejun Heo * 34414c16bd32STejun Heo * If NUMA affinity is not enabled, @attrs->cpumask is always used. If 34424c16bd32STejun Heo * enabled and @node has online CPUs requested by @attrs, the returned 34434c16bd32STejun Heo * cpumask is the intersection of the possible CPUs of @node and 34444c16bd32STejun Heo * @attrs->cpumask. 34454c16bd32STejun Heo * 34464c16bd32STejun Heo * The caller is responsible for ensuring that the cpumask of @node stays 34474c16bd32STejun Heo * stable. 3448d185af30SYacine Belkadi * 3449d185af30SYacine Belkadi * Return: %true if the resulting @cpumask is different from @attrs->cpumask, 3450d185af30SYacine Belkadi * %false if equal. 34514c16bd32STejun Heo */ 34524c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node, 34534c16bd32STejun Heo int cpu_going_down, cpumask_t *cpumask) 34544c16bd32STejun Heo { 3455d55262c4STejun Heo if (!wq_numa_enabled || attrs->no_numa) 34564c16bd32STejun Heo goto use_dfl; 34574c16bd32STejun Heo 34584c16bd32STejun Heo /* does @node have any online CPUs @attrs wants? */ 34594c16bd32STejun Heo cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask); 34604c16bd32STejun Heo if (cpu_going_down >= 0) 34614c16bd32STejun Heo cpumask_clear_cpu(cpu_going_down, cpumask); 34624c16bd32STejun Heo 34634c16bd32STejun Heo if (cpumask_empty(cpumask)) 34644c16bd32STejun Heo goto use_dfl; 34654c16bd32STejun Heo 34664c16bd32STejun Heo /* yeap, return possible CPUs in @node that @attrs wants */ 34674c16bd32STejun Heo cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]); 34684c16bd32STejun Heo return !cpumask_equal(cpumask, attrs->cpumask); 34694c16bd32STejun Heo 34704c16bd32STejun Heo use_dfl: 34714c16bd32STejun Heo cpumask_copy(cpumask, attrs->cpumask); 34724c16bd32STejun Heo return false; 34734c16bd32STejun Heo } 34744c16bd32STejun Heo 34751befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */ 34761befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq, 34771befcf30STejun Heo int node, 34781befcf30STejun Heo struct pool_workqueue *pwq) 34791befcf30STejun Heo { 34801befcf30STejun Heo struct pool_workqueue *old_pwq; 34811befcf30STejun Heo 34821befcf30STejun Heo lockdep_assert_held(&wq->mutex); 34831befcf30STejun Heo 34841befcf30STejun Heo /* link_pwq() can handle duplicate calls */ 34851befcf30STejun Heo link_pwq(pwq); 34861befcf30STejun Heo 34871befcf30STejun Heo old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); 34881befcf30STejun Heo rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq); 34891befcf30STejun Heo return old_pwq; 34901befcf30STejun Heo } 34911befcf30STejun Heo 34922d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */ 34932d5f0764SLai Jiangshan struct apply_wqattrs_ctx { 34942d5f0764SLai Jiangshan struct workqueue_struct *wq; /* target workqueue */ 34952d5f0764SLai Jiangshan struct workqueue_attrs *attrs; /* attrs to apply */ 3496*042f7df1SLai Jiangshan struct list_head list; /* queued for batching commit */ 34972d5f0764SLai Jiangshan struct pool_workqueue *dfl_pwq; 34982d5f0764SLai Jiangshan struct pool_workqueue *pwq_tbl[]; 34992d5f0764SLai Jiangshan }; 35002d5f0764SLai Jiangshan 35012d5f0764SLai Jiangshan /* free the resources after success or abort */ 35022d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx) 35032d5f0764SLai Jiangshan { 35042d5f0764SLai Jiangshan if (ctx) { 35052d5f0764SLai Jiangshan int node; 35062d5f0764SLai Jiangshan 35072d5f0764SLai Jiangshan for_each_node(node) 35082d5f0764SLai Jiangshan put_pwq_unlocked(ctx->pwq_tbl[node]); 35092d5f0764SLai Jiangshan put_pwq_unlocked(ctx->dfl_pwq); 35102d5f0764SLai Jiangshan 35112d5f0764SLai Jiangshan free_workqueue_attrs(ctx->attrs); 35122d5f0764SLai Jiangshan 35132d5f0764SLai Jiangshan kfree(ctx); 35142d5f0764SLai Jiangshan } 35152d5f0764SLai Jiangshan } 35162d5f0764SLai Jiangshan 35172d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */ 35182d5f0764SLai Jiangshan static struct apply_wqattrs_ctx * 35192d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq, 35202d5f0764SLai Jiangshan const struct workqueue_attrs *attrs) 35212d5f0764SLai Jiangshan { 35222d5f0764SLai Jiangshan struct apply_wqattrs_ctx *ctx; 35232d5f0764SLai Jiangshan struct workqueue_attrs *new_attrs, *tmp_attrs; 35242d5f0764SLai Jiangshan int node; 35252d5f0764SLai Jiangshan 35262d5f0764SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 35272d5f0764SLai Jiangshan 35282d5f0764SLai Jiangshan ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]), 35292d5f0764SLai Jiangshan GFP_KERNEL); 35302d5f0764SLai Jiangshan 35312d5f0764SLai Jiangshan new_attrs = alloc_workqueue_attrs(GFP_KERNEL); 35322d5f0764SLai Jiangshan tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL); 35332d5f0764SLai Jiangshan if (!ctx || !new_attrs || !tmp_attrs) 35342d5f0764SLai Jiangshan goto out_free; 35352d5f0764SLai Jiangshan 3536*042f7df1SLai Jiangshan /* 3537*042f7df1SLai Jiangshan * Calculate the attrs of the default pwq. 3538*042f7df1SLai Jiangshan * If the user configured cpumask doesn't overlap with the 3539*042f7df1SLai Jiangshan * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask. 3540*042f7df1SLai Jiangshan */ 35412d5f0764SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 3542b05a7928SFrederic Weisbecker cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask); 3543*042f7df1SLai Jiangshan if (unlikely(cpumask_empty(new_attrs->cpumask))) 3544*042f7df1SLai Jiangshan cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask); 35452d5f0764SLai Jiangshan 35462d5f0764SLai Jiangshan /* 35472d5f0764SLai Jiangshan * We may create multiple pwqs with differing cpumasks. Make a 35482d5f0764SLai Jiangshan * copy of @new_attrs which will be modified and used to obtain 35492d5f0764SLai Jiangshan * pools. 35502d5f0764SLai Jiangshan */ 35512d5f0764SLai Jiangshan copy_workqueue_attrs(tmp_attrs, new_attrs); 35522d5f0764SLai Jiangshan 35532d5f0764SLai Jiangshan /* 35542d5f0764SLai Jiangshan * If something goes wrong during CPU up/down, we'll fall back to 35552d5f0764SLai Jiangshan * the default pwq covering whole @attrs->cpumask. Always create 35562d5f0764SLai Jiangshan * it even if we don't use it immediately. 35572d5f0764SLai Jiangshan */ 35582d5f0764SLai Jiangshan ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs); 35592d5f0764SLai Jiangshan if (!ctx->dfl_pwq) 35602d5f0764SLai Jiangshan goto out_free; 35612d5f0764SLai Jiangshan 35622d5f0764SLai Jiangshan for_each_node(node) { 3563*042f7df1SLai Jiangshan if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) { 35642d5f0764SLai Jiangshan ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs); 35652d5f0764SLai Jiangshan if (!ctx->pwq_tbl[node]) 35662d5f0764SLai Jiangshan goto out_free; 35672d5f0764SLai Jiangshan } else { 35682d5f0764SLai Jiangshan ctx->dfl_pwq->refcnt++; 35692d5f0764SLai Jiangshan ctx->pwq_tbl[node] = ctx->dfl_pwq; 35702d5f0764SLai Jiangshan } 35712d5f0764SLai Jiangshan } 35722d5f0764SLai Jiangshan 3573*042f7df1SLai Jiangshan /* save the user configured attrs and sanitize it. */ 3574*042f7df1SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 3575*042f7df1SLai Jiangshan cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); 35762d5f0764SLai Jiangshan ctx->attrs = new_attrs; 3577*042f7df1SLai Jiangshan 35782d5f0764SLai Jiangshan ctx->wq = wq; 35792d5f0764SLai Jiangshan free_workqueue_attrs(tmp_attrs); 35802d5f0764SLai Jiangshan return ctx; 35812d5f0764SLai Jiangshan 35822d5f0764SLai Jiangshan out_free: 35832d5f0764SLai Jiangshan free_workqueue_attrs(tmp_attrs); 35842d5f0764SLai Jiangshan free_workqueue_attrs(new_attrs); 35852d5f0764SLai Jiangshan apply_wqattrs_cleanup(ctx); 35862d5f0764SLai Jiangshan return NULL; 35872d5f0764SLai Jiangshan } 35882d5f0764SLai Jiangshan 35892d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */ 35902d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx) 35912d5f0764SLai Jiangshan { 35922d5f0764SLai Jiangshan int node; 35932d5f0764SLai Jiangshan 35942d5f0764SLai Jiangshan /* all pwqs have been created successfully, let's install'em */ 35952d5f0764SLai Jiangshan mutex_lock(&ctx->wq->mutex); 35962d5f0764SLai Jiangshan 35972d5f0764SLai Jiangshan copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs); 35982d5f0764SLai Jiangshan 35992d5f0764SLai Jiangshan /* save the previous pwq and install the new one */ 36002d5f0764SLai Jiangshan for_each_node(node) 36012d5f0764SLai Jiangshan ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node, 36022d5f0764SLai Jiangshan ctx->pwq_tbl[node]); 36032d5f0764SLai Jiangshan 36042d5f0764SLai Jiangshan /* @dfl_pwq might not have been used, ensure it's linked */ 36052d5f0764SLai Jiangshan link_pwq(ctx->dfl_pwq); 36062d5f0764SLai Jiangshan swap(ctx->wq->dfl_pwq, ctx->dfl_pwq); 36072d5f0764SLai Jiangshan 36082d5f0764SLai Jiangshan mutex_unlock(&ctx->wq->mutex); 36092d5f0764SLai Jiangshan } 36102d5f0764SLai Jiangshan 36119e8cd2f5STejun Heo /** 36129e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 36139e8cd2f5STejun Heo * @wq: the target workqueue 36149e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 36159e8cd2f5STejun Heo * 36164c16bd32STejun Heo * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA 36174c16bd32STejun Heo * machines, this function maps a separate pwq to each NUMA node with 36184c16bd32STejun Heo * possibles CPUs in @attrs->cpumask so that work items are affine to the 36194c16bd32STejun Heo * NUMA node it was issued on. Older pwqs are released as in-flight work 36204c16bd32STejun Heo * items finish. Note that a work item which repeatedly requeues itself 36214c16bd32STejun Heo * back-to-back will stay on its current pwq. 36229e8cd2f5STejun Heo * 3623d185af30SYacine Belkadi * Performs GFP_KERNEL allocations. 3624d185af30SYacine Belkadi * 3625d185af30SYacine Belkadi * Return: 0 on success and -errno on failure. 36269e8cd2f5STejun Heo */ 36279e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq, 36289e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 36299e8cd2f5STejun Heo { 36302d5f0764SLai Jiangshan struct apply_wqattrs_ctx *ctx; 36312d5f0764SLai Jiangshan int ret = -ENOMEM; 36329e8cd2f5STejun Heo 36338719dceaSTejun Heo /* only unbound workqueues can change attributes */ 36349e8cd2f5STejun Heo if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 36359e8cd2f5STejun Heo return -EINVAL; 36369e8cd2f5STejun Heo 36378719dceaSTejun Heo /* creating multiple pwqs breaks ordering guarantee */ 36388719dceaSTejun Heo if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs))) 36398719dceaSTejun Heo return -EINVAL; 36408719dceaSTejun Heo 36414c16bd32STejun Heo /* 36424c16bd32STejun Heo * CPUs should stay stable across pwq creations and installations. 36434c16bd32STejun Heo * Pin CPUs, determine the target cpumask for each node and create 36444c16bd32STejun Heo * pwqs accordingly. 36454c16bd32STejun Heo */ 36464c16bd32STejun Heo get_online_cpus(); 36474c16bd32STejun Heo 36484c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 36492d5f0764SLai Jiangshan ctx = apply_wqattrs_prepare(wq, attrs); 36504c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 36514c16bd32STejun Heo 36522d5f0764SLai Jiangshan /* the ctx has been prepared successfully, let's commit it */ 36532d5f0764SLai Jiangshan if (ctx) { 36542d5f0764SLai Jiangshan apply_wqattrs_commit(ctx); 36554862125bSTejun Heo ret = 0; 36562d5f0764SLai Jiangshan } 365713e2e556STejun Heo 36584c16bd32STejun Heo put_online_cpus(); 36592d5f0764SLai Jiangshan 36602d5f0764SLai Jiangshan apply_wqattrs_cleanup(ctx); 36612d5f0764SLai Jiangshan 36622d5f0764SLai Jiangshan return ret; 36639e8cd2f5STejun Heo } 36649e8cd2f5STejun Heo 36654c16bd32STejun Heo /** 36664c16bd32STejun Heo * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug 36674c16bd32STejun Heo * @wq: the target workqueue 36684c16bd32STejun Heo * @cpu: the CPU coming up or going down 36694c16bd32STejun Heo * @online: whether @cpu is coming up or going down 36704c16bd32STejun Heo * 36714c16bd32STejun Heo * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and 36724c16bd32STejun Heo * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of 36734c16bd32STejun Heo * @wq accordingly. 36744c16bd32STejun Heo * 36754c16bd32STejun Heo * If NUMA affinity can't be adjusted due to memory allocation failure, it 36764c16bd32STejun Heo * falls back to @wq->dfl_pwq which may not be optimal but is always 36774c16bd32STejun Heo * correct. 36784c16bd32STejun Heo * 36794c16bd32STejun Heo * Note that when the last allowed CPU of a NUMA node goes offline for a 36804c16bd32STejun Heo * workqueue with a cpumask spanning multiple nodes, the workers which were 36814c16bd32STejun Heo * already executing the work items for the workqueue will lose their CPU 36824c16bd32STejun Heo * affinity and may execute on any CPU. This is similar to how per-cpu 36834c16bd32STejun Heo * workqueues behave on CPU_DOWN. If a workqueue user wants strict 36844c16bd32STejun Heo * affinity, it's the user's responsibility to flush the work item from 36854c16bd32STejun Heo * CPU_DOWN_PREPARE. 36864c16bd32STejun Heo */ 36874c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu, 36884c16bd32STejun Heo bool online) 36894c16bd32STejun Heo { 36904c16bd32STejun Heo int node = cpu_to_node(cpu); 36914c16bd32STejun Heo int cpu_off = online ? -1 : cpu; 36924c16bd32STejun Heo struct pool_workqueue *old_pwq = NULL, *pwq; 36934c16bd32STejun Heo struct workqueue_attrs *target_attrs; 36944c16bd32STejun Heo cpumask_t *cpumask; 36954c16bd32STejun Heo 36964c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 36974c16bd32STejun Heo 36984c16bd32STejun Heo if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND)) 36994c16bd32STejun Heo return; 37004c16bd32STejun Heo 37014c16bd32STejun Heo /* 37024c16bd32STejun Heo * We don't wanna alloc/free wq_attrs for each wq for each CPU. 37034c16bd32STejun Heo * Let's use a preallocated one. The following buf is protected by 37044c16bd32STejun Heo * CPU hotplug exclusion. 37054c16bd32STejun Heo */ 37064c16bd32STejun Heo target_attrs = wq_update_unbound_numa_attrs_buf; 37074c16bd32STejun Heo cpumask = target_attrs->cpumask; 37084c16bd32STejun Heo 37094c16bd32STejun Heo mutex_lock(&wq->mutex); 3710d55262c4STejun Heo if (wq->unbound_attrs->no_numa) 3711d55262c4STejun Heo goto out_unlock; 37124c16bd32STejun Heo 37134c16bd32STejun Heo copy_workqueue_attrs(target_attrs, wq->unbound_attrs); 37144c16bd32STejun Heo pwq = unbound_pwq_by_node(wq, node); 37154c16bd32STejun Heo 37164c16bd32STejun Heo /* 37174c16bd32STejun Heo * Let's determine what needs to be done. If the target cpumask is 3718*042f7df1SLai Jiangshan * different from the default pwq's, we need to compare it to @pwq's 3719*042f7df1SLai Jiangshan * and create a new one if they don't match. If the target cpumask 3720*042f7df1SLai Jiangshan * equals the default pwq's, the default pwq should be used. 37214c16bd32STejun Heo */ 3722*042f7df1SLai Jiangshan if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) { 37234c16bd32STejun Heo if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask)) 37244c16bd32STejun Heo goto out_unlock; 37254c16bd32STejun Heo } else { 37264c16bd32STejun Heo goto use_dfl_pwq; 37274c16bd32STejun Heo } 37284c16bd32STejun Heo 37294c16bd32STejun Heo mutex_unlock(&wq->mutex); 37304c16bd32STejun Heo 37314c16bd32STejun Heo /* create a new pwq */ 37324c16bd32STejun Heo pwq = alloc_unbound_pwq(wq, target_attrs); 37334c16bd32STejun Heo if (!pwq) { 37342d916033SFabian Frederick pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n", 37354c16bd32STejun Heo wq->name); 373677f300b1SDaeseok Youn mutex_lock(&wq->mutex); 373777f300b1SDaeseok Youn goto use_dfl_pwq; 37384c16bd32STejun Heo } 37394c16bd32STejun Heo 37404c16bd32STejun Heo /* 37414c16bd32STejun Heo * Install the new pwq. As this function is called only from CPU 37424c16bd32STejun Heo * hotplug callbacks and applying a new attrs is wrapped with 37434c16bd32STejun Heo * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed 37444c16bd32STejun Heo * inbetween. 37454c16bd32STejun Heo */ 37464c16bd32STejun Heo mutex_lock(&wq->mutex); 37474c16bd32STejun Heo old_pwq = numa_pwq_tbl_install(wq, node, pwq); 37484c16bd32STejun Heo goto out_unlock; 37494c16bd32STejun Heo 37504c16bd32STejun Heo use_dfl_pwq: 37514c16bd32STejun Heo spin_lock_irq(&wq->dfl_pwq->pool->lock); 37524c16bd32STejun Heo get_pwq(wq->dfl_pwq); 37534c16bd32STejun Heo spin_unlock_irq(&wq->dfl_pwq->pool->lock); 37544c16bd32STejun Heo old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq); 37554c16bd32STejun Heo out_unlock: 37564c16bd32STejun Heo mutex_unlock(&wq->mutex); 37574c16bd32STejun Heo put_pwq_unlocked(old_pwq); 37584c16bd32STejun Heo } 37594c16bd32STejun Heo 376030cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 37611da177e4SLinus Torvalds { 376249e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 37638a2b7538STejun Heo int cpu, ret; 3764e1d8aa9fSFrederic Weisbecker 376530cdf249STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 3766420c0ddbSTejun Heo wq->cpu_pwqs = alloc_percpu(struct pool_workqueue); 3767420c0ddbSTejun Heo if (!wq->cpu_pwqs) 376830cdf249STejun Heo return -ENOMEM; 376930cdf249STejun Heo 377030cdf249STejun Heo for_each_possible_cpu(cpu) { 37717fb98ea7STejun Heo struct pool_workqueue *pwq = 37727fb98ea7STejun Heo per_cpu_ptr(wq->cpu_pwqs, cpu); 37737a62c2c8STejun Heo struct worker_pool *cpu_pools = 3774f02ae73aSTejun Heo per_cpu(cpu_worker_pools, cpu); 377530cdf249STejun Heo 3776f147f29eSTejun Heo init_pwq(pwq, wq, &cpu_pools[highpri]); 3777f147f29eSTejun Heo 3778f147f29eSTejun Heo mutex_lock(&wq->mutex); 37791befcf30STejun Heo link_pwq(pwq); 3780f147f29eSTejun Heo mutex_unlock(&wq->mutex); 378130cdf249STejun Heo } 378230cdf249STejun Heo return 0; 37838a2b7538STejun Heo } else if (wq->flags & __WQ_ORDERED) { 37848a2b7538STejun Heo ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]); 37858a2b7538STejun Heo /* there should only be single pwq for ordering guarantee */ 37868a2b7538STejun Heo WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node || 37878a2b7538STejun Heo wq->pwqs.prev != &wq->dfl_pwq->pwqs_node), 37888a2b7538STejun Heo "ordering guarantee broken for workqueue %s\n", wq->name); 37898a2b7538STejun Heo return ret; 37909e8cd2f5STejun Heo } else { 37919e8cd2f5STejun Heo return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); 37929e8cd2f5STejun Heo } 37930f900049STejun Heo } 37940f900049STejun Heo 3795f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 3796f3421797STejun Heo const char *name) 3797b71ab8c2STejun Heo { 3798f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 3799f3421797STejun Heo 3800f3421797STejun Heo if (max_active < 1 || max_active > lim) 3801044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 3802f3421797STejun Heo max_active, name, 1, lim); 3803b71ab8c2STejun Heo 3804f3421797STejun Heo return clamp_val(max_active, 1, lim); 3805b71ab8c2STejun Heo } 3806b71ab8c2STejun Heo 3807b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt, 380897e37d7bSTejun Heo unsigned int flags, 38091e19ffc6STejun Heo int max_active, 3810eb13ba87SJohannes Berg struct lock_class_key *key, 3811b196be89STejun Heo const char *lock_name, ...) 38123af24433SOleg Nesterov { 3813df2d5ae4STejun Heo size_t tbl_size = 0; 3814ecf6881fSTejun Heo va_list args; 38153af24433SOleg Nesterov struct workqueue_struct *wq; 381649e3cf44STejun Heo struct pool_workqueue *pwq; 3817b196be89STejun Heo 3818cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 3819cee22a15SViresh Kumar if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) 3820cee22a15SViresh Kumar flags |= WQ_UNBOUND; 3821cee22a15SViresh Kumar 3822ecf6881fSTejun Heo /* allocate wq and format name */ 3823df2d5ae4STejun Heo if (flags & WQ_UNBOUND) 3824ddcb57e2SLai Jiangshan tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]); 3825df2d5ae4STejun Heo 3826df2d5ae4STejun Heo wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL); 3827b196be89STejun Heo if (!wq) 3828d2c1d404STejun Heo return NULL; 3829b196be89STejun Heo 38306029a918STejun Heo if (flags & WQ_UNBOUND) { 38316029a918STejun Heo wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL); 38326029a918STejun Heo if (!wq->unbound_attrs) 38336029a918STejun Heo goto err_free_wq; 38346029a918STejun Heo } 38356029a918STejun Heo 3836ecf6881fSTejun Heo va_start(args, lock_name); 3837ecf6881fSTejun Heo vsnprintf(wq->name, sizeof(wq->name), fmt, args); 3838b196be89STejun Heo va_end(args); 38393af24433SOleg Nesterov 3840d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 3841b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 38423af24433SOleg Nesterov 3843b196be89STejun Heo /* init wq */ 384497e37d7bSTejun Heo wq->flags = flags; 3845a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 38463c25a55dSLai Jiangshan mutex_init(&wq->mutex); 3847112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 384830cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 384973f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 385073f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 3851493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 38523af24433SOleg Nesterov 3853eb13ba87SJohannes Berg lockdep_init_map(&wq->lockdep_map, lock_name, key, 0); 3854cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 38553af24433SOleg Nesterov 385630cdf249STejun Heo if (alloc_and_link_pwqs(wq) < 0) 3857d2c1d404STejun Heo goto err_free_wq; 38581537663fSTejun Heo 3859493008a8STejun Heo /* 3860493008a8STejun Heo * Workqueues which may be used during memory reclaim should 3861493008a8STejun Heo * have a rescuer to guarantee forward progress. 3862493008a8STejun Heo */ 3863493008a8STejun Heo if (flags & WQ_MEM_RECLAIM) { 3864e22bee78STejun Heo struct worker *rescuer; 3865e22bee78STejun Heo 3866f7537df5SLai Jiangshan rescuer = alloc_worker(NUMA_NO_NODE); 3867e22bee78STejun Heo if (!rescuer) 3868d2c1d404STejun Heo goto err_destroy; 3869e22bee78STejun Heo 3870111c225aSTejun Heo rescuer->rescue_wq = wq; 3871111c225aSTejun Heo rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", 3872b196be89STejun Heo wq->name); 3873d2c1d404STejun Heo if (IS_ERR(rescuer->task)) { 3874d2c1d404STejun Heo kfree(rescuer); 3875d2c1d404STejun Heo goto err_destroy; 3876d2c1d404STejun Heo } 3877e22bee78STejun Heo 3878d2c1d404STejun Heo wq->rescuer = rescuer; 387914a40ffcSTejun Heo rescuer->task->flags |= PF_NO_SETAFFINITY; 3880e22bee78STejun Heo wake_up_process(rescuer->task); 38813af24433SOleg Nesterov } 38821537663fSTejun Heo 3883226223abSTejun Heo if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 3884226223abSTejun Heo goto err_destroy; 3885226223abSTejun Heo 38863af24433SOleg Nesterov /* 388768e13a67SLai Jiangshan * wq_pool_mutex protects global freeze state and workqueues list. 388868e13a67SLai Jiangshan * Grab it, adjust max_active and add the new @wq to workqueues 388968e13a67SLai Jiangshan * list. 38903af24433SOleg Nesterov */ 389168e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 3892a0a1a5fdSTejun Heo 3893a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 389449e3cf44STejun Heo for_each_pwq(pwq, wq) 3895699ce097STejun Heo pwq_adjust_max_active(pwq); 3896a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 3897a0a1a5fdSTejun Heo 3898e2dca7adSTejun Heo list_add_tail_rcu(&wq->list, &workqueues); 3899a0a1a5fdSTejun Heo 390068e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 39013af24433SOleg Nesterov 39023af24433SOleg Nesterov return wq; 3903d2c1d404STejun Heo 3904d2c1d404STejun Heo err_free_wq: 39056029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 39064690c4abSTejun Heo kfree(wq); 3907d2c1d404STejun Heo return NULL; 3908d2c1d404STejun Heo err_destroy: 3909d2c1d404STejun Heo destroy_workqueue(wq); 39104690c4abSTejun Heo return NULL; 39111da177e4SLinus Torvalds } 3912d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key); 39131da177e4SLinus Torvalds 39143af24433SOleg Nesterov /** 39153af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 39163af24433SOleg Nesterov * @wq: target workqueue 39173af24433SOleg Nesterov * 39183af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 39193af24433SOleg Nesterov */ 39203af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 39213af24433SOleg Nesterov { 392249e3cf44STejun Heo struct pool_workqueue *pwq; 39234c16bd32STejun Heo int node; 39243af24433SOleg Nesterov 39259c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 39269c5a2ba7STejun Heo drain_workqueue(wq); 3927c8efcc25STejun Heo 39286183c009STejun Heo /* sanity checks */ 3929b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 393049e3cf44STejun Heo for_each_pwq(pwq, wq) { 39316183c009STejun Heo int i; 39326183c009STejun Heo 393376af4d93STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) { 393476af4d93STejun Heo if (WARN_ON(pwq->nr_in_flight[i])) { 3935b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 39366183c009STejun Heo return; 393776af4d93STejun Heo } 393876af4d93STejun Heo } 393976af4d93STejun Heo 39405c529597SLai Jiangshan if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) || 39418864b4e5STejun Heo WARN_ON(pwq->nr_active) || 394276af4d93STejun Heo WARN_ON(!list_empty(&pwq->delayed_works))) { 3943b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 39446183c009STejun Heo return; 39456183c009STejun Heo } 394676af4d93STejun Heo } 3947b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 39486183c009STejun Heo 3949a0a1a5fdSTejun Heo /* 3950a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 3951a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 3952a0a1a5fdSTejun Heo */ 395368e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 3954e2dca7adSTejun Heo list_del_rcu(&wq->list); 395568e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 39563af24433SOleg Nesterov 3957226223abSTejun Heo workqueue_sysfs_unregister(wq); 3958226223abSTejun Heo 3959e2dca7adSTejun Heo if (wq->rescuer) 3960e22bee78STejun Heo kthread_stop(wq->rescuer->task); 3961e22bee78STejun Heo 39628864b4e5STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 396329c91e99STejun Heo /* 39648864b4e5STejun Heo * The base ref is never dropped on per-cpu pwqs. Directly 3965e2dca7adSTejun Heo * schedule RCU free. 396629c91e99STejun Heo */ 3967e2dca7adSTejun Heo call_rcu_sched(&wq->rcu, rcu_free_wq); 39688864b4e5STejun Heo } else { 39698864b4e5STejun Heo /* 39708864b4e5STejun Heo * We're the sole accessor of @wq at this point. Directly 39714c16bd32STejun Heo * access numa_pwq_tbl[] and dfl_pwq to put the base refs. 39724c16bd32STejun Heo * @wq will be freed when the last pwq is released. 39738864b4e5STejun Heo */ 39744c16bd32STejun Heo for_each_node(node) { 39754c16bd32STejun Heo pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); 39764c16bd32STejun Heo RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL); 39774c16bd32STejun Heo put_pwq_unlocked(pwq); 39784c16bd32STejun Heo } 39794c16bd32STejun Heo 39804c16bd32STejun Heo /* 39814c16bd32STejun Heo * Put dfl_pwq. @wq may be freed any time after dfl_pwq is 39824c16bd32STejun Heo * put. Don't access it afterwards. 39834c16bd32STejun Heo */ 39844c16bd32STejun Heo pwq = wq->dfl_pwq; 39854c16bd32STejun Heo wq->dfl_pwq = NULL; 3986dce90d47STejun Heo put_pwq_unlocked(pwq); 398729c91e99STejun Heo } 39883af24433SOleg Nesterov } 39893af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 39903af24433SOleg Nesterov 3991dcd989cbSTejun Heo /** 3992dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 3993dcd989cbSTejun Heo * @wq: target workqueue 3994dcd989cbSTejun Heo * @max_active: new max_active value. 3995dcd989cbSTejun Heo * 3996dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 3997dcd989cbSTejun Heo * 3998dcd989cbSTejun Heo * CONTEXT: 3999dcd989cbSTejun Heo * Don't call from IRQ context. 4000dcd989cbSTejun Heo */ 4001dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 4002dcd989cbSTejun Heo { 400349e3cf44STejun Heo struct pool_workqueue *pwq; 4004dcd989cbSTejun Heo 40058719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 40068719dceaSTejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 40078719dceaSTejun Heo return; 40088719dceaSTejun Heo 4009f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 4010dcd989cbSTejun Heo 4011a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4012dcd989cbSTejun Heo 4013dcd989cbSTejun Heo wq->saved_max_active = max_active; 4014dcd989cbSTejun Heo 4015699ce097STejun Heo for_each_pwq(pwq, wq) 4016699ce097STejun Heo pwq_adjust_max_active(pwq); 4017dcd989cbSTejun Heo 4018a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4019dcd989cbSTejun Heo } 4020dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 4021dcd989cbSTejun Heo 4022dcd989cbSTejun Heo /** 4023e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 4024e6267616STejun Heo * 4025e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 4026e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 4027d185af30SYacine Belkadi * 4028d185af30SYacine Belkadi * Return: %true if %current is a workqueue rescuer. %false otherwise. 4029e6267616STejun Heo */ 4030e6267616STejun Heo bool current_is_workqueue_rescuer(void) 4031e6267616STejun Heo { 4032e6267616STejun Heo struct worker *worker = current_wq_worker(); 4033e6267616STejun Heo 40346a092dfdSLai Jiangshan return worker && worker->rescue_wq; 4035e6267616STejun Heo } 4036e6267616STejun Heo 4037e6267616STejun Heo /** 4038dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 4039dcd989cbSTejun Heo * @cpu: CPU in question 4040dcd989cbSTejun Heo * @wq: target workqueue 4041dcd989cbSTejun Heo * 4042dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 4043dcd989cbSTejun Heo * no synchronization around this function and the test result is 4044dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4045dcd989cbSTejun Heo * 4046d3251859STejun Heo * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. 4047d3251859STejun Heo * Note that both per-cpu and unbound workqueues may be associated with 4048d3251859STejun Heo * multiple pool_workqueues which have separate congested states. A 4049d3251859STejun Heo * workqueue being congested on one CPU doesn't mean the workqueue is also 4050d3251859STejun Heo * contested on other CPUs / NUMA nodes. 4051d3251859STejun Heo * 4052d185af30SYacine Belkadi * Return: 4053dcd989cbSTejun Heo * %true if congested, %false otherwise. 4054dcd989cbSTejun Heo */ 4055d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 4056dcd989cbSTejun Heo { 40577fb98ea7STejun Heo struct pool_workqueue *pwq; 405876af4d93STejun Heo bool ret; 405976af4d93STejun Heo 406088109453SLai Jiangshan rcu_read_lock_sched(); 40617fb98ea7STejun Heo 4062d3251859STejun Heo if (cpu == WORK_CPU_UNBOUND) 4063d3251859STejun Heo cpu = smp_processor_id(); 4064d3251859STejun Heo 40657fb98ea7STejun Heo if (!(wq->flags & WQ_UNBOUND)) 40667fb98ea7STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 40677fb98ea7STejun Heo else 4068df2d5ae4STejun Heo pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); 4069dcd989cbSTejun Heo 407076af4d93STejun Heo ret = !list_empty(&pwq->delayed_works); 407188109453SLai Jiangshan rcu_read_unlock_sched(); 407276af4d93STejun Heo 407376af4d93STejun Heo return ret; 4074dcd989cbSTejun Heo } 4075dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 4076dcd989cbSTejun Heo 4077dcd989cbSTejun Heo /** 4078dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 4079dcd989cbSTejun Heo * @work: the work to be tested 4080dcd989cbSTejun Heo * 4081dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 4082dcd989cbSTejun Heo * synchronization around this function and the test result is 4083dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4084dcd989cbSTejun Heo * 4085d185af30SYacine Belkadi * Return: 4086dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 4087dcd989cbSTejun Heo */ 4088dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 4089dcd989cbSTejun Heo { 4090fa1b54e6STejun Heo struct worker_pool *pool; 4091dcd989cbSTejun Heo unsigned long flags; 4092dcd989cbSTejun Heo unsigned int ret = 0; 4093dcd989cbSTejun Heo 4094dcd989cbSTejun Heo if (work_pending(work)) 4095dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 4096038366c5SLai Jiangshan 4097fa1b54e6STejun Heo local_irq_save(flags); 4098fa1b54e6STejun Heo pool = get_work_pool(work); 4099038366c5SLai Jiangshan if (pool) { 4100fa1b54e6STejun Heo spin_lock(&pool->lock); 4101c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 4102dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 4103fa1b54e6STejun Heo spin_unlock(&pool->lock); 4104038366c5SLai Jiangshan } 4105fa1b54e6STejun Heo local_irq_restore(flags); 4106dcd989cbSTejun Heo 4107dcd989cbSTejun Heo return ret; 4108dcd989cbSTejun Heo } 4109dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 4110dcd989cbSTejun Heo 41113d1cb205STejun Heo /** 41123d1cb205STejun Heo * set_worker_desc - set description for the current work item 41133d1cb205STejun Heo * @fmt: printf-style format string 41143d1cb205STejun Heo * @...: arguments for the format string 41153d1cb205STejun Heo * 41163d1cb205STejun Heo * This function can be called by a running work function to describe what 41173d1cb205STejun Heo * the work item is about. If the worker task gets dumped, this 41183d1cb205STejun Heo * information will be printed out together to help debugging. The 41193d1cb205STejun Heo * description can be at most WORKER_DESC_LEN including the trailing '\0'. 41203d1cb205STejun Heo */ 41213d1cb205STejun Heo void set_worker_desc(const char *fmt, ...) 41223d1cb205STejun Heo { 41233d1cb205STejun Heo struct worker *worker = current_wq_worker(); 41243d1cb205STejun Heo va_list args; 41253d1cb205STejun Heo 41263d1cb205STejun Heo if (worker) { 41273d1cb205STejun Heo va_start(args, fmt); 41283d1cb205STejun Heo vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); 41293d1cb205STejun Heo va_end(args); 41303d1cb205STejun Heo worker->desc_valid = true; 41313d1cb205STejun Heo } 41323d1cb205STejun Heo } 41333d1cb205STejun Heo 41343d1cb205STejun Heo /** 41353d1cb205STejun Heo * print_worker_info - print out worker information and description 41363d1cb205STejun Heo * @log_lvl: the log level to use when printing 41373d1cb205STejun Heo * @task: target task 41383d1cb205STejun Heo * 41393d1cb205STejun Heo * If @task is a worker and currently executing a work item, print out the 41403d1cb205STejun Heo * name of the workqueue being serviced and worker description set with 41413d1cb205STejun Heo * set_worker_desc() by the currently executing work item. 41423d1cb205STejun Heo * 41433d1cb205STejun Heo * This function can be safely called on any task as long as the 41443d1cb205STejun Heo * task_struct itself is accessible. While safe, this function isn't 41453d1cb205STejun Heo * synchronized and may print out mixups or garbages of limited length. 41463d1cb205STejun Heo */ 41473d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task) 41483d1cb205STejun Heo { 41493d1cb205STejun Heo work_func_t *fn = NULL; 41503d1cb205STejun Heo char name[WQ_NAME_LEN] = { }; 41513d1cb205STejun Heo char desc[WORKER_DESC_LEN] = { }; 41523d1cb205STejun Heo struct pool_workqueue *pwq = NULL; 41533d1cb205STejun Heo struct workqueue_struct *wq = NULL; 41543d1cb205STejun Heo bool desc_valid = false; 41553d1cb205STejun Heo struct worker *worker; 41563d1cb205STejun Heo 41573d1cb205STejun Heo if (!(task->flags & PF_WQ_WORKER)) 41583d1cb205STejun Heo return; 41593d1cb205STejun Heo 41603d1cb205STejun Heo /* 41613d1cb205STejun Heo * This function is called without any synchronization and @task 41623d1cb205STejun Heo * could be in any state. Be careful with dereferences. 41633d1cb205STejun Heo */ 41643d1cb205STejun Heo worker = probe_kthread_data(task); 41653d1cb205STejun Heo 41663d1cb205STejun Heo /* 41673d1cb205STejun Heo * Carefully copy the associated workqueue's workfn and name. Keep 41683d1cb205STejun Heo * the original last '\0' in case the original contains garbage. 41693d1cb205STejun Heo */ 41703d1cb205STejun Heo probe_kernel_read(&fn, &worker->current_func, sizeof(fn)); 41713d1cb205STejun Heo probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq)); 41723d1cb205STejun Heo probe_kernel_read(&wq, &pwq->wq, sizeof(wq)); 41733d1cb205STejun Heo probe_kernel_read(name, wq->name, sizeof(name) - 1); 41743d1cb205STejun Heo 41753d1cb205STejun Heo /* copy worker description */ 41763d1cb205STejun Heo probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid)); 41773d1cb205STejun Heo if (desc_valid) 41783d1cb205STejun Heo probe_kernel_read(desc, worker->desc, sizeof(desc) - 1); 41793d1cb205STejun Heo 41803d1cb205STejun Heo if (fn || name[0] || desc[0]) { 41813d1cb205STejun Heo printk("%sWorkqueue: %s %pf", log_lvl, name, fn); 41823d1cb205STejun Heo if (desc[0]) 41833d1cb205STejun Heo pr_cont(" (%s)", desc); 41843d1cb205STejun Heo pr_cont("\n"); 41853d1cb205STejun Heo } 41863d1cb205STejun Heo } 41873d1cb205STejun Heo 41883494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool) 41893494fc30STejun Heo { 41903494fc30STejun Heo pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask); 41913494fc30STejun Heo if (pool->node != NUMA_NO_NODE) 41923494fc30STejun Heo pr_cont(" node=%d", pool->node); 41933494fc30STejun Heo pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice); 41943494fc30STejun Heo } 41953494fc30STejun Heo 41963494fc30STejun Heo static void pr_cont_work(bool comma, struct work_struct *work) 41973494fc30STejun Heo { 41983494fc30STejun Heo if (work->func == wq_barrier_func) { 41993494fc30STejun Heo struct wq_barrier *barr; 42003494fc30STejun Heo 42013494fc30STejun Heo barr = container_of(work, struct wq_barrier, work); 42023494fc30STejun Heo 42033494fc30STejun Heo pr_cont("%s BAR(%d)", comma ? "," : "", 42043494fc30STejun Heo task_pid_nr(barr->task)); 42053494fc30STejun Heo } else { 42063494fc30STejun Heo pr_cont("%s %pf", comma ? "," : "", work->func); 42073494fc30STejun Heo } 42083494fc30STejun Heo } 42093494fc30STejun Heo 42103494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq) 42113494fc30STejun Heo { 42123494fc30STejun Heo struct worker_pool *pool = pwq->pool; 42133494fc30STejun Heo struct work_struct *work; 42143494fc30STejun Heo struct worker *worker; 42153494fc30STejun Heo bool has_in_flight = false, has_pending = false; 42163494fc30STejun Heo int bkt; 42173494fc30STejun Heo 42183494fc30STejun Heo pr_info(" pwq %d:", pool->id); 42193494fc30STejun Heo pr_cont_pool_info(pool); 42203494fc30STejun Heo 42213494fc30STejun Heo pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active, 42223494fc30STejun Heo !list_empty(&pwq->mayday_node) ? " MAYDAY" : ""); 42233494fc30STejun Heo 42243494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 42253494fc30STejun Heo if (worker->current_pwq == pwq) { 42263494fc30STejun Heo has_in_flight = true; 42273494fc30STejun Heo break; 42283494fc30STejun Heo } 42293494fc30STejun Heo } 42303494fc30STejun Heo if (has_in_flight) { 42313494fc30STejun Heo bool comma = false; 42323494fc30STejun Heo 42333494fc30STejun Heo pr_info(" in-flight:"); 42343494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 42353494fc30STejun Heo if (worker->current_pwq != pwq) 42363494fc30STejun Heo continue; 42373494fc30STejun Heo 42383494fc30STejun Heo pr_cont("%s %d%s:%pf", comma ? "," : "", 42393494fc30STejun Heo task_pid_nr(worker->task), 42403494fc30STejun Heo worker == pwq->wq->rescuer ? "(RESCUER)" : "", 42413494fc30STejun Heo worker->current_func); 42423494fc30STejun Heo list_for_each_entry(work, &worker->scheduled, entry) 42433494fc30STejun Heo pr_cont_work(false, work); 42443494fc30STejun Heo comma = true; 42453494fc30STejun Heo } 42463494fc30STejun Heo pr_cont("\n"); 42473494fc30STejun Heo } 42483494fc30STejun Heo 42493494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 42503494fc30STejun Heo if (get_work_pwq(work) == pwq) { 42513494fc30STejun Heo has_pending = true; 42523494fc30STejun Heo break; 42533494fc30STejun Heo } 42543494fc30STejun Heo } 42553494fc30STejun Heo if (has_pending) { 42563494fc30STejun Heo bool comma = false; 42573494fc30STejun Heo 42583494fc30STejun Heo pr_info(" pending:"); 42593494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 42603494fc30STejun Heo if (get_work_pwq(work) != pwq) 42613494fc30STejun Heo continue; 42623494fc30STejun Heo 42633494fc30STejun Heo pr_cont_work(comma, work); 42643494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 42653494fc30STejun Heo } 42663494fc30STejun Heo pr_cont("\n"); 42673494fc30STejun Heo } 42683494fc30STejun Heo 42693494fc30STejun Heo if (!list_empty(&pwq->delayed_works)) { 42703494fc30STejun Heo bool comma = false; 42713494fc30STejun Heo 42723494fc30STejun Heo pr_info(" delayed:"); 42733494fc30STejun Heo list_for_each_entry(work, &pwq->delayed_works, entry) { 42743494fc30STejun Heo pr_cont_work(comma, work); 42753494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 42763494fc30STejun Heo } 42773494fc30STejun Heo pr_cont("\n"); 42783494fc30STejun Heo } 42793494fc30STejun Heo } 42803494fc30STejun Heo 42813494fc30STejun Heo /** 42823494fc30STejun Heo * show_workqueue_state - dump workqueue state 42833494fc30STejun Heo * 42843494fc30STejun Heo * Called from a sysrq handler and prints out all busy workqueues and 42853494fc30STejun Heo * pools. 42863494fc30STejun Heo */ 42873494fc30STejun Heo void show_workqueue_state(void) 42883494fc30STejun Heo { 42893494fc30STejun Heo struct workqueue_struct *wq; 42903494fc30STejun Heo struct worker_pool *pool; 42913494fc30STejun Heo unsigned long flags; 42923494fc30STejun Heo int pi; 42933494fc30STejun Heo 42943494fc30STejun Heo rcu_read_lock_sched(); 42953494fc30STejun Heo 42963494fc30STejun Heo pr_info("Showing busy workqueues and worker pools:\n"); 42973494fc30STejun Heo 42983494fc30STejun Heo list_for_each_entry_rcu(wq, &workqueues, list) { 42993494fc30STejun Heo struct pool_workqueue *pwq; 43003494fc30STejun Heo bool idle = true; 43013494fc30STejun Heo 43023494fc30STejun Heo for_each_pwq(pwq, wq) { 43033494fc30STejun Heo if (pwq->nr_active || !list_empty(&pwq->delayed_works)) { 43043494fc30STejun Heo idle = false; 43053494fc30STejun Heo break; 43063494fc30STejun Heo } 43073494fc30STejun Heo } 43083494fc30STejun Heo if (idle) 43093494fc30STejun Heo continue; 43103494fc30STejun Heo 43113494fc30STejun Heo pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags); 43123494fc30STejun Heo 43133494fc30STejun Heo for_each_pwq(pwq, wq) { 43143494fc30STejun Heo spin_lock_irqsave(&pwq->pool->lock, flags); 43153494fc30STejun Heo if (pwq->nr_active || !list_empty(&pwq->delayed_works)) 43163494fc30STejun Heo show_pwq(pwq); 43173494fc30STejun Heo spin_unlock_irqrestore(&pwq->pool->lock, flags); 43183494fc30STejun Heo } 43193494fc30STejun Heo } 43203494fc30STejun Heo 43213494fc30STejun Heo for_each_pool(pool, pi) { 43223494fc30STejun Heo struct worker *worker; 43233494fc30STejun Heo bool first = true; 43243494fc30STejun Heo 43253494fc30STejun Heo spin_lock_irqsave(&pool->lock, flags); 43263494fc30STejun Heo if (pool->nr_workers == pool->nr_idle) 43273494fc30STejun Heo goto next_pool; 43283494fc30STejun Heo 43293494fc30STejun Heo pr_info("pool %d:", pool->id); 43303494fc30STejun Heo pr_cont_pool_info(pool); 43313494fc30STejun Heo pr_cont(" workers=%d", pool->nr_workers); 43323494fc30STejun Heo if (pool->manager) 43333494fc30STejun Heo pr_cont(" manager: %d", 43343494fc30STejun Heo task_pid_nr(pool->manager->task)); 43353494fc30STejun Heo list_for_each_entry(worker, &pool->idle_list, entry) { 43363494fc30STejun Heo pr_cont(" %s%d", first ? "idle: " : "", 43373494fc30STejun Heo task_pid_nr(worker->task)); 43383494fc30STejun Heo first = false; 43393494fc30STejun Heo } 43403494fc30STejun Heo pr_cont("\n"); 43413494fc30STejun Heo next_pool: 43423494fc30STejun Heo spin_unlock_irqrestore(&pool->lock, flags); 43433494fc30STejun Heo } 43443494fc30STejun Heo 43453494fc30STejun Heo rcu_read_unlock_sched(); 43463494fc30STejun Heo } 43473494fc30STejun Heo 4348db7bccf4STejun Heo /* 4349db7bccf4STejun Heo * CPU hotplug. 4350db7bccf4STejun Heo * 4351e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 4352112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 4353706026c2STejun Heo * pool which make migrating pending and scheduled works very 4354e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 435594cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 4356e22bee78STejun Heo * blocked draining impractical. 4357e22bee78STejun Heo * 435824647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 4359628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 4360628c78e7STejun Heo * cpu comes back online. 4361db7bccf4STejun Heo */ 4362db7bccf4STejun Heo 4363706026c2STejun Heo static void wq_unbind_fn(struct work_struct *work) 4364db7bccf4STejun Heo { 436538db41d9STejun Heo int cpu = smp_processor_id(); 43664ce62e9eSTejun Heo struct worker_pool *pool; 4367db7bccf4STejun Heo struct worker *worker; 4368db7bccf4STejun Heo 4369f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 437092f9c5c4SLai Jiangshan mutex_lock(&pool->attach_mutex); 437194cf58bbSTejun Heo spin_lock_irq(&pool->lock); 4372e22bee78STejun Heo 4373f2d5a0eeSTejun Heo /* 437492f9c5c4SLai Jiangshan * We've blocked all attach/detach operations. Make all workers 437594cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 437694cf58bbSTejun Heo * except for the ones which are still executing works from 437794cf58bbSTejun Heo * before the last CPU down must be on the cpu. After 437894cf58bbSTejun Heo * this, they may become diasporas. 4379f2d5a0eeSTejun Heo */ 4380da028469SLai Jiangshan for_each_pool_worker(worker, pool) 4381403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 4382db7bccf4STejun Heo 438324647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 4384f2d5a0eeSTejun Heo 438594cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 438692f9c5c4SLai Jiangshan mutex_unlock(&pool->attach_mutex); 4387e22bee78STejun Heo 4388e22bee78STejun Heo /* 4389eb283428SLai Jiangshan * Call schedule() so that we cross rq->lock and thus can 4390eb283428SLai Jiangshan * guarantee sched callbacks see the %WORKER_UNBOUND flag. 4391eb283428SLai Jiangshan * This is necessary as scheduler callbacks may be invoked 4392eb283428SLai Jiangshan * from other cpus. 4393628c78e7STejun Heo */ 4394628c78e7STejun Heo schedule(); 4395628c78e7STejun Heo 4396628c78e7STejun Heo /* 4397eb283428SLai Jiangshan * Sched callbacks are disabled now. Zap nr_running. 4398eb283428SLai Jiangshan * After this, nr_running stays zero and need_more_worker() 4399eb283428SLai Jiangshan * and keep_working() are always true as long as the 4400eb283428SLai Jiangshan * worklist is not empty. This pool now behaves as an 4401eb283428SLai Jiangshan * unbound (in terms of concurrency management) pool which 4402eb283428SLai Jiangshan * are served by workers tied to the pool. 4403e22bee78STejun Heo */ 4404e19e397aSTejun Heo atomic_set(&pool->nr_running, 0); 4405eb283428SLai Jiangshan 4406eb283428SLai Jiangshan /* 4407eb283428SLai Jiangshan * With concurrency management just turned off, a busy 4408eb283428SLai Jiangshan * worker blocking could lead to lengthy stalls. Kick off 4409eb283428SLai Jiangshan * unbound chain execution of currently pending work items. 4410eb283428SLai Jiangshan */ 4411eb283428SLai Jiangshan spin_lock_irq(&pool->lock); 4412eb283428SLai Jiangshan wake_up_worker(pool); 4413eb283428SLai Jiangshan spin_unlock_irq(&pool->lock); 4414eb283428SLai Jiangshan } 4415db7bccf4STejun Heo } 4416db7bccf4STejun Heo 4417bd7c089eSTejun Heo /** 4418bd7c089eSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 4419bd7c089eSTejun Heo * @pool: pool of interest 4420bd7c089eSTejun Heo * 4421a9ab775bSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. 4422bd7c089eSTejun Heo */ 4423bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool) 4424bd7c089eSTejun Heo { 4425a9ab775bSTejun Heo struct worker *worker; 4426bd7c089eSTejun Heo 442792f9c5c4SLai Jiangshan lockdep_assert_held(&pool->attach_mutex); 4428bd7c089eSTejun Heo 4429bd7c089eSTejun Heo /* 4430a9ab775bSTejun Heo * Restore CPU affinity of all workers. As all idle workers should 4431a9ab775bSTejun Heo * be on the run-queue of the associated CPU before any local 4432a9ab775bSTejun Heo * wake-ups for concurrency management happen, restore CPU affinty 4433a9ab775bSTejun Heo * of all workers first and then clear UNBOUND. As we're called 4434a9ab775bSTejun Heo * from CPU_ONLINE, the following shouldn't fail. 4435bd7c089eSTejun Heo */ 4436da028469SLai Jiangshan for_each_pool_worker(worker, pool) 4437a9ab775bSTejun Heo WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 4438a9ab775bSTejun Heo pool->attrs->cpumask) < 0); 4439a9ab775bSTejun Heo 4440a9ab775bSTejun Heo spin_lock_irq(&pool->lock); 44413de5e884SLai Jiangshan pool->flags &= ~POOL_DISASSOCIATED; 4442a9ab775bSTejun Heo 4443da028469SLai Jiangshan for_each_pool_worker(worker, pool) { 4444a9ab775bSTejun Heo unsigned int worker_flags = worker->flags; 4445a9ab775bSTejun Heo 4446a9ab775bSTejun Heo /* 4447a9ab775bSTejun Heo * A bound idle worker should actually be on the runqueue 4448a9ab775bSTejun Heo * of the associated CPU for local wake-ups targeting it to 4449a9ab775bSTejun Heo * work. Kick all idle workers so that they migrate to the 4450a9ab775bSTejun Heo * associated CPU. Doing this in the same loop as 4451a9ab775bSTejun Heo * replacing UNBOUND with REBOUND is safe as no worker will 4452a9ab775bSTejun Heo * be bound before @pool->lock is released. 4453a9ab775bSTejun Heo */ 4454a9ab775bSTejun Heo if (worker_flags & WORKER_IDLE) 4455bd7c089eSTejun Heo wake_up_process(worker->task); 4456bd7c089eSTejun Heo 4457bd7c089eSTejun Heo /* 4458a9ab775bSTejun Heo * We want to clear UNBOUND but can't directly call 4459a9ab775bSTejun Heo * worker_clr_flags() or adjust nr_running. Atomically 4460a9ab775bSTejun Heo * replace UNBOUND with another NOT_RUNNING flag REBOUND. 4461a9ab775bSTejun Heo * @worker will clear REBOUND using worker_clr_flags() when 4462a9ab775bSTejun Heo * it initiates the next execution cycle thus restoring 4463a9ab775bSTejun Heo * concurrency management. Note that when or whether 4464a9ab775bSTejun Heo * @worker clears REBOUND doesn't affect correctness. 4465a9ab775bSTejun Heo * 4466a9ab775bSTejun Heo * ACCESS_ONCE() is necessary because @worker->flags may be 4467a9ab775bSTejun Heo * tested without holding any lock in 4468a9ab775bSTejun Heo * wq_worker_waking_up(). Without it, NOT_RUNNING test may 4469a9ab775bSTejun Heo * fail incorrectly leading to premature concurrency 4470a9ab775bSTejun Heo * management operations. 4471bd7c089eSTejun Heo */ 4472a9ab775bSTejun Heo WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); 4473a9ab775bSTejun Heo worker_flags |= WORKER_REBOUND; 4474a9ab775bSTejun Heo worker_flags &= ~WORKER_UNBOUND; 4475a9ab775bSTejun Heo ACCESS_ONCE(worker->flags) = worker_flags; 4476bd7c089eSTejun Heo } 4477a9ab775bSTejun Heo 4478a9ab775bSTejun Heo spin_unlock_irq(&pool->lock); 4479bd7c089eSTejun Heo } 4480bd7c089eSTejun Heo 44817dbc725eSTejun Heo /** 44827dbc725eSTejun Heo * restore_unbound_workers_cpumask - restore cpumask of unbound workers 44837dbc725eSTejun Heo * @pool: unbound pool of interest 44847dbc725eSTejun Heo * @cpu: the CPU which is coming up 44857dbc725eSTejun Heo * 44867dbc725eSTejun Heo * An unbound pool may end up with a cpumask which doesn't have any online 44877dbc725eSTejun Heo * CPUs. When a worker of such pool get scheduled, the scheduler resets 44887dbc725eSTejun Heo * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any 44897dbc725eSTejun Heo * online CPU before, cpus_allowed of all its workers should be restored. 44907dbc725eSTejun Heo */ 44917dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) 44927dbc725eSTejun Heo { 44937dbc725eSTejun Heo static cpumask_t cpumask; 44947dbc725eSTejun Heo struct worker *worker; 44957dbc725eSTejun Heo 449692f9c5c4SLai Jiangshan lockdep_assert_held(&pool->attach_mutex); 44977dbc725eSTejun Heo 44987dbc725eSTejun Heo /* is @cpu allowed for @pool? */ 44997dbc725eSTejun Heo if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) 45007dbc725eSTejun Heo return; 45017dbc725eSTejun Heo 45027dbc725eSTejun Heo /* is @cpu the only online CPU? */ 45037dbc725eSTejun Heo cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); 45047dbc725eSTejun Heo if (cpumask_weight(&cpumask) != 1) 45057dbc725eSTejun Heo return; 45067dbc725eSTejun Heo 45077dbc725eSTejun Heo /* as we're called from CPU_ONLINE, the following shouldn't fail */ 4508da028469SLai Jiangshan for_each_pool_worker(worker, pool) 45097dbc725eSTejun Heo WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 45107dbc725eSTejun Heo pool->attrs->cpumask) < 0); 45117dbc725eSTejun Heo } 45127dbc725eSTejun Heo 45138db25e78STejun Heo /* 45148db25e78STejun Heo * Workqueues should be brought up before normal priority CPU notifiers. 45158db25e78STejun Heo * This will be registered high priority CPU notifier. 45168db25e78STejun Heo */ 45170db0628dSPaul Gortmaker static int workqueue_cpu_up_callback(struct notifier_block *nfb, 45181da177e4SLinus Torvalds unsigned long action, 45191da177e4SLinus Torvalds void *hcpu) 45201da177e4SLinus Torvalds { 4521d84ff051STejun Heo int cpu = (unsigned long)hcpu; 45224ce62e9eSTejun Heo struct worker_pool *pool; 45234c16bd32STejun Heo struct workqueue_struct *wq; 45247dbc725eSTejun Heo int pi; 45251da177e4SLinus Torvalds 45268db25e78STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 45273af24433SOleg Nesterov case CPU_UP_PREPARE: 4528f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 45293ce63377STejun Heo if (pool->nr_workers) 45303ce63377STejun Heo continue; 4531051e1850SLai Jiangshan if (!create_worker(pool)) 45323ce63377STejun Heo return NOTIFY_BAD; 45333af24433SOleg Nesterov } 45341da177e4SLinus Torvalds break; 45351da177e4SLinus Torvalds 453665758202STejun Heo case CPU_DOWN_FAILED: 453765758202STejun Heo case CPU_ONLINE: 453868e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 45397dbc725eSTejun Heo 45407dbc725eSTejun Heo for_each_pool(pool, pi) { 454192f9c5c4SLai Jiangshan mutex_lock(&pool->attach_mutex); 454294cf58bbSTejun Heo 4543f05b558dSLai Jiangshan if (pool->cpu == cpu) 454494cf58bbSTejun Heo rebind_workers(pool); 4545f05b558dSLai Jiangshan else if (pool->cpu < 0) 45467dbc725eSTejun Heo restore_unbound_workers_cpumask(pool, cpu); 454794cf58bbSTejun Heo 454892f9c5c4SLai Jiangshan mutex_unlock(&pool->attach_mutex); 454994cf58bbSTejun Heo } 45507dbc725eSTejun Heo 45514c16bd32STejun Heo /* update NUMA affinity of unbound workqueues */ 45524c16bd32STejun Heo list_for_each_entry(wq, &workqueues, list) 45534c16bd32STejun Heo wq_update_unbound_numa(wq, cpu, true); 45544c16bd32STejun Heo 455568e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 45568db25e78STejun Heo break; 455765758202STejun Heo } 455865758202STejun Heo return NOTIFY_OK; 455965758202STejun Heo } 456065758202STejun Heo 456165758202STejun Heo /* 456265758202STejun Heo * Workqueues should be brought down after normal priority CPU notifiers. 456365758202STejun Heo * This will be registered as low priority CPU notifier. 456465758202STejun Heo */ 45650db0628dSPaul Gortmaker static int workqueue_cpu_down_callback(struct notifier_block *nfb, 456665758202STejun Heo unsigned long action, 456765758202STejun Heo void *hcpu) 456865758202STejun Heo { 4569d84ff051STejun Heo int cpu = (unsigned long)hcpu; 45708db25e78STejun Heo struct work_struct unbind_work; 45714c16bd32STejun Heo struct workqueue_struct *wq; 45728db25e78STejun Heo 457365758202STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 457465758202STejun Heo case CPU_DOWN_PREPARE: 45754c16bd32STejun Heo /* unbinding per-cpu workers should happen on the local CPU */ 4576706026c2STejun Heo INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn); 45777635d2fdSJoonsoo Kim queue_work_on(cpu, system_highpri_wq, &unbind_work); 45784c16bd32STejun Heo 45794c16bd32STejun Heo /* update NUMA affinity of unbound workqueues */ 45804c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 45814c16bd32STejun Heo list_for_each_entry(wq, &workqueues, list) 45824c16bd32STejun Heo wq_update_unbound_numa(wq, cpu, false); 45834c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 45844c16bd32STejun Heo 45854c16bd32STejun Heo /* wait for per-cpu unbinding to finish */ 45868db25e78STejun Heo flush_work(&unbind_work); 4587440a1136SChuansheng Liu destroy_work_on_stack(&unbind_work); 45888db25e78STejun Heo break; 458965758202STejun Heo } 459065758202STejun Heo return NOTIFY_OK; 459165758202STejun Heo } 459265758202STejun Heo 45932d3854a3SRusty Russell #ifdef CONFIG_SMP 45948ccad40dSRusty Russell 45952d3854a3SRusty Russell struct work_for_cpu { 4596ed48ece2STejun Heo struct work_struct work; 45972d3854a3SRusty Russell long (*fn)(void *); 45982d3854a3SRusty Russell void *arg; 45992d3854a3SRusty Russell long ret; 46002d3854a3SRusty Russell }; 46012d3854a3SRusty Russell 4602ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 46032d3854a3SRusty Russell { 4604ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 4605ed48ece2STejun Heo 46062d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 46072d3854a3SRusty Russell } 46082d3854a3SRusty Russell 46092d3854a3SRusty Russell /** 46102d3854a3SRusty Russell * work_on_cpu - run a function in user context on a particular cpu 46112d3854a3SRusty Russell * @cpu: the cpu to run on 46122d3854a3SRusty Russell * @fn: the function to run 46132d3854a3SRusty Russell * @arg: the function arg 46142d3854a3SRusty Russell * 461531ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 46166b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 4617d185af30SYacine Belkadi * 4618d185af30SYacine Belkadi * Return: The value @fn returns. 46192d3854a3SRusty Russell */ 4620d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg) 46212d3854a3SRusty Russell { 4622ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 46232d3854a3SRusty Russell 4624ed48ece2STejun Heo INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); 4625ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 462612997d1aSBjorn Helgaas flush_work(&wfc.work); 4627440a1136SChuansheng Liu destroy_work_on_stack(&wfc.work); 46282d3854a3SRusty Russell return wfc.ret; 46292d3854a3SRusty Russell } 46302d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 46312d3854a3SRusty Russell #endif /* CONFIG_SMP */ 46322d3854a3SRusty Russell 4633a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 4634e7577c50SRusty Russell 4635a0a1a5fdSTejun Heo /** 4636a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 4637a0a1a5fdSTejun Heo * 463858a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 4639c5aa87bbSTejun Heo * workqueues will queue new works to their delayed_works list instead of 4640706026c2STejun Heo * pool->worklist. 4641a0a1a5fdSTejun Heo * 4642a0a1a5fdSTejun Heo * CONTEXT: 4643a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 4644a0a1a5fdSTejun Heo */ 4645a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 4646a0a1a5fdSTejun Heo { 464724b8a847STejun Heo struct workqueue_struct *wq; 464824b8a847STejun Heo struct pool_workqueue *pwq; 4649a0a1a5fdSTejun Heo 465068e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4651a0a1a5fdSTejun Heo 46526183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 4653a0a1a5fdSTejun Heo workqueue_freezing = true; 4654a0a1a5fdSTejun Heo 465524b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 4656a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4657699ce097STejun Heo for_each_pwq(pwq, wq) 4658699ce097STejun Heo pwq_adjust_max_active(pwq); 4659a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4660a1056305STejun Heo } 46615bcab335STejun Heo 466268e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 4663a0a1a5fdSTejun Heo } 4664a0a1a5fdSTejun Heo 4665a0a1a5fdSTejun Heo /** 466658a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 4667a0a1a5fdSTejun Heo * 4668a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 4669a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 4670a0a1a5fdSTejun Heo * 4671a0a1a5fdSTejun Heo * CONTEXT: 467268e13a67SLai Jiangshan * Grabs and releases wq_pool_mutex. 4673a0a1a5fdSTejun Heo * 4674d185af30SYacine Belkadi * Return: 467558a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 467658a69cb4STejun Heo * is complete. 4677a0a1a5fdSTejun Heo */ 4678a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 4679a0a1a5fdSTejun Heo { 4680a0a1a5fdSTejun Heo bool busy = false; 468124b8a847STejun Heo struct workqueue_struct *wq; 468224b8a847STejun Heo struct pool_workqueue *pwq; 4683a0a1a5fdSTejun Heo 468468e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4685a0a1a5fdSTejun Heo 46866183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 4687a0a1a5fdSTejun Heo 468824b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 468924b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 469024b8a847STejun Heo continue; 4691a0a1a5fdSTejun Heo /* 4692a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 4693a0a1a5fdSTejun Heo * to peek without lock. 4694a0a1a5fdSTejun Heo */ 469588109453SLai Jiangshan rcu_read_lock_sched(); 469624b8a847STejun Heo for_each_pwq(pwq, wq) { 46976183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 4698112202d9STejun Heo if (pwq->nr_active) { 4699a0a1a5fdSTejun Heo busy = true; 470088109453SLai Jiangshan rcu_read_unlock_sched(); 4701a0a1a5fdSTejun Heo goto out_unlock; 4702a0a1a5fdSTejun Heo } 4703a0a1a5fdSTejun Heo } 470488109453SLai Jiangshan rcu_read_unlock_sched(); 4705a0a1a5fdSTejun Heo } 4706a0a1a5fdSTejun Heo out_unlock: 470768e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 4708a0a1a5fdSTejun Heo return busy; 4709a0a1a5fdSTejun Heo } 4710a0a1a5fdSTejun Heo 4711a0a1a5fdSTejun Heo /** 4712a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 4713a0a1a5fdSTejun Heo * 4714a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 4715706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 4716a0a1a5fdSTejun Heo * 4717a0a1a5fdSTejun Heo * CONTEXT: 4718a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 4719a0a1a5fdSTejun Heo */ 4720a0a1a5fdSTejun Heo void thaw_workqueues(void) 4721a0a1a5fdSTejun Heo { 472224b8a847STejun Heo struct workqueue_struct *wq; 472324b8a847STejun Heo struct pool_workqueue *pwq; 4724a0a1a5fdSTejun Heo 472568e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4726a0a1a5fdSTejun Heo 4727a0a1a5fdSTejun Heo if (!workqueue_freezing) 4728a0a1a5fdSTejun Heo goto out_unlock; 4729a0a1a5fdSTejun Heo 473074b414eaSLai Jiangshan workqueue_freezing = false; 473124b8a847STejun Heo 473224b8a847STejun Heo /* restore max_active and repopulate worklist */ 473324b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 4734a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4735699ce097STejun Heo for_each_pwq(pwq, wq) 4736699ce097STejun Heo pwq_adjust_max_active(pwq); 4737a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 473824b8a847STejun Heo } 473924b8a847STejun Heo 4740a0a1a5fdSTejun Heo out_unlock: 474168e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 4742a0a1a5fdSTejun Heo } 4743a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 4744a0a1a5fdSTejun Heo 4745*042f7df1SLai Jiangshan static int workqueue_apply_unbound_cpumask(void) 4746*042f7df1SLai Jiangshan { 4747*042f7df1SLai Jiangshan LIST_HEAD(ctxs); 4748*042f7df1SLai Jiangshan int ret = 0; 4749*042f7df1SLai Jiangshan struct workqueue_struct *wq; 4750*042f7df1SLai Jiangshan struct apply_wqattrs_ctx *ctx, *n; 4751*042f7df1SLai Jiangshan 4752*042f7df1SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 4753*042f7df1SLai Jiangshan 4754*042f7df1SLai Jiangshan list_for_each_entry(wq, &workqueues, list) { 4755*042f7df1SLai Jiangshan if (!(wq->flags & WQ_UNBOUND)) 4756*042f7df1SLai Jiangshan continue; 4757*042f7df1SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 4758*042f7df1SLai Jiangshan if (wq->flags & __WQ_ORDERED) 4759*042f7df1SLai Jiangshan continue; 4760*042f7df1SLai Jiangshan 4761*042f7df1SLai Jiangshan ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs); 4762*042f7df1SLai Jiangshan if (!ctx) { 4763*042f7df1SLai Jiangshan ret = -ENOMEM; 4764*042f7df1SLai Jiangshan break; 4765*042f7df1SLai Jiangshan } 4766*042f7df1SLai Jiangshan 4767*042f7df1SLai Jiangshan list_add_tail(&ctx->list, &ctxs); 4768*042f7df1SLai Jiangshan } 4769*042f7df1SLai Jiangshan 4770*042f7df1SLai Jiangshan list_for_each_entry_safe(ctx, n, &ctxs, list) { 4771*042f7df1SLai Jiangshan if (!ret) 4772*042f7df1SLai Jiangshan apply_wqattrs_commit(ctx); 4773*042f7df1SLai Jiangshan apply_wqattrs_cleanup(ctx); 4774*042f7df1SLai Jiangshan } 4775*042f7df1SLai Jiangshan 4776*042f7df1SLai Jiangshan return ret; 4777*042f7df1SLai Jiangshan } 4778*042f7df1SLai Jiangshan 4779*042f7df1SLai Jiangshan /** 4780*042f7df1SLai Jiangshan * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask 4781*042f7df1SLai Jiangshan * @cpumask: the cpumask to set 4782*042f7df1SLai Jiangshan * 4783*042f7df1SLai Jiangshan * The low-level workqueues cpumask is a global cpumask that limits 4784*042f7df1SLai Jiangshan * the affinity of all unbound workqueues. This function check the @cpumask 4785*042f7df1SLai Jiangshan * and apply it to all unbound workqueues and updates all pwqs of them. 4786*042f7df1SLai Jiangshan * 4787*042f7df1SLai Jiangshan * Retun: 0 - Success 4788*042f7df1SLai Jiangshan * -EINVAL - Invalid @cpumask 4789*042f7df1SLai Jiangshan * -ENOMEM - Failed to allocate memory for attrs or pwqs. 4790*042f7df1SLai Jiangshan */ 4791*042f7df1SLai Jiangshan int workqueue_set_unbound_cpumask(cpumask_var_t cpumask) 4792*042f7df1SLai Jiangshan { 4793*042f7df1SLai Jiangshan int ret = -EINVAL; 4794*042f7df1SLai Jiangshan cpumask_var_t saved_cpumask; 4795*042f7df1SLai Jiangshan 4796*042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL)) 4797*042f7df1SLai Jiangshan return -ENOMEM; 4798*042f7df1SLai Jiangshan 4799*042f7df1SLai Jiangshan get_online_cpus(); 4800*042f7df1SLai Jiangshan cpumask_and(cpumask, cpumask, cpu_possible_mask); 4801*042f7df1SLai Jiangshan if (!cpumask_empty(cpumask)) { 4802*042f7df1SLai Jiangshan mutex_lock(&wq_pool_mutex); 4803*042f7df1SLai Jiangshan 4804*042f7df1SLai Jiangshan /* save the old wq_unbound_cpumask. */ 4805*042f7df1SLai Jiangshan cpumask_copy(saved_cpumask, wq_unbound_cpumask); 4806*042f7df1SLai Jiangshan 4807*042f7df1SLai Jiangshan /* update wq_unbound_cpumask at first and apply it to wqs. */ 4808*042f7df1SLai Jiangshan cpumask_copy(wq_unbound_cpumask, cpumask); 4809*042f7df1SLai Jiangshan ret = workqueue_apply_unbound_cpumask(); 4810*042f7df1SLai Jiangshan 4811*042f7df1SLai Jiangshan /* restore the wq_unbound_cpumask when failed. */ 4812*042f7df1SLai Jiangshan if (ret < 0) 4813*042f7df1SLai Jiangshan cpumask_copy(wq_unbound_cpumask, saved_cpumask); 4814*042f7df1SLai Jiangshan 4815*042f7df1SLai Jiangshan mutex_unlock(&wq_pool_mutex); 4816*042f7df1SLai Jiangshan } 4817*042f7df1SLai Jiangshan put_online_cpus(); 4818*042f7df1SLai Jiangshan 4819*042f7df1SLai Jiangshan free_cpumask_var(saved_cpumask); 4820*042f7df1SLai Jiangshan return ret; 4821*042f7df1SLai Jiangshan } 4822*042f7df1SLai Jiangshan 48236ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS 48246ba94429SFrederic Weisbecker /* 48256ba94429SFrederic Weisbecker * Workqueues with WQ_SYSFS flag set is visible to userland via 48266ba94429SFrederic Weisbecker * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 48276ba94429SFrederic Weisbecker * following attributes. 48286ba94429SFrederic Weisbecker * 48296ba94429SFrederic Weisbecker * per_cpu RO bool : whether the workqueue is per-cpu or unbound 48306ba94429SFrederic Weisbecker * max_active RW int : maximum number of in-flight work items 48316ba94429SFrederic Weisbecker * 48326ba94429SFrederic Weisbecker * Unbound workqueues have the following extra attributes. 48336ba94429SFrederic Weisbecker * 48346ba94429SFrederic Weisbecker * id RO int : the associated pool ID 48356ba94429SFrederic Weisbecker * nice RW int : nice value of the workers 48366ba94429SFrederic Weisbecker * cpumask RW mask : bitmask of allowed CPUs for the workers 48376ba94429SFrederic Weisbecker */ 48386ba94429SFrederic Weisbecker struct wq_device { 48396ba94429SFrederic Weisbecker struct workqueue_struct *wq; 48406ba94429SFrederic Weisbecker struct device dev; 48416ba94429SFrederic Weisbecker }; 48426ba94429SFrederic Weisbecker 48436ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev) 48446ba94429SFrederic Weisbecker { 48456ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 48466ba94429SFrederic Weisbecker 48476ba94429SFrederic Weisbecker return wq_dev->wq; 48486ba94429SFrederic Weisbecker } 48496ba94429SFrederic Weisbecker 48506ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, 48516ba94429SFrederic Weisbecker char *buf) 48526ba94429SFrederic Weisbecker { 48536ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 48546ba94429SFrederic Weisbecker 48556ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 48566ba94429SFrederic Weisbecker } 48576ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu); 48586ba94429SFrederic Weisbecker 48596ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev, 48606ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 48616ba94429SFrederic Weisbecker { 48626ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 48636ba94429SFrederic Weisbecker 48646ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 48656ba94429SFrederic Weisbecker } 48666ba94429SFrederic Weisbecker 48676ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev, 48686ba94429SFrederic Weisbecker struct device_attribute *attr, const char *buf, 48696ba94429SFrederic Weisbecker size_t count) 48706ba94429SFrederic Weisbecker { 48716ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 48726ba94429SFrederic Weisbecker int val; 48736ba94429SFrederic Weisbecker 48746ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &val) != 1 || val <= 0) 48756ba94429SFrederic Weisbecker return -EINVAL; 48766ba94429SFrederic Weisbecker 48776ba94429SFrederic Weisbecker workqueue_set_max_active(wq, val); 48786ba94429SFrederic Weisbecker return count; 48796ba94429SFrederic Weisbecker } 48806ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active); 48816ba94429SFrederic Weisbecker 48826ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = { 48836ba94429SFrederic Weisbecker &dev_attr_per_cpu.attr, 48846ba94429SFrederic Weisbecker &dev_attr_max_active.attr, 48856ba94429SFrederic Weisbecker NULL, 48866ba94429SFrederic Weisbecker }; 48876ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs); 48886ba94429SFrederic Weisbecker 48896ba94429SFrederic Weisbecker static ssize_t wq_pool_ids_show(struct device *dev, 48906ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 48916ba94429SFrederic Weisbecker { 48926ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 48936ba94429SFrederic Weisbecker const char *delim = ""; 48946ba94429SFrederic Weisbecker int node, written = 0; 48956ba94429SFrederic Weisbecker 48966ba94429SFrederic Weisbecker rcu_read_lock_sched(); 48976ba94429SFrederic Weisbecker for_each_node(node) { 48986ba94429SFrederic Weisbecker written += scnprintf(buf + written, PAGE_SIZE - written, 48996ba94429SFrederic Weisbecker "%s%d:%d", delim, node, 49006ba94429SFrederic Weisbecker unbound_pwq_by_node(wq, node)->pool->id); 49016ba94429SFrederic Weisbecker delim = " "; 49026ba94429SFrederic Weisbecker } 49036ba94429SFrederic Weisbecker written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); 49046ba94429SFrederic Weisbecker rcu_read_unlock_sched(); 49056ba94429SFrederic Weisbecker 49066ba94429SFrederic Weisbecker return written; 49076ba94429SFrederic Weisbecker } 49086ba94429SFrederic Weisbecker 49096ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 49106ba94429SFrederic Weisbecker char *buf) 49116ba94429SFrederic Weisbecker { 49126ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 49136ba94429SFrederic Weisbecker int written; 49146ba94429SFrederic Weisbecker 49156ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 49166ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); 49176ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 49186ba94429SFrederic Weisbecker 49196ba94429SFrederic Weisbecker return written; 49206ba94429SFrederic Weisbecker } 49216ba94429SFrederic Weisbecker 49226ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */ 49236ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 49246ba94429SFrederic Weisbecker { 49256ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 49266ba94429SFrederic Weisbecker 49276ba94429SFrederic Weisbecker attrs = alloc_workqueue_attrs(GFP_KERNEL); 49286ba94429SFrederic Weisbecker if (!attrs) 49296ba94429SFrederic Weisbecker return NULL; 49306ba94429SFrederic Weisbecker 49316ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 49326ba94429SFrederic Weisbecker copy_workqueue_attrs(attrs, wq->unbound_attrs); 49336ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 49346ba94429SFrederic Weisbecker return attrs; 49356ba94429SFrederic Weisbecker } 49366ba94429SFrederic Weisbecker 49376ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 49386ba94429SFrederic Weisbecker const char *buf, size_t count) 49396ba94429SFrederic Weisbecker { 49406ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 49416ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 49426ba94429SFrederic Weisbecker int ret; 49436ba94429SFrederic Weisbecker 49446ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 49456ba94429SFrederic Weisbecker if (!attrs) 49466ba94429SFrederic Weisbecker return -ENOMEM; 49476ba94429SFrederic Weisbecker 49486ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &attrs->nice) == 1 && 49496ba94429SFrederic Weisbecker attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) 49506ba94429SFrederic Weisbecker ret = apply_workqueue_attrs(wq, attrs); 49516ba94429SFrederic Weisbecker else 49526ba94429SFrederic Weisbecker ret = -EINVAL; 49536ba94429SFrederic Weisbecker 49546ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 49556ba94429SFrederic Weisbecker return ret ?: count; 49566ba94429SFrederic Weisbecker } 49576ba94429SFrederic Weisbecker 49586ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev, 49596ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 49606ba94429SFrederic Weisbecker { 49616ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 49626ba94429SFrederic Weisbecker int written; 49636ba94429SFrederic Weisbecker 49646ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 49656ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 49666ba94429SFrederic Weisbecker cpumask_pr_args(wq->unbound_attrs->cpumask)); 49676ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 49686ba94429SFrederic Weisbecker return written; 49696ba94429SFrederic Weisbecker } 49706ba94429SFrederic Weisbecker 49716ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev, 49726ba94429SFrederic Weisbecker struct device_attribute *attr, 49736ba94429SFrederic Weisbecker const char *buf, size_t count) 49746ba94429SFrederic Weisbecker { 49756ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 49766ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 49776ba94429SFrederic Weisbecker int ret; 49786ba94429SFrederic Weisbecker 49796ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 49806ba94429SFrederic Weisbecker if (!attrs) 49816ba94429SFrederic Weisbecker return -ENOMEM; 49826ba94429SFrederic Weisbecker 49836ba94429SFrederic Weisbecker ret = cpumask_parse(buf, attrs->cpumask); 49846ba94429SFrederic Weisbecker if (!ret) 49856ba94429SFrederic Weisbecker ret = apply_workqueue_attrs(wq, attrs); 49866ba94429SFrederic Weisbecker 49876ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 49886ba94429SFrederic Weisbecker return ret ?: count; 49896ba94429SFrederic Weisbecker } 49906ba94429SFrederic Weisbecker 49916ba94429SFrederic Weisbecker static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr, 49926ba94429SFrederic Weisbecker char *buf) 49936ba94429SFrederic Weisbecker { 49946ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 49956ba94429SFrederic Weisbecker int written; 49966ba94429SFrederic Weisbecker 49976ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 49986ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", 49996ba94429SFrederic Weisbecker !wq->unbound_attrs->no_numa); 50006ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 50016ba94429SFrederic Weisbecker 50026ba94429SFrederic Weisbecker return written; 50036ba94429SFrederic Weisbecker } 50046ba94429SFrederic Weisbecker 50056ba94429SFrederic Weisbecker static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr, 50066ba94429SFrederic Weisbecker const char *buf, size_t count) 50076ba94429SFrederic Weisbecker { 50086ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 50096ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 50106ba94429SFrederic Weisbecker int v, ret; 50116ba94429SFrederic Weisbecker 50126ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 50136ba94429SFrederic Weisbecker if (!attrs) 50146ba94429SFrederic Weisbecker return -ENOMEM; 50156ba94429SFrederic Weisbecker 50166ba94429SFrederic Weisbecker ret = -EINVAL; 50176ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &v) == 1) { 50186ba94429SFrederic Weisbecker attrs->no_numa = !v; 50196ba94429SFrederic Weisbecker ret = apply_workqueue_attrs(wq, attrs); 50206ba94429SFrederic Weisbecker } 50216ba94429SFrederic Weisbecker 50226ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 50236ba94429SFrederic Weisbecker return ret ?: count; 50246ba94429SFrederic Weisbecker } 50256ba94429SFrederic Weisbecker 50266ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = { 50276ba94429SFrederic Weisbecker __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL), 50286ba94429SFrederic Weisbecker __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 50296ba94429SFrederic Weisbecker __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 50306ba94429SFrederic Weisbecker __ATTR(numa, 0644, wq_numa_show, wq_numa_store), 50316ba94429SFrederic Weisbecker __ATTR_NULL, 50326ba94429SFrederic Weisbecker }; 50336ba94429SFrederic Weisbecker 50346ba94429SFrederic Weisbecker static struct bus_type wq_subsys = { 50356ba94429SFrederic Weisbecker .name = "workqueue", 50366ba94429SFrederic Weisbecker .dev_groups = wq_sysfs_groups, 50376ba94429SFrederic Weisbecker }; 50386ba94429SFrederic Weisbecker 5039b05a7928SFrederic Weisbecker static ssize_t wq_unbound_cpumask_show(struct device *dev, 5040b05a7928SFrederic Weisbecker struct device_attribute *attr, char *buf) 5041b05a7928SFrederic Weisbecker { 5042b05a7928SFrederic Weisbecker int written; 5043b05a7928SFrederic Weisbecker 5044*042f7df1SLai Jiangshan mutex_lock(&wq_pool_mutex); 5045b05a7928SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 5046b05a7928SFrederic Weisbecker cpumask_pr_args(wq_unbound_cpumask)); 5047*042f7df1SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5048b05a7928SFrederic Weisbecker 5049b05a7928SFrederic Weisbecker return written; 5050b05a7928SFrederic Weisbecker } 5051b05a7928SFrederic Weisbecker 5052*042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev, 5053*042f7df1SLai Jiangshan struct device_attribute *attr, const char *buf, size_t count) 5054*042f7df1SLai Jiangshan { 5055*042f7df1SLai Jiangshan cpumask_var_t cpumask; 5056*042f7df1SLai Jiangshan int ret; 5057*042f7df1SLai Jiangshan 5058*042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 5059*042f7df1SLai Jiangshan return -ENOMEM; 5060*042f7df1SLai Jiangshan 5061*042f7df1SLai Jiangshan ret = cpumask_parse(buf, cpumask); 5062*042f7df1SLai Jiangshan if (!ret) 5063*042f7df1SLai Jiangshan ret = workqueue_set_unbound_cpumask(cpumask); 5064*042f7df1SLai Jiangshan 5065*042f7df1SLai Jiangshan free_cpumask_var(cpumask); 5066*042f7df1SLai Jiangshan return ret ? ret : count; 5067*042f7df1SLai Jiangshan } 5068*042f7df1SLai Jiangshan 5069b05a7928SFrederic Weisbecker static struct device_attribute wq_sysfs_cpumask_attr = 5070*042f7df1SLai Jiangshan __ATTR(cpumask, 0644, wq_unbound_cpumask_show, 5071*042f7df1SLai Jiangshan wq_unbound_cpumask_store); 5072b05a7928SFrederic Weisbecker 50736ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void) 50746ba94429SFrederic Weisbecker { 5075b05a7928SFrederic Weisbecker int err; 5076b05a7928SFrederic Weisbecker 5077b05a7928SFrederic Weisbecker err = subsys_virtual_register(&wq_subsys, NULL); 5078b05a7928SFrederic Weisbecker if (err) 5079b05a7928SFrederic Weisbecker return err; 5080b05a7928SFrederic Weisbecker 5081b05a7928SFrederic Weisbecker return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr); 50826ba94429SFrederic Weisbecker } 50836ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init); 50846ba94429SFrederic Weisbecker 50856ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev) 50866ba94429SFrederic Weisbecker { 50876ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 50886ba94429SFrederic Weisbecker 50896ba94429SFrederic Weisbecker kfree(wq_dev); 50906ba94429SFrederic Weisbecker } 50916ba94429SFrederic Weisbecker 50926ba94429SFrederic Weisbecker /** 50936ba94429SFrederic Weisbecker * workqueue_sysfs_register - make a workqueue visible in sysfs 50946ba94429SFrederic Weisbecker * @wq: the workqueue to register 50956ba94429SFrederic Weisbecker * 50966ba94429SFrederic Weisbecker * Expose @wq in sysfs under /sys/bus/workqueue/devices. 50976ba94429SFrederic Weisbecker * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 50986ba94429SFrederic Weisbecker * which is the preferred method. 50996ba94429SFrederic Weisbecker * 51006ba94429SFrederic Weisbecker * Workqueue user should use this function directly iff it wants to apply 51016ba94429SFrederic Weisbecker * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 51026ba94429SFrederic Weisbecker * apply_workqueue_attrs() may race against userland updating the 51036ba94429SFrederic Weisbecker * attributes. 51046ba94429SFrederic Weisbecker * 51056ba94429SFrederic Weisbecker * Return: 0 on success, -errno on failure. 51066ba94429SFrederic Weisbecker */ 51076ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq) 51086ba94429SFrederic Weisbecker { 51096ba94429SFrederic Weisbecker struct wq_device *wq_dev; 51106ba94429SFrederic Weisbecker int ret; 51116ba94429SFrederic Weisbecker 51126ba94429SFrederic Weisbecker /* 51136ba94429SFrederic Weisbecker * Adjusting max_active or creating new pwqs by applyting 51146ba94429SFrederic Weisbecker * attributes breaks ordering guarantee. Disallow exposing ordered 51156ba94429SFrederic Weisbecker * workqueues. 51166ba94429SFrederic Weisbecker */ 51176ba94429SFrederic Weisbecker if (WARN_ON(wq->flags & __WQ_ORDERED)) 51186ba94429SFrederic Weisbecker return -EINVAL; 51196ba94429SFrederic Weisbecker 51206ba94429SFrederic Weisbecker wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 51216ba94429SFrederic Weisbecker if (!wq_dev) 51226ba94429SFrederic Weisbecker return -ENOMEM; 51236ba94429SFrederic Weisbecker 51246ba94429SFrederic Weisbecker wq_dev->wq = wq; 51256ba94429SFrederic Weisbecker wq_dev->dev.bus = &wq_subsys; 51266ba94429SFrederic Weisbecker wq_dev->dev.init_name = wq->name; 51276ba94429SFrederic Weisbecker wq_dev->dev.release = wq_device_release; 51286ba94429SFrederic Weisbecker 51296ba94429SFrederic Weisbecker /* 51306ba94429SFrederic Weisbecker * unbound_attrs are created separately. Suppress uevent until 51316ba94429SFrederic Weisbecker * everything is ready. 51326ba94429SFrederic Weisbecker */ 51336ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, true); 51346ba94429SFrederic Weisbecker 51356ba94429SFrederic Weisbecker ret = device_register(&wq_dev->dev); 51366ba94429SFrederic Weisbecker if (ret) { 51376ba94429SFrederic Weisbecker kfree(wq_dev); 51386ba94429SFrederic Weisbecker wq->wq_dev = NULL; 51396ba94429SFrederic Weisbecker return ret; 51406ba94429SFrederic Weisbecker } 51416ba94429SFrederic Weisbecker 51426ba94429SFrederic Weisbecker if (wq->flags & WQ_UNBOUND) { 51436ba94429SFrederic Weisbecker struct device_attribute *attr; 51446ba94429SFrederic Weisbecker 51456ba94429SFrederic Weisbecker for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 51466ba94429SFrederic Weisbecker ret = device_create_file(&wq_dev->dev, attr); 51476ba94429SFrederic Weisbecker if (ret) { 51486ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 51496ba94429SFrederic Weisbecker wq->wq_dev = NULL; 51506ba94429SFrederic Weisbecker return ret; 51516ba94429SFrederic Weisbecker } 51526ba94429SFrederic Weisbecker } 51536ba94429SFrederic Weisbecker } 51546ba94429SFrederic Weisbecker 51556ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, false); 51566ba94429SFrederic Weisbecker kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 51576ba94429SFrederic Weisbecker return 0; 51586ba94429SFrederic Weisbecker } 51596ba94429SFrederic Weisbecker 51606ba94429SFrederic Weisbecker /** 51616ba94429SFrederic Weisbecker * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 51626ba94429SFrederic Weisbecker * @wq: the workqueue to unregister 51636ba94429SFrederic Weisbecker * 51646ba94429SFrederic Weisbecker * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 51656ba94429SFrederic Weisbecker */ 51666ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 51676ba94429SFrederic Weisbecker { 51686ba94429SFrederic Weisbecker struct wq_device *wq_dev = wq->wq_dev; 51696ba94429SFrederic Weisbecker 51706ba94429SFrederic Weisbecker if (!wq->wq_dev) 51716ba94429SFrederic Weisbecker return; 51726ba94429SFrederic Weisbecker 51736ba94429SFrederic Weisbecker wq->wq_dev = NULL; 51746ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 51756ba94429SFrederic Weisbecker } 51766ba94429SFrederic Weisbecker #else /* CONFIG_SYSFS */ 51776ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 51786ba94429SFrederic Weisbecker #endif /* CONFIG_SYSFS */ 51796ba94429SFrederic Weisbecker 5180bce90380STejun Heo static void __init wq_numa_init(void) 5181bce90380STejun Heo { 5182bce90380STejun Heo cpumask_var_t *tbl; 5183bce90380STejun Heo int node, cpu; 5184bce90380STejun Heo 5185bce90380STejun Heo if (num_possible_nodes() <= 1) 5186bce90380STejun Heo return; 5187bce90380STejun Heo 5188d55262c4STejun Heo if (wq_disable_numa) { 5189d55262c4STejun Heo pr_info("workqueue: NUMA affinity support disabled\n"); 5190d55262c4STejun Heo return; 5191d55262c4STejun Heo } 5192d55262c4STejun Heo 51934c16bd32STejun Heo wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL); 51944c16bd32STejun Heo BUG_ON(!wq_update_unbound_numa_attrs_buf); 51954c16bd32STejun Heo 5196bce90380STejun Heo /* 5197bce90380STejun Heo * We want masks of possible CPUs of each node which isn't readily 5198bce90380STejun Heo * available. Build one from cpu_to_node() which should have been 5199bce90380STejun Heo * fully initialized by now. 5200bce90380STejun Heo */ 5201ddcb57e2SLai Jiangshan tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL); 5202bce90380STejun Heo BUG_ON(!tbl); 5203bce90380STejun Heo 5204bce90380STejun Heo for_each_node(node) 52055a6024f1SYasuaki Ishimatsu BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL, 52061be0c25dSTejun Heo node_online(node) ? node : NUMA_NO_NODE)); 5207bce90380STejun Heo 5208bce90380STejun Heo for_each_possible_cpu(cpu) { 5209bce90380STejun Heo node = cpu_to_node(cpu); 5210bce90380STejun Heo if (WARN_ON(node == NUMA_NO_NODE)) { 5211bce90380STejun Heo pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu); 5212bce90380STejun Heo /* happens iff arch is bonkers, let's just proceed */ 5213bce90380STejun Heo return; 5214bce90380STejun Heo } 5215bce90380STejun Heo cpumask_set_cpu(cpu, tbl[node]); 5216bce90380STejun Heo } 5217bce90380STejun Heo 5218bce90380STejun Heo wq_numa_possible_cpumask = tbl; 5219bce90380STejun Heo wq_numa_enabled = true; 5220bce90380STejun Heo } 5221bce90380STejun Heo 52226ee0578bSSuresh Siddha static int __init init_workqueues(void) 52231da177e4SLinus Torvalds { 52247a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 52257a4e344cSTejun Heo int i, cpu; 5226c34056a3STejun Heo 5227e904e6c2STejun Heo WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 5228e904e6c2STejun Heo 5229b05a7928SFrederic Weisbecker BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL)); 5230b05a7928SFrederic Weisbecker cpumask_copy(wq_unbound_cpumask, cpu_possible_mask); 5231b05a7928SFrederic Weisbecker 5232e904e6c2STejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 5233e904e6c2STejun Heo 523465758202STejun Heo cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP); 5235a5b4e57dSLai Jiangshan hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN); 52368b03ae3cSTejun Heo 5237bce90380STejun Heo wq_numa_init(); 5238bce90380STejun Heo 5239706026c2STejun Heo /* initialize CPU pools */ 524029c91e99STejun Heo for_each_possible_cpu(cpu) { 52414ce62e9eSTejun Heo struct worker_pool *pool; 52428b03ae3cSTejun Heo 52437a4e344cSTejun Heo i = 0; 5244f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 52457a4e344cSTejun Heo BUG_ON(init_worker_pool(pool)); 5246ec22ca5eSTejun Heo pool->cpu = cpu; 52477a4e344cSTejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 52487a4e344cSTejun Heo pool->attrs->nice = std_nice[i++]; 5249f3f90ad4STejun Heo pool->node = cpu_to_node(cpu); 52507a4e344cSTejun Heo 52519daf9e67STejun Heo /* alloc pool ID */ 525268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 52539daf9e67STejun Heo BUG_ON(worker_pool_assign_id(pool)); 525468e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 52554ce62e9eSTejun Heo } 52568b03ae3cSTejun Heo } 52578b03ae3cSTejun Heo 5258e22bee78STejun Heo /* create the initial worker */ 525929c91e99STejun Heo for_each_online_cpu(cpu) { 52604ce62e9eSTejun Heo struct worker_pool *pool; 5261e22bee78STejun Heo 5262f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 526324647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 5264051e1850SLai Jiangshan BUG_ON(!create_worker(pool)); 5265e22bee78STejun Heo } 52664ce62e9eSTejun Heo } 5267e22bee78STejun Heo 52688a2b7538STejun Heo /* create default unbound and ordered wq attrs */ 526929c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 527029c91e99STejun Heo struct workqueue_attrs *attrs; 527129c91e99STejun Heo 527229c91e99STejun Heo BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL))); 527329c91e99STejun Heo attrs->nice = std_nice[i]; 527429c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 52758a2b7538STejun Heo 52768a2b7538STejun Heo /* 52778a2b7538STejun Heo * An ordered wq should have only one pwq as ordering is 52788a2b7538STejun Heo * guaranteed by max_active which is enforced by pwqs. 52798a2b7538STejun Heo * Turn off NUMA so that dfl_pwq is used for all nodes. 52808a2b7538STejun Heo */ 52818a2b7538STejun Heo BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL))); 52828a2b7538STejun Heo attrs->nice = std_nice[i]; 52838a2b7538STejun Heo attrs->no_numa = true; 52848a2b7538STejun Heo ordered_wq_attrs[i] = attrs; 528529c91e99STejun Heo } 528629c91e99STejun Heo 5287d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 52881aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 5289d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 5290f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 5291f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 529224d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 529324d51addSTejun Heo WQ_FREEZABLE, 0); 52940668106cSViresh Kumar system_power_efficient_wq = alloc_workqueue("events_power_efficient", 52950668106cSViresh Kumar WQ_POWER_EFFICIENT, 0); 52960668106cSViresh Kumar system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient", 52970668106cSViresh Kumar WQ_FREEZABLE | WQ_POWER_EFFICIENT, 52980668106cSViresh Kumar 0); 52991aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 53000668106cSViresh Kumar !system_unbound_wq || !system_freezable_wq || 53010668106cSViresh Kumar !system_power_efficient_wq || 53020668106cSViresh Kumar !system_freezable_power_efficient_wq); 53036ee0578bSSuresh Siddha return 0; 53041da177e4SLinus Torvalds } 53056ee0578bSSuresh Siddha early_initcall(init_workqueues); 5306