11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * workqueue.h --- work queue handling for Linux. 31da177e4SLinus Torvalds */ 41da177e4SLinus Torvalds 51da177e4SLinus Torvalds #ifndef _LINUX_WORKQUEUE_H 61da177e4SLinus Torvalds #define _LINUX_WORKQUEUE_H 71da177e4SLinus Torvalds 81da177e4SLinus Torvalds #include <linux/timer.h> 91da177e4SLinus Torvalds #include <linux/linkage.h> 101da177e4SLinus Torvalds #include <linux/bitops.h> 114e6045f1SJohannes Berg #include <linux/lockdep.h> 127a22ad75STejun Heo #include <linux/threads.h> 1360063497SArun Sharma #include <linux/atomic.h> 147a4e344cSTejun Heo #include <linux/cpumask.h> 151da177e4SLinus Torvalds 161da177e4SLinus Torvalds struct workqueue_struct; 171da177e4SLinus Torvalds 1865f27f38SDavid Howells struct work_struct; 1965f27f38SDavid Howells typedef void (*work_func_t)(struct work_struct *work); 20d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data); 216bb49e59SDavid Howells 22a08727baSLinus Torvalds /* 23a08727baSLinus Torvalds * The first word is the work queue pointer and the flags rolled into 24a08727baSLinus Torvalds * one 25a08727baSLinus Torvalds */ 26a08727baSLinus Torvalds #define work_data_bits(work) ((unsigned long *)(&(work)->data)) 27a08727baSLinus Torvalds 2822df02bbSTejun Heo enum { 2922df02bbSTejun Heo WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */ 308a2e8e5dSTejun Heo WORK_STRUCT_DELAYED_BIT = 1, /* work item is delayed */ 31112202d9STejun Heo WORK_STRUCT_PWQ_BIT = 2, /* data points to pwq */ 328a2e8e5dSTejun Heo WORK_STRUCT_LINKED_BIT = 3, /* next work is linked to this one */ 3322df02bbSTejun Heo #ifdef CONFIG_DEBUG_OBJECTS_WORK 348a2e8e5dSTejun Heo WORK_STRUCT_STATIC_BIT = 4, /* static initializer (debugobjects) */ 358a2e8e5dSTejun Heo WORK_STRUCT_COLOR_SHIFT = 5, /* color for workqueue flushing */ 360f900049STejun Heo #else 378a2e8e5dSTejun Heo WORK_STRUCT_COLOR_SHIFT = 4, /* color for workqueue flushing */ 3822df02bbSTejun Heo #endif 3922df02bbSTejun Heo 4073f53c4aSTejun Heo WORK_STRUCT_COLOR_BITS = 4, 4173f53c4aSTejun Heo 4222df02bbSTejun Heo WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT, 438a2e8e5dSTejun Heo WORK_STRUCT_DELAYED = 1 << WORK_STRUCT_DELAYED_BIT, 44112202d9STejun Heo WORK_STRUCT_PWQ = 1 << WORK_STRUCT_PWQ_BIT, 45affee4b2STejun Heo WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT, 4622df02bbSTejun Heo #ifdef CONFIG_DEBUG_OBJECTS_WORK 4722df02bbSTejun Heo WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT, 4822df02bbSTejun Heo #else 4922df02bbSTejun Heo WORK_STRUCT_STATIC = 0, 5022df02bbSTejun Heo #endif 5122df02bbSTejun Heo 5273f53c4aSTejun Heo /* 5373f53c4aSTejun Heo * The last color is no color used for works which don't 5473f53c4aSTejun Heo * participate in workqueue flushing. 5573f53c4aSTejun Heo */ 5673f53c4aSTejun Heo WORK_NR_COLORS = (1 << WORK_STRUCT_COLOR_BITS) - 1, 5773f53c4aSTejun Heo WORK_NO_COLOR = WORK_NR_COLORS, 5873f53c4aSTejun Heo 59bdbc5dd7STejun Heo /* special cpu IDs */ 60f3421797STejun Heo WORK_CPU_UNBOUND = NR_CPUS, 616be19588SLai Jiangshan WORK_CPU_END = NR_CPUS + 1, 62bdbc5dd7STejun Heo 6373f53c4aSTejun Heo /* 64112202d9STejun Heo * Reserve 7 bits off of pwq pointer w/ debugobjects turned off. 65112202d9STejun Heo * This makes pwqs aligned to 256 bytes and allows 15 workqueue 66112202d9STejun Heo * flush colors. 6773f53c4aSTejun Heo */ 6873f53c4aSTejun Heo WORK_STRUCT_FLAG_BITS = WORK_STRUCT_COLOR_SHIFT + 6973f53c4aSTejun Heo WORK_STRUCT_COLOR_BITS, 7073f53c4aSTejun Heo 71112202d9STejun Heo /* data contains off-queue information when !WORK_STRUCT_PWQ */ 7245d9550aSLai Jiangshan WORK_OFFQ_FLAG_BASE = WORK_STRUCT_COLOR_SHIFT, 73bbb68dfaSTejun Heo 74bbb68dfaSTejun Heo WORK_OFFQ_CANCELING = (1 << WORK_OFFQ_FLAG_BASE), 75bbb68dfaSTejun Heo 76715b06b8STejun Heo /* 77715b06b8STejun Heo * When a work item is off queue, its high bits point to the last 787c3eed5cSTejun Heo * pool it was on. Cap at 31 bits and use the highest number to 797c3eed5cSTejun Heo * indicate that no pool is associated. 80715b06b8STejun Heo */ 81bbb68dfaSTejun Heo WORK_OFFQ_FLAG_BITS = 1, 827c3eed5cSTejun Heo WORK_OFFQ_POOL_SHIFT = WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS, 837c3eed5cSTejun Heo WORK_OFFQ_LEFT = BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT, 847c3eed5cSTejun Heo WORK_OFFQ_POOL_BITS = WORK_OFFQ_LEFT <= 31 ? WORK_OFFQ_LEFT : 31, 857c3eed5cSTejun Heo WORK_OFFQ_POOL_NONE = (1LU << WORK_OFFQ_POOL_BITS) - 1, 86b5490077STejun Heo 87b5490077STejun Heo /* convenience constants */ 880f900049STejun Heo WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1, 8922df02bbSTejun Heo WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK, 907c3eed5cSTejun Heo WORK_STRUCT_NO_POOL = (unsigned long)WORK_OFFQ_POOL_NONE << WORK_OFFQ_POOL_SHIFT, 91dcd989cbSTejun Heo 92dcd989cbSTejun Heo /* bit mask for work_busy() return values */ 93dcd989cbSTejun Heo WORK_BUSY_PENDING = 1 << 0, 94dcd989cbSTejun Heo WORK_BUSY_RUNNING = 1 << 1, 9522df02bbSTejun Heo }; 9622df02bbSTejun Heo 971da177e4SLinus Torvalds struct work_struct { 98a08727baSLinus Torvalds atomic_long_t data; 991da177e4SLinus Torvalds struct list_head entry; 1006bb49e59SDavid Howells work_func_t func; 1014e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 1024e6045f1SJohannes Berg struct lockdep_map lockdep_map; 1034e6045f1SJohannes Berg #endif 10452bad64dSDavid Howells }; 10552bad64dSDavid Howells 1067c3eed5cSTejun Heo #define WORK_DATA_INIT() ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL) 1077a22ad75STejun Heo #define WORK_DATA_STATIC_INIT() \ 1087c3eed5cSTejun Heo ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL | WORK_STRUCT_STATIC) 109a08727baSLinus Torvalds 11052bad64dSDavid Howells struct delayed_work { 11152bad64dSDavid Howells struct work_struct work; 1121da177e4SLinus Torvalds struct timer_list timer; 11360c057bcSLai Jiangshan 11460c057bcSLai Jiangshan /* target workqueue and CPU ->timer uses to queue ->work */ 11560c057bcSLai Jiangshan struct workqueue_struct *wq; 1161265057fSTejun Heo int cpu; 1171da177e4SLinus Torvalds }; 1181da177e4SLinus Torvalds 1197a4e344cSTejun Heo /* 1207a4e344cSTejun Heo * A struct for workqueue attributes. This can be used to change 1217a4e344cSTejun Heo * attributes of an unbound workqueue. 122d55262c4STejun Heo * 123d55262c4STejun Heo * Unlike other fields, ->no_numa isn't a property of a worker_pool. It 124d55262c4STejun Heo * only modifies how apply_workqueue_attrs() select pools and thus doesn't 125d55262c4STejun Heo * participate in pool hash calculations or equality comparisons. 1267a4e344cSTejun Heo */ 1277a4e344cSTejun Heo struct workqueue_attrs { 1287a4e344cSTejun Heo int nice; /* nice level */ 1297a4e344cSTejun Heo cpumask_var_t cpumask; /* allowed CPUs */ 130d55262c4STejun Heo bool no_numa; /* disable NUMA affinity */ 1317a4e344cSTejun Heo }; 1327a4e344cSTejun Heo 133bf6aede7SJean Delvare static inline struct delayed_work *to_delayed_work(struct work_struct *work) 134bf6aede7SJean Delvare { 135bf6aede7SJean Delvare return container_of(work, struct delayed_work, work); 136bf6aede7SJean Delvare } 137bf6aede7SJean Delvare 1381fa44ecaSJames Bottomley struct execute_work { 1391fa44ecaSJames Bottomley struct work_struct work; 1401fa44ecaSJames Bottomley }; 1411fa44ecaSJames Bottomley 1424e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 1434e6045f1SJohannes Berg /* 1444e6045f1SJohannes Berg * NB: because we have to copy the lockdep_map, setting _key 1454e6045f1SJohannes Berg * here is required, otherwise it could get initialised to the 1464e6045f1SJohannes Berg * copy of the lockdep_map! 1474e6045f1SJohannes Berg */ 1484e6045f1SJohannes Berg #define __WORK_INIT_LOCKDEP_MAP(n, k) \ 1494e6045f1SJohannes Berg .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k), 1504e6045f1SJohannes Berg #else 1514e6045f1SJohannes Berg #define __WORK_INIT_LOCKDEP_MAP(n, k) 1524e6045f1SJohannes Berg #endif 1534e6045f1SJohannes Berg 15465f27f38SDavid Howells #define __WORK_INITIALIZER(n, f) { \ 155dc186ad7SThomas Gleixner .data = WORK_DATA_STATIC_INIT(), \ 15665f27f38SDavid Howells .entry = { &(n).entry, &(n).entry }, \ 15765f27f38SDavid Howells .func = (f), \ 1584e6045f1SJohannes Berg __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \ 15965f27f38SDavid Howells } 16065f27f38SDavid Howells 161f991b318STejun Heo #define __DELAYED_WORK_INITIALIZER(n, f, tflags) { \ 16265f27f38SDavid Howells .work = __WORK_INITIALIZER((n).work, (f)), \ 163f991b318STejun Heo .timer = __TIMER_INITIALIZER(delayed_work_timer_fn, \ 164e0aecdd8STejun Heo 0, (unsigned long)&(n), \ 165e0aecdd8STejun Heo (tflags) | TIMER_IRQSAFE), \ 166dd6414b5SPhil Carmody } 167dd6414b5SPhil Carmody 16865f27f38SDavid Howells #define DECLARE_WORK(n, f) \ 16965f27f38SDavid Howells struct work_struct n = __WORK_INITIALIZER(n, f) 17065f27f38SDavid Howells 17165f27f38SDavid Howells #define DECLARE_DELAYED_WORK(n, f) \ 172f991b318STejun Heo struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0) 17365f27f38SDavid Howells 174203b42f7STejun Heo #define DECLARE_DEFERRABLE_WORK(n, f) \ 175f991b318STejun Heo struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE) 176dd6414b5SPhil Carmody 1771da177e4SLinus Torvalds /* 17865f27f38SDavid Howells * initialize a work item's function pointer 1791da177e4SLinus Torvalds */ 18065f27f38SDavid Howells #define PREPARE_WORK(_work, _func) \ 1811da177e4SLinus Torvalds do { \ 18252bad64dSDavid Howells (_work)->func = (_func); \ 1831da177e4SLinus Torvalds } while (0) 1841da177e4SLinus Torvalds 18565f27f38SDavid Howells #define PREPARE_DELAYED_WORK(_work, _func) \ 18665f27f38SDavid Howells PREPARE_WORK(&(_work)->work, (_func)) 18752bad64dSDavid Howells 188dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 189dc186ad7SThomas Gleixner extern void __init_work(struct work_struct *work, int onstack); 190dc186ad7SThomas Gleixner extern void destroy_work_on_stack(struct work_struct *work); 1914690c4abSTejun Heo static inline unsigned int work_static(struct work_struct *work) 1924690c4abSTejun Heo { 19322df02bbSTejun Heo return *work_data_bits(work) & WORK_STRUCT_STATIC; 1944690c4abSTejun Heo } 195dc186ad7SThomas Gleixner #else 196dc186ad7SThomas Gleixner static inline void __init_work(struct work_struct *work, int onstack) { } 197dc186ad7SThomas Gleixner static inline void destroy_work_on_stack(struct work_struct *work) { } 1984690c4abSTejun Heo static inline unsigned int work_static(struct work_struct *work) { return 0; } 199dc186ad7SThomas Gleixner #endif 200dc186ad7SThomas Gleixner 2011da177e4SLinus Torvalds /* 20252bad64dSDavid Howells * initialize all of a work item in one go 203a08727baSLinus Torvalds * 204b9049df5SDmitri Vorobiev * NOTE! No point in using "atomic_long_set()": using a direct 205a08727baSLinus Torvalds * assignment of the work data initializer allows the compiler 206a08727baSLinus Torvalds * to generate better code. 2071da177e4SLinus Torvalds */ 2084e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 209dc186ad7SThomas Gleixner #define __INIT_WORK(_work, _func, _onstack) \ 2104e6045f1SJohannes Berg do { \ 2114e6045f1SJohannes Berg static struct lock_class_key __key; \ 2124e6045f1SJohannes Berg \ 213dc186ad7SThomas Gleixner __init_work((_work), _onstack); \ 2144e6045f1SJohannes Berg (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \ 2154e6045f1SJohannes Berg lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \ 2164e6045f1SJohannes Berg INIT_LIST_HEAD(&(_work)->entry); \ 2174e6045f1SJohannes Berg PREPARE_WORK((_work), (_func)); \ 2184e6045f1SJohannes Berg } while (0) 2194e6045f1SJohannes Berg #else 220dc186ad7SThomas Gleixner #define __INIT_WORK(_work, _func, _onstack) \ 2211da177e4SLinus Torvalds do { \ 222dc186ad7SThomas Gleixner __init_work((_work), _onstack); \ 22323b2e599SOleg Nesterov (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \ 22465f27f38SDavid Howells INIT_LIST_HEAD(&(_work)->entry); \ 22565f27f38SDavid Howells PREPARE_WORK((_work), (_func)); \ 22665f27f38SDavid Howells } while (0) 2274e6045f1SJohannes Berg #endif 22865f27f38SDavid Howells 229dc186ad7SThomas Gleixner #define INIT_WORK(_work, _func) \ 230dc186ad7SThomas Gleixner do { \ 231dc186ad7SThomas Gleixner __INIT_WORK((_work), (_func), 0); \ 232dc186ad7SThomas Gleixner } while (0) 233dc186ad7SThomas Gleixner 234ca1cab37SAndrew Morton #define INIT_WORK_ONSTACK(_work, _func) \ 235dc186ad7SThomas Gleixner do { \ 236dc186ad7SThomas Gleixner __INIT_WORK((_work), (_func), 1); \ 237dc186ad7SThomas Gleixner } while (0) 238dc186ad7SThomas Gleixner 239f991b318STejun Heo #define __INIT_DELAYED_WORK(_work, _func, _tflags) \ 24065f27f38SDavid Howells do { \ 24165f27f38SDavid Howells INIT_WORK(&(_work)->work, (_func)); \ 242f991b318STejun Heo __setup_timer(&(_work)->timer, delayed_work_timer_fn, \ 243e0aecdd8STejun Heo (unsigned long)(_work), \ 244e0aecdd8STejun Heo (_tflags) | TIMER_IRQSAFE); \ 24565f27f38SDavid Howells } while (0) 24665f27f38SDavid Howells 247f991b318STejun Heo #define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags) \ 2486d612b0fSPeter Zijlstra do { \ 249ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&(_work)->work, (_func)); \ 250f991b318STejun Heo __setup_timer_on_stack(&(_work)->timer, \ 251f991b318STejun Heo delayed_work_timer_fn, \ 252f991b318STejun Heo (unsigned long)(_work), \ 253e0aecdd8STejun Heo (_tflags) | TIMER_IRQSAFE); \ 2546d612b0fSPeter Zijlstra } while (0) 2556d612b0fSPeter Zijlstra 256f991b318STejun Heo #define INIT_DELAYED_WORK(_work, _func) \ 257f991b318STejun Heo __INIT_DELAYED_WORK(_work, _func, 0) 258f991b318STejun Heo 259f991b318STejun Heo #define INIT_DELAYED_WORK_ONSTACK(_work, _func) \ 260f991b318STejun Heo __INIT_DELAYED_WORK_ONSTACK(_work, _func, 0) 261f991b318STejun Heo 262203b42f7STejun Heo #define INIT_DEFERRABLE_WORK(_work, _func) \ 263f991b318STejun Heo __INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE) 264f991b318STejun Heo 265f991b318STejun Heo #define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func) \ 266f991b318STejun Heo __INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE) 26728287033SVenki Pallipadi 268365970a1SDavid Howells /** 269365970a1SDavid Howells * work_pending - Find out whether a work item is currently pending 270365970a1SDavid Howells * @work: The work item in question 271365970a1SDavid Howells */ 272365970a1SDavid Howells #define work_pending(work) \ 27322df02bbSTejun Heo test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) 274365970a1SDavid Howells 275365970a1SDavid Howells /** 276365970a1SDavid Howells * delayed_work_pending - Find out whether a delayable work item is currently 277365970a1SDavid Howells * pending 278365970a1SDavid Howells * @work: The work item in question 279365970a1SDavid Howells */ 2800221872aSLinus Torvalds #define delayed_work_pending(w) \ 2810221872aSLinus Torvalds work_pending(&(w)->work) 282365970a1SDavid Howells 28365f27f38SDavid Howells /** 28423b2e599SOleg Nesterov * work_clear_pending - for internal use only, mark a work item as not pending 28523b2e599SOleg Nesterov * @work: The work item in question 28665f27f38SDavid Howells */ 28723b2e599SOleg Nesterov #define work_clear_pending(work) \ 28822df02bbSTejun Heo clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) 28965f27f38SDavid Howells 290c54fce6eSTejun Heo /* 291c54fce6eSTejun Heo * Workqueue flags and constants. For details, please refer to 292c54fce6eSTejun Heo * Documentation/workqueue.txt. 293c54fce6eSTejun Heo */ 29497e37d7bSTejun Heo enum { 295bdbc5dd7STejun Heo WQ_NON_REENTRANT = 1 << 0, /* guarantee non-reentrance */ 296c7fc77f7STejun Heo WQ_UNBOUND = 1 << 1, /* not bound to any cpu */ 29758a69cb4STejun Heo WQ_FREEZABLE = 1 << 2, /* freeze during suspend */ 2986370a6adSTejun Heo WQ_MEM_RECLAIM = 1 << 3, /* may be used for memory reclaim */ 299649027d7STejun Heo WQ_HIGHPRI = 1 << 4, /* high priority */ 300fb0e7bebSTejun Heo WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */ 301226223abSTejun Heo WQ_SYSFS = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */ 302b71ab8c2STejun Heo 303618b01ebSTejun Heo __WQ_DRAINING = 1 << 16, /* internal: workqueue is draining */ 3048719dceaSTejun Heo __WQ_ORDERED = 1 << 17, /* internal: workqueue is ordered */ 305e41e704bSTejun Heo 306b71ab8c2STejun Heo WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */ 307f3421797STejun Heo WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */ 308b71ab8c2STejun Heo WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2, 30997e37d7bSTejun Heo }; 31052bad64dSDavid Howells 311f3421797STejun Heo /* unbound wq's aren't per-cpu, scale max_active according to #cpus */ 312f3421797STejun Heo #define WQ_UNBOUND_MAX_ACTIVE \ 313f3421797STejun Heo max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU) 314f3421797STejun Heo 315d320c038STejun Heo /* 316d320c038STejun Heo * System-wide workqueues which are always present. 317d320c038STejun Heo * 318d320c038STejun Heo * system_wq is the one used by schedule[_delayed]_work[_on](). 319d320c038STejun Heo * Multi-CPU multi-threaded. There are users which expect relatively 320d320c038STejun Heo * short queue flush time. Don't queue works which can run for too 321d320c038STejun Heo * long. 322d320c038STejun Heo * 323d320c038STejun Heo * system_long_wq is similar to system_wq but may host long running 324d320c038STejun Heo * works. Queue flushing might take relatively long. 325d320c038STejun Heo * 326f3421797STejun Heo * system_unbound_wq is unbound workqueue. Workers are not bound to 327f3421797STejun Heo * any specific CPU, not concurrency managed, and all queued works are 328f3421797STejun Heo * executed immediately as long as max_active limit is not reached and 329f3421797STejun Heo * resources are available. 3304149efb2STejun Heo * 33124d51addSTejun Heo * system_freezable_wq is equivalent to system_wq except that it's 33224d51addSTejun Heo * freezable. 333d320c038STejun Heo */ 334d320c038STejun Heo extern struct workqueue_struct *system_wq; 335d320c038STejun Heo extern struct workqueue_struct *system_long_wq; 336f3421797STejun Heo extern struct workqueue_struct *system_unbound_wq; 33724d51addSTejun Heo extern struct workqueue_struct *system_freezable_wq; 338ae930e0fSTejun Heo 3393b07e9caSTejun Heo static inline struct workqueue_struct * __deprecated __system_nrt_wq(void) 340ae930e0fSTejun Heo { 341ae930e0fSTejun Heo return system_wq; 342ae930e0fSTejun Heo } 343ae930e0fSTejun Heo 3443b07e9caSTejun Heo static inline struct workqueue_struct * __deprecated __system_nrt_freezable_wq(void) 345ae930e0fSTejun Heo { 346ae930e0fSTejun Heo return system_freezable_wq; 347ae930e0fSTejun Heo } 348ae930e0fSTejun Heo 349ae930e0fSTejun Heo /* equivlalent to system_wq and system_freezable_wq, deprecated */ 350ae930e0fSTejun Heo #define system_nrt_wq __system_nrt_wq() 351ae930e0fSTejun Heo #define system_nrt_freezable_wq __system_nrt_freezable_wq() 3521da177e4SLinus Torvalds 3534e6045f1SJohannes Berg extern struct workqueue_struct * 354b196be89STejun Heo __alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active, 355b196be89STejun Heo struct lock_class_key *key, const char *lock_name, ...) __printf(1, 6); 3564e6045f1SJohannes Berg 357b196be89STejun Heo /** 358b196be89STejun Heo * alloc_workqueue - allocate a workqueue 359b196be89STejun Heo * @fmt: printf format for the name of the workqueue 360b196be89STejun Heo * @flags: WQ_* flags 361b196be89STejun Heo * @max_active: max in-flight work items, 0 for default 362b196be89STejun Heo * @args: args for @fmt 363b196be89STejun Heo * 364b196be89STejun Heo * Allocate a workqueue with the specified parameters. For detailed 365b196be89STejun Heo * information on WQ_* flags, please refer to Documentation/workqueue.txt. 366b196be89STejun Heo * 367b196be89STejun Heo * The __lock_name macro dance is to guarantee that single lock_class_key 368b196be89STejun Heo * doesn't end up with different namesm, which isn't allowed by lockdep. 369b196be89STejun Heo * 370b196be89STejun Heo * RETURNS: 371b196be89STejun Heo * Pointer to the allocated workqueue on success, %NULL on failure. 372b196be89STejun Heo */ 3734e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 374b196be89STejun Heo #define alloc_workqueue(fmt, flags, max_active, args...) \ 3754e6045f1SJohannes Berg ({ \ 3764e6045f1SJohannes Berg static struct lock_class_key __key; \ 377eb13ba87SJohannes Berg const char *__lock_name; \ 378eb13ba87SJohannes Berg \ 379b196be89STejun Heo if (__builtin_constant_p(fmt)) \ 380b196be89STejun Heo __lock_name = (fmt); \ 381eb13ba87SJohannes Berg else \ 382b196be89STejun Heo __lock_name = #fmt; \ 3834e6045f1SJohannes Berg \ 384b196be89STejun Heo __alloc_workqueue_key((fmt), (flags), (max_active), \ 385b196be89STejun Heo &__key, __lock_name, ##args); \ 3864e6045f1SJohannes Berg }) 3874e6045f1SJohannes Berg #else 388b196be89STejun Heo #define alloc_workqueue(fmt, flags, max_active, args...) \ 389b196be89STejun Heo __alloc_workqueue_key((fmt), (flags), (max_active), \ 390b196be89STejun Heo NULL, NULL, ##args) 3914e6045f1SJohannes Berg #endif 3924e6045f1SJohannes Berg 39381dcaf65STejun Heo /** 39481dcaf65STejun Heo * alloc_ordered_workqueue - allocate an ordered workqueue 395b196be89STejun Heo * @fmt: printf format for the name of the workqueue 39658a69cb4STejun Heo * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful) 397b196be89STejun Heo * @args: args for @fmt 39881dcaf65STejun Heo * 39981dcaf65STejun Heo * Allocate an ordered workqueue. An ordered workqueue executes at 40081dcaf65STejun Heo * most one work item at any given time in the queued order. They are 40181dcaf65STejun Heo * implemented as unbound workqueues with @max_active of one. 40281dcaf65STejun Heo * 40381dcaf65STejun Heo * RETURNS: 40481dcaf65STejun Heo * Pointer to the allocated workqueue on success, %NULL on failure. 40581dcaf65STejun Heo */ 406b196be89STejun Heo #define alloc_ordered_workqueue(fmt, flags, args...) \ 4078719dceaSTejun Heo alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | (flags), 1, ##args) 40881dcaf65STejun Heo 40997e37d7bSTejun Heo #define create_workqueue(name) \ 4106370a6adSTejun Heo alloc_workqueue((name), WQ_MEM_RECLAIM, 1) 41158a69cb4STejun Heo #define create_freezable_workqueue(name) \ 41258a69cb4STejun Heo alloc_workqueue((name), WQ_FREEZABLE | WQ_UNBOUND | WQ_MEM_RECLAIM, 1) 41397e37d7bSTejun Heo #define create_singlethread_workqueue(name) \ 4146370a6adSTejun Heo alloc_workqueue((name), WQ_UNBOUND | WQ_MEM_RECLAIM, 1) 4151da177e4SLinus Torvalds 4161da177e4SLinus Torvalds extern void destroy_workqueue(struct workqueue_struct *wq); 4171da177e4SLinus Torvalds 4187a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask); 4197a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs); 4209e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq, 4219e8cd2f5STejun Heo const struct workqueue_attrs *attrs); 4227a4e344cSTejun Heo 423d4283e93STejun Heo extern bool queue_work_on(int cpu, struct workqueue_struct *wq, 424c1a220e7SZhang Rui struct work_struct *work); 425d4283e93STejun Heo extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 42652bad64dSDavid Howells struct delayed_work *work, unsigned long delay); 4278376fe22STejun Heo extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 4288376fe22STejun Heo struct delayed_work *dwork, unsigned long delay); 42928e53bddSOleg Nesterov 430b3c97528SHarvey Harrison extern void flush_workqueue(struct workqueue_struct *wq); 4319c5a2ba7STejun Heo extern void drain_workqueue(struct workqueue_struct *wq); 43228e53bddSOleg Nesterov extern void flush_scheduled_work(void); 4331da177e4SLinus Torvalds 43465f27f38SDavid Howells extern int schedule_on_each_cpu(work_func_t func); 4351da177e4SLinus Torvalds 43665f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *); 4371da177e4SLinus Torvalds 438401a8d04STejun Heo extern bool flush_work(struct work_struct *work); 439401a8d04STejun Heo extern bool cancel_work_sync(struct work_struct *work); 440401a8d04STejun Heo 441401a8d04STejun Heo extern bool flush_delayed_work(struct delayed_work *dwork); 44257b30ae7STejun Heo extern bool cancel_delayed_work(struct delayed_work *dwork); 443401a8d04STejun Heo extern bool cancel_delayed_work_sync(struct delayed_work *dwork); 44428e53bddSOleg Nesterov 445dcd989cbSTejun Heo extern void workqueue_set_max_active(struct workqueue_struct *wq, 446dcd989cbSTejun Heo int max_active); 447e6267616STejun Heo extern bool current_is_workqueue_rescuer(void); 448d84ff051STejun Heo extern bool workqueue_congested(int cpu, struct workqueue_struct *wq); 449dcd989cbSTejun Heo extern unsigned int work_busy(struct work_struct *work); 450dcd989cbSTejun Heo 4518425e3d5STejun Heo /** 4528425e3d5STejun Heo * queue_work - queue work on a workqueue 4538425e3d5STejun Heo * @wq: workqueue to use 4548425e3d5STejun Heo * @work: work to queue 4558425e3d5STejun Heo * 4568425e3d5STejun Heo * Returns %false if @work was already on a queue, %true otherwise. 4578425e3d5STejun Heo * 4588425e3d5STejun Heo * We queue the work to the CPU on which it was submitted, but if the CPU dies 4598425e3d5STejun Heo * it can be processed by another CPU. 4608425e3d5STejun Heo */ 4618425e3d5STejun Heo static inline bool queue_work(struct workqueue_struct *wq, 4628425e3d5STejun Heo struct work_struct *work) 4638425e3d5STejun Heo { 4648425e3d5STejun Heo return queue_work_on(WORK_CPU_UNBOUND, wq, work); 4658425e3d5STejun Heo } 4668425e3d5STejun Heo 4678425e3d5STejun Heo /** 4688425e3d5STejun Heo * queue_delayed_work - queue work on a workqueue after delay 4698425e3d5STejun Heo * @wq: workqueue to use 4708425e3d5STejun Heo * @dwork: delayable work to queue 4718425e3d5STejun Heo * @delay: number of jiffies to wait before queueing 4728425e3d5STejun Heo * 4738425e3d5STejun Heo * Equivalent to queue_delayed_work_on() but tries to use the local CPU. 4748425e3d5STejun Heo */ 4758425e3d5STejun Heo static inline bool queue_delayed_work(struct workqueue_struct *wq, 4768425e3d5STejun Heo struct delayed_work *dwork, 4778425e3d5STejun Heo unsigned long delay) 4788425e3d5STejun Heo { 4798425e3d5STejun Heo return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); 4808425e3d5STejun Heo } 4818425e3d5STejun Heo 4828425e3d5STejun Heo /** 4838425e3d5STejun Heo * mod_delayed_work - modify delay of or queue a delayed work 4848425e3d5STejun Heo * @wq: workqueue to use 4858425e3d5STejun Heo * @dwork: work to queue 4868425e3d5STejun Heo * @delay: number of jiffies to wait before queueing 4878425e3d5STejun Heo * 4888425e3d5STejun Heo * mod_delayed_work_on() on local CPU. 4898425e3d5STejun Heo */ 4908425e3d5STejun Heo static inline bool mod_delayed_work(struct workqueue_struct *wq, 4918425e3d5STejun Heo struct delayed_work *dwork, 4928425e3d5STejun Heo unsigned long delay) 4938425e3d5STejun Heo { 4948425e3d5STejun Heo return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); 4958425e3d5STejun Heo } 4968425e3d5STejun Heo 4978425e3d5STejun Heo /** 4988425e3d5STejun Heo * schedule_work_on - put work task on a specific cpu 4998425e3d5STejun Heo * @cpu: cpu to put the work task on 5008425e3d5STejun Heo * @work: job to be done 5018425e3d5STejun Heo * 5028425e3d5STejun Heo * This puts a job on a specific cpu 5038425e3d5STejun Heo */ 5048425e3d5STejun Heo static inline bool schedule_work_on(int cpu, struct work_struct *work) 5058425e3d5STejun Heo { 5068425e3d5STejun Heo return queue_work_on(cpu, system_wq, work); 5078425e3d5STejun Heo } 5088425e3d5STejun Heo 5098425e3d5STejun Heo /** 5108425e3d5STejun Heo * schedule_work - put work task in global workqueue 5118425e3d5STejun Heo * @work: job to be done 5128425e3d5STejun Heo * 5138425e3d5STejun Heo * Returns %false if @work was already on the kernel-global workqueue and 5148425e3d5STejun Heo * %true otherwise. 5158425e3d5STejun Heo * 5168425e3d5STejun Heo * This puts a job in the kernel-global workqueue if it was not already 5178425e3d5STejun Heo * queued and leaves it in the same position on the kernel-global 5188425e3d5STejun Heo * workqueue otherwise. 5198425e3d5STejun Heo */ 5208425e3d5STejun Heo static inline bool schedule_work(struct work_struct *work) 5218425e3d5STejun Heo { 5228425e3d5STejun Heo return queue_work(system_wq, work); 5238425e3d5STejun Heo } 5248425e3d5STejun Heo 5258425e3d5STejun Heo /** 5268425e3d5STejun Heo * schedule_delayed_work_on - queue work in global workqueue on CPU after delay 5278425e3d5STejun Heo * @cpu: cpu to use 5288425e3d5STejun Heo * @dwork: job to be done 5298425e3d5STejun Heo * @delay: number of jiffies to wait 5308425e3d5STejun Heo * 5318425e3d5STejun Heo * After waiting for a given time this puts a job in the kernel-global 5328425e3d5STejun Heo * workqueue on the specified CPU. 5338425e3d5STejun Heo */ 5348425e3d5STejun Heo static inline bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork, 5358425e3d5STejun Heo unsigned long delay) 5368425e3d5STejun Heo { 5378425e3d5STejun Heo return queue_delayed_work_on(cpu, system_wq, dwork, delay); 5388425e3d5STejun Heo } 5398425e3d5STejun Heo 5408425e3d5STejun Heo /** 5418425e3d5STejun Heo * schedule_delayed_work - put work task in global workqueue after delay 5428425e3d5STejun Heo * @dwork: job to be done 5438425e3d5STejun Heo * @delay: number of jiffies to wait or 0 for immediate execution 5448425e3d5STejun Heo * 5458425e3d5STejun Heo * After waiting for a given time this puts a job in the kernel-global 5468425e3d5STejun Heo * workqueue. 5478425e3d5STejun Heo */ 5488425e3d5STejun Heo static inline bool schedule_delayed_work(struct delayed_work *dwork, 5498425e3d5STejun Heo unsigned long delay) 5508425e3d5STejun Heo { 5518425e3d5STejun Heo return queue_delayed_work(system_wq, dwork, delay); 5528425e3d5STejun Heo } 5538425e3d5STejun Heo 5548425e3d5STejun Heo /** 5558425e3d5STejun Heo * keventd_up - is workqueue initialized yet? 5568425e3d5STejun Heo */ 5578425e3d5STejun Heo static inline bool keventd_up(void) 5588425e3d5STejun Heo { 5598425e3d5STejun Heo return system_wq != NULL; 5608425e3d5STejun Heo } 5618425e3d5STejun Heo 5621da177e4SLinus Torvalds /* 5634e49627bSOleg Nesterov * Like above, but uses del_timer() instead of del_timer_sync(). This means, 5644e49627bSOleg Nesterov * if it returns 0 the timer function may be running and the queueing is in 5654e49627bSOleg Nesterov * progress. 5664e49627bSOleg Nesterov */ 567136b5721STejun Heo static inline bool __deprecated __cancel_delayed_work(struct delayed_work *work) 5684e49627bSOleg Nesterov { 569401a8d04STejun Heo bool ret; 5704e49627bSOleg Nesterov 5714e49627bSOleg Nesterov ret = del_timer(&work->timer); 5724e49627bSOleg Nesterov if (ret) 5734e49627bSOleg Nesterov work_clear_pending(&work->work); 5744e49627bSOleg Nesterov return ret; 5754e49627bSOleg Nesterov } 5764e49627bSOleg Nesterov 577606a5020STejun Heo /* used to be different but now identical to flush_work(), deprecated */ 57843829731STejun Heo static inline bool __deprecated flush_work_sync(struct work_struct *work) 579606a5020STejun Heo { 580606a5020STejun Heo return flush_work(work); 581606a5020STejun Heo } 582606a5020STejun Heo 583606a5020STejun Heo /* used to be different but now identical to flush_delayed_work(), deprecated */ 58443829731STejun Heo static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork) 585606a5020STejun Heo { 586606a5020STejun Heo return flush_delayed_work(dwork); 587606a5020STejun Heo } 588606a5020STejun Heo 5892d3854a3SRusty Russell #ifndef CONFIG_SMP 590d84ff051STejun Heo static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg) 5912d3854a3SRusty Russell { 5922d3854a3SRusty Russell return fn(arg); 5932d3854a3SRusty Russell } 5942d3854a3SRusty Russell #else 595d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg); 5962d3854a3SRusty Russell #endif /* CONFIG_SMP */ 597a25909a4SPaul E. McKenney 598a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 599a0a1a5fdSTejun Heo extern void freeze_workqueues_begin(void); 600a0a1a5fdSTejun Heo extern bool freeze_workqueues_busy(void); 601a0a1a5fdSTejun Heo extern void thaw_workqueues(void); 602a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 603a0a1a5fdSTejun Heo 604226223abSTejun Heo #ifdef CONFIG_SYSFS 605226223abSTejun Heo int workqueue_sysfs_register(struct workqueue_struct *wq); 606226223abSTejun Heo #else /* CONFIG_SYSFS */ 607226223abSTejun Heo static inline int workqueue_sysfs_register(struct workqueue_struct *wq) 608226223abSTejun Heo { return 0; } 609226223abSTejun Heo #endif /* CONFIG_SYSFS */ 610226223abSTejun Heo 6111da177e4SLinus Torvalds #endif 612