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. 1227a4e344cSTejun Heo */ 1237a4e344cSTejun Heo struct workqueue_attrs { 1247a4e344cSTejun Heo int nice; /* nice level */ 1257a4e344cSTejun Heo cpumask_var_t cpumask; /* allowed CPUs */ 1267a4e344cSTejun Heo }; 1277a4e344cSTejun Heo 128bf6aede7SJean Delvare static inline struct delayed_work *to_delayed_work(struct work_struct *work) 129bf6aede7SJean Delvare { 130bf6aede7SJean Delvare return container_of(work, struct delayed_work, work); 131bf6aede7SJean Delvare } 132bf6aede7SJean Delvare 1331fa44ecaSJames Bottomley struct execute_work { 1341fa44ecaSJames Bottomley struct work_struct work; 1351fa44ecaSJames Bottomley }; 1361fa44ecaSJames Bottomley 1374e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 1384e6045f1SJohannes Berg /* 1394e6045f1SJohannes Berg * NB: because we have to copy the lockdep_map, setting _key 1404e6045f1SJohannes Berg * here is required, otherwise it could get initialised to the 1414e6045f1SJohannes Berg * copy of the lockdep_map! 1424e6045f1SJohannes Berg */ 1434e6045f1SJohannes Berg #define __WORK_INIT_LOCKDEP_MAP(n, k) \ 1444e6045f1SJohannes Berg .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k), 1454e6045f1SJohannes Berg #else 1464e6045f1SJohannes Berg #define __WORK_INIT_LOCKDEP_MAP(n, k) 1474e6045f1SJohannes Berg #endif 1484e6045f1SJohannes Berg 14965f27f38SDavid Howells #define __WORK_INITIALIZER(n, f) { \ 150dc186ad7SThomas Gleixner .data = WORK_DATA_STATIC_INIT(), \ 15165f27f38SDavid Howells .entry = { &(n).entry, &(n).entry }, \ 15265f27f38SDavid Howells .func = (f), \ 1534e6045f1SJohannes Berg __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \ 15465f27f38SDavid Howells } 15565f27f38SDavid Howells 156f991b318STejun Heo #define __DELAYED_WORK_INITIALIZER(n, f, tflags) { \ 15765f27f38SDavid Howells .work = __WORK_INITIALIZER((n).work, (f)), \ 158f991b318STejun Heo .timer = __TIMER_INITIALIZER(delayed_work_timer_fn, \ 159e0aecdd8STejun Heo 0, (unsigned long)&(n), \ 160e0aecdd8STejun Heo (tflags) | TIMER_IRQSAFE), \ 161dd6414b5SPhil Carmody } 162dd6414b5SPhil Carmody 16365f27f38SDavid Howells #define DECLARE_WORK(n, f) \ 16465f27f38SDavid Howells struct work_struct n = __WORK_INITIALIZER(n, f) 16565f27f38SDavid Howells 16665f27f38SDavid Howells #define DECLARE_DELAYED_WORK(n, f) \ 167f991b318STejun Heo struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0) 16865f27f38SDavid Howells 169203b42f7STejun Heo #define DECLARE_DEFERRABLE_WORK(n, f) \ 170f991b318STejun Heo struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE) 171dd6414b5SPhil Carmody 1721da177e4SLinus Torvalds /* 17365f27f38SDavid Howells * initialize a work item's function pointer 1741da177e4SLinus Torvalds */ 17565f27f38SDavid Howells #define PREPARE_WORK(_work, _func) \ 1761da177e4SLinus Torvalds do { \ 17752bad64dSDavid Howells (_work)->func = (_func); \ 1781da177e4SLinus Torvalds } while (0) 1791da177e4SLinus Torvalds 18065f27f38SDavid Howells #define PREPARE_DELAYED_WORK(_work, _func) \ 18165f27f38SDavid Howells PREPARE_WORK(&(_work)->work, (_func)) 18252bad64dSDavid Howells 183dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 184dc186ad7SThomas Gleixner extern void __init_work(struct work_struct *work, int onstack); 185dc186ad7SThomas Gleixner extern void destroy_work_on_stack(struct work_struct *work); 1864690c4abSTejun Heo static inline unsigned int work_static(struct work_struct *work) 1874690c4abSTejun Heo { 18822df02bbSTejun Heo return *work_data_bits(work) & WORK_STRUCT_STATIC; 1894690c4abSTejun Heo } 190dc186ad7SThomas Gleixner #else 191dc186ad7SThomas Gleixner static inline void __init_work(struct work_struct *work, int onstack) { } 192dc186ad7SThomas Gleixner static inline void destroy_work_on_stack(struct work_struct *work) { } 1934690c4abSTejun Heo static inline unsigned int work_static(struct work_struct *work) { return 0; } 194dc186ad7SThomas Gleixner #endif 195dc186ad7SThomas Gleixner 1961da177e4SLinus Torvalds /* 19752bad64dSDavid Howells * initialize all of a work item in one go 198a08727baSLinus Torvalds * 199b9049df5SDmitri Vorobiev * NOTE! No point in using "atomic_long_set()": using a direct 200a08727baSLinus Torvalds * assignment of the work data initializer allows the compiler 201a08727baSLinus Torvalds * to generate better code. 2021da177e4SLinus Torvalds */ 2034e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 204dc186ad7SThomas Gleixner #define __INIT_WORK(_work, _func, _onstack) \ 2054e6045f1SJohannes Berg do { \ 2064e6045f1SJohannes Berg static struct lock_class_key __key; \ 2074e6045f1SJohannes Berg \ 208dc186ad7SThomas Gleixner __init_work((_work), _onstack); \ 2094e6045f1SJohannes Berg (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \ 2104e6045f1SJohannes Berg lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \ 2114e6045f1SJohannes Berg INIT_LIST_HEAD(&(_work)->entry); \ 2124e6045f1SJohannes Berg PREPARE_WORK((_work), (_func)); \ 2134e6045f1SJohannes Berg } while (0) 2144e6045f1SJohannes Berg #else 215dc186ad7SThomas Gleixner #define __INIT_WORK(_work, _func, _onstack) \ 2161da177e4SLinus Torvalds do { \ 217dc186ad7SThomas Gleixner __init_work((_work), _onstack); \ 21823b2e599SOleg Nesterov (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \ 21965f27f38SDavid Howells INIT_LIST_HEAD(&(_work)->entry); \ 22065f27f38SDavid Howells PREPARE_WORK((_work), (_func)); \ 22165f27f38SDavid Howells } while (0) 2224e6045f1SJohannes Berg #endif 22365f27f38SDavid Howells 224dc186ad7SThomas Gleixner #define INIT_WORK(_work, _func) \ 225dc186ad7SThomas Gleixner do { \ 226dc186ad7SThomas Gleixner __INIT_WORK((_work), (_func), 0); \ 227dc186ad7SThomas Gleixner } while (0) 228dc186ad7SThomas Gleixner 229ca1cab37SAndrew Morton #define INIT_WORK_ONSTACK(_work, _func) \ 230dc186ad7SThomas Gleixner do { \ 231dc186ad7SThomas Gleixner __INIT_WORK((_work), (_func), 1); \ 232dc186ad7SThomas Gleixner } while (0) 233dc186ad7SThomas Gleixner 234f991b318STejun Heo #define __INIT_DELAYED_WORK(_work, _func, _tflags) \ 23565f27f38SDavid Howells do { \ 23665f27f38SDavid Howells INIT_WORK(&(_work)->work, (_func)); \ 237f991b318STejun Heo __setup_timer(&(_work)->timer, delayed_work_timer_fn, \ 238e0aecdd8STejun Heo (unsigned long)(_work), \ 239e0aecdd8STejun Heo (_tflags) | TIMER_IRQSAFE); \ 24065f27f38SDavid Howells } while (0) 24165f27f38SDavid Howells 242f991b318STejun Heo #define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags) \ 2436d612b0fSPeter Zijlstra do { \ 244ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&(_work)->work, (_func)); \ 245f991b318STejun Heo __setup_timer_on_stack(&(_work)->timer, \ 246f991b318STejun Heo delayed_work_timer_fn, \ 247f991b318STejun Heo (unsigned long)(_work), \ 248e0aecdd8STejun Heo (_tflags) | TIMER_IRQSAFE); \ 2496d612b0fSPeter Zijlstra } while (0) 2506d612b0fSPeter Zijlstra 251f991b318STejun Heo #define INIT_DELAYED_WORK(_work, _func) \ 252f991b318STejun Heo __INIT_DELAYED_WORK(_work, _func, 0) 253f991b318STejun Heo 254f991b318STejun Heo #define INIT_DELAYED_WORK_ONSTACK(_work, _func) \ 255f991b318STejun Heo __INIT_DELAYED_WORK_ONSTACK(_work, _func, 0) 256f991b318STejun Heo 257203b42f7STejun Heo #define INIT_DEFERRABLE_WORK(_work, _func) \ 258f991b318STejun Heo __INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE) 259f991b318STejun Heo 260f991b318STejun Heo #define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func) \ 261f991b318STejun Heo __INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE) 26228287033SVenki Pallipadi 263365970a1SDavid Howells /** 264365970a1SDavid Howells * work_pending - Find out whether a work item is currently pending 265365970a1SDavid Howells * @work: The work item in question 266365970a1SDavid Howells */ 267365970a1SDavid Howells #define work_pending(work) \ 26822df02bbSTejun Heo test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) 269365970a1SDavid Howells 270365970a1SDavid Howells /** 271365970a1SDavid Howells * delayed_work_pending - Find out whether a delayable work item is currently 272365970a1SDavid Howells * pending 273365970a1SDavid Howells * @work: The work item in question 274365970a1SDavid Howells */ 2750221872aSLinus Torvalds #define delayed_work_pending(w) \ 2760221872aSLinus Torvalds work_pending(&(w)->work) 277365970a1SDavid Howells 27865f27f38SDavid Howells /** 27923b2e599SOleg Nesterov * work_clear_pending - for internal use only, mark a work item as not pending 28023b2e599SOleg Nesterov * @work: The work item in question 28165f27f38SDavid Howells */ 28223b2e599SOleg Nesterov #define work_clear_pending(work) \ 28322df02bbSTejun Heo clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) 28465f27f38SDavid Howells 285c54fce6eSTejun Heo /* 286c54fce6eSTejun Heo * Workqueue flags and constants. For details, please refer to 287c54fce6eSTejun Heo * Documentation/workqueue.txt. 288c54fce6eSTejun Heo */ 28997e37d7bSTejun Heo enum { 290bdbc5dd7STejun Heo WQ_NON_REENTRANT = 1 << 0, /* guarantee non-reentrance */ 291c7fc77f7STejun Heo WQ_UNBOUND = 1 << 1, /* not bound to any cpu */ 29258a69cb4STejun Heo WQ_FREEZABLE = 1 << 2, /* freeze during suspend */ 2936370a6adSTejun Heo WQ_MEM_RECLAIM = 1 << 3, /* may be used for memory reclaim */ 294649027d7STejun Heo WQ_HIGHPRI = 1 << 4, /* high priority */ 295fb0e7bebSTejun Heo WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */ 296226223abSTejun Heo WQ_SYSFS = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */ 297b71ab8c2STejun Heo 298618b01ebSTejun Heo __WQ_DRAINING = 1 << 16, /* internal: workqueue is draining */ 2998719dceaSTejun Heo __WQ_ORDERED = 1 << 17, /* internal: workqueue is ordered */ 300e41e704bSTejun Heo 301b71ab8c2STejun Heo WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */ 302f3421797STejun Heo WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */ 303b71ab8c2STejun Heo WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2, 30497e37d7bSTejun Heo }; 30552bad64dSDavid Howells 306f3421797STejun Heo /* unbound wq's aren't per-cpu, scale max_active according to #cpus */ 307f3421797STejun Heo #define WQ_UNBOUND_MAX_ACTIVE \ 308f3421797STejun Heo max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU) 309f3421797STejun Heo 310d320c038STejun Heo /* 311d320c038STejun Heo * System-wide workqueues which are always present. 312d320c038STejun Heo * 313d320c038STejun Heo * system_wq is the one used by schedule[_delayed]_work[_on](). 314d320c038STejun Heo * Multi-CPU multi-threaded. There are users which expect relatively 315d320c038STejun Heo * short queue flush time. Don't queue works which can run for too 316d320c038STejun Heo * long. 317d320c038STejun Heo * 318d320c038STejun Heo * system_long_wq is similar to system_wq but may host long running 319d320c038STejun Heo * works. Queue flushing might take relatively long. 320d320c038STejun Heo * 321f3421797STejun Heo * system_unbound_wq is unbound workqueue. Workers are not bound to 322f3421797STejun Heo * any specific CPU, not concurrency managed, and all queued works are 323f3421797STejun Heo * executed immediately as long as max_active limit is not reached and 324f3421797STejun Heo * resources are available. 3254149efb2STejun Heo * 32624d51addSTejun Heo * system_freezable_wq is equivalent to system_wq except that it's 32724d51addSTejun Heo * freezable. 328d320c038STejun Heo */ 329d320c038STejun Heo extern struct workqueue_struct *system_wq; 330d320c038STejun Heo extern struct workqueue_struct *system_long_wq; 331f3421797STejun Heo extern struct workqueue_struct *system_unbound_wq; 33224d51addSTejun Heo extern struct workqueue_struct *system_freezable_wq; 333ae930e0fSTejun Heo 3343b07e9caSTejun Heo static inline struct workqueue_struct * __deprecated __system_nrt_wq(void) 335ae930e0fSTejun Heo { 336ae930e0fSTejun Heo return system_wq; 337ae930e0fSTejun Heo } 338ae930e0fSTejun Heo 3393b07e9caSTejun Heo static inline struct workqueue_struct * __deprecated __system_nrt_freezable_wq(void) 340ae930e0fSTejun Heo { 341ae930e0fSTejun Heo return system_freezable_wq; 342ae930e0fSTejun Heo } 343ae930e0fSTejun Heo 344ae930e0fSTejun Heo /* equivlalent to system_wq and system_freezable_wq, deprecated */ 345ae930e0fSTejun Heo #define system_nrt_wq __system_nrt_wq() 346ae930e0fSTejun Heo #define system_nrt_freezable_wq __system_nrt_freezable_wq() 3471da177e4SLinus Torvalds 3484e6045f1SJohannes Berg extern struct workqueue_struct * 349b196be89STejun Heo __alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active, 350b196be89STejun Heo struct lock_class_key *key, const char *lock_name, ...) __printf(1, 6); 3514e6045f1SJohannes Berg 352b196be89STejun Heo /** 353b196be89STejun Heo * alloc_workqueue - allocate a workqueue 354b196be89STejun Heo * @fmt: printf format for the name of the workqueue 355b196be89STejun Heo * @flags: WQ_* flags 356b196be89STejun Heo * @max_active: max in-flight work items, 0 for default 357b196be89STejun Heo * @args: args for @fmt 358b196be89STejun Heo * 359b196be89STejun Heo * Allocate a workqueue with the specified parameters. For detailed 360b196be89STejun Heo * information on WQ_* flags, please refer to Documentation/workqueue.txt. 361b196be89STejun Heo * 362b196be89STejun Heo * The __lock_name macro dance is to guarantee that single lock_class_key 363b196be89STejun Heo * doesn't end up with different namesm, which isn't allowed by lockdep. 364b196be89STejun Heo * 365b196be89STejun Heo * RETURNS: 366b196be89STejun Heo * Pointer to the allocated workqueue on success, %NULL on failure. 367b196be89STejun Heo */ 3684e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 369b196be89STejun Heo #define alloc_workqueue(fmt, flags, max_active, args...) \ 3704e6045f1SJohannes Berg ({ \ 3714e6045f1SJohannes Berg static struct lock_class_key __key; \ 372eb13ba87SJohannes Berg const char *__lock_name; \ 373eb13ba87SJohannes Berg \ 374b196be89STejun Heo if (__builtin_constant_p(fmt)) \ 375b196be89STejun Heo __lock_name = (fmt); \ 376eb13ba87SJohannes Berg else \ 377b196be89STejun Heo __lock_name = #fmt; \ 3784e6045f1SJohannes Berg \ 379b196be89STejun Heo __alloc_workqueue_key((fmt), (flags), (max_active), \ 380b196be89STejun Heo &__key, __lock_name, ##args); \ 3814e6045f1SJohannes Berg }) 3824e6045f1SJohannes Berg #else 383b196be89STejun Heo #define alloc_workqueue(fmt, flags, max_active, args...) \ 384b196be89STejun Heo __alloc_workqueue_key((fmt), (flags), (max_active), \ 385b196be89STejun Heo NULL, NULL, ##args) 3864e6045f1SJohannes Berg #endif 3874e6045f1SJohannes Berg 38881dcaf65STejun Heo /** 38981dcaf65STejun Heo * alloc_ordered_workqueue - allocate an ordered workqueue 390b196be89STejun Heo * @fmt: printf format for the name of the workqueue 39158a69cb4STejun Heo * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful) 392b196be89STejun Heo * @args: args for @fmt 39381dcaf65STejun Heo * 39481dcaf65STejun Heo * Allocate an ordered workqueue. An ordered workqueue executes at 39581dcaf65STejun Heo * most one work item at any given time in the queued order. They are 39681dcaf65STejun Heo * implemented as unbound workqueues with @max_active of one. 39781dcaf65STejun Heo * 39881dcaf65STejun Heo * RETURNS: 39981dcaf65STejun Heo * Pointer to the allocated workqueue on success, %NULL on failure. 40081dcaf65STejun Heo */ 401b196be89STejun Heo #define alloc_ordered_workqueue(fmt, flags, args...) \ 4028719dceaSTejun Heo alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | (flags), 1, ##args) 40381dcaf65STejun Heo 40497e37d7bSTejun Heo #define create_workqueue(name) \ 4056370a6adSTejun Heo alloc_workqueue((name), WQ_MEM_RECLAIM, 1) 40658a69cb4STejun Heo #define create_freezable_workqueue(name) \ 40758a69cb4STejun Heo alloc_workqueue((name), WQ_FREEZABLE | WQ_UNBOUND | WQ_MEM_RECLAIM, 1) 40897e37d7bSTejun Heo #define create_singlethread_workqueue(name) \ 4096370a6adSTejun Heo alloc_workqueue((name), WQ_UNBOUND | WQ_MEM_RECLAIM, 1) 4101da177e4SLinus Torvalds 4111da177e4SLinus Torvalds extern void destroy_workqueue(struct workqueue_struct *wq); 4121da177e4SLinus Torvalds 4137a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask); 4147a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs); 4159e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq, 4169e8cd2f5STejun Heo const struct workqueue_attrs *attrs); 4177a4e344cSTejun Heo 418d4283e93STejun Heo extern bool queue_work_on(int cpu, struct workqueue_struct *wq, 419c1a220e7SZhang Rui struct work_struct *work); 420d4283e93STejun Heo extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 42152bad64dSDavid Howells struct delayed_work *work, unsigned long delay); 4228376fe22STejun Heo extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 4238376fe22STejun Heo struct delayed_work *dwork, unsigned long delay); 42428e53bddSOleg Nesterov 425b3c97528SHarvey Harrison extern void flush_workqueue(struct workqueue_struct *wq); 4269c5a2ba7STejun Heo extern void drain_workqueue(struct workqueue_struct *wq); 42728e53bddSOleg Nesterov extern void flush_scheduled_work(void); 4281da177e4SLinus Torvalds 42965f27f38SDavid Howells extern int schedule_on_each_cpu(work_func_t func); 4301da177e4SLinus Torvalds 43165f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *); 4321da177e4SLinus Torvalds 433401a8d04STejun Heo extern bool flush_work(struct work_struct *work); 434401a8d04STejun Heo extern bool cancel_work_sync(struct work_struct *work); 435401a8d04STejun Heo 436401a8d04STejun Heo extern bool flush_delayed_work(struct delayed_work *dwork); 43757b30ae7STejun Heo extern bool cancel_delayed_work(struct delayed_work *dwork); 438401a8d04STejun Heo extern bool cancel_delayed_work_sync(struct delayed_work *dwork); 43928e53bddSOleg Nesterov 440dcd989cbSTejun Heo extern void workqueue_set_max_active(struct workqueue_struct *wq, 441dcd989cbSTejun Heo int max_active); 442e6267616STejun Heo extern bool current_is_workqueue_rescuer(void); 443d84ff051STejun Heo extern bool workqueue_congested(int cpu, struct workqueue_struct *wq); 444dcd989cbSTejun Heo extern unsigned int work_busy(struct work_struct *work); 445dcd989cbSTejun Heo 4468425e3d5STejun Heo /** 4478425e3d5STejun Heo * queue_work - queue work on a workqueue 4488425e3d5STejun Heo * @wq: workqueue to use 4498425e3d5STejun Heo * @work: work to queue 4508425e3d5STejun Heo * 4518425e3d5STejun Heo * Returns %false if @work was already on a queue, %true otherwise. 4528425e3d5STejun Heo * 4538425e3d5STejun Heo * We queue the work to the CPU on which it was submitted, but if the CPU dies 4548425e3d5STejun Heo * it can be processed by another CPU. 4558425e3d5STejun Heo */ 4568425e3d5STejun Heo static inline bool queue_work(struct workqueue_struct *wq, 4578425e3d5STejun Heo struct work_struct *work) 4588425e3d5STejun Heo { 4598425e3d5STejun Heo return queue_work_on(WORK_CPU_UNBOUND, wq, work); 4608425e3d5STejun Heo } 4618425e3d5STejun Heo 4628425e3d5STejun Heo /** 4638425e3d5STejun Heo * queue_delayed_work - queue work on a workqueue after delay 4648425e3d5STejun Heo * @wq: workqueue to use 4658425e3d5STejun Heo * @dwork: delayable work to queue 4668425e3d5STejun Heo * @delay: number of jiffies to wait before queueing 4678425e3d5STejun Heo * 4688425e3d5STejun Heo * Equivalent to queue_delayed_work_on() but tries to use the local CPU. 4698425e3d5STejun Heo */ 4708425e3d5STejun Heo static inline bool queue_delayed_work(struct workqueue_struct *wq, 4718425e3d5STejun Heo struct delayed_work *dwork, 4728425e3d5STejun Heo unsigned long delay) 4738425e3d5STejun Heo { 4748425e3d5STejun Heo return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); 4758425e3d5STejun Heo } 4768425e3d5STejun Heo 4778425e3d5STejun Heo /** 4788425e3d5STejun Heo * mod_delayed_work - modify delay of or queue a delayed work 4798425e3d5STejun Heo * @wq: workqueue to use 4808425e3d5STejun Heo * @dwork: work to queue 4818425e3d5STejun Heo * @delay: number of jiffies to wait before queueing 4828425e3d5STejun Heo * 4838425e3d5STejun Heo * mod_delayed_work_on() on local CPU. 4848425e3d5STejun Heo */ 4858425e3d5STejun Heo static inline bool mod_delayed_work(struct workqueue_struct *wq, 4868425e3d5STejun Heo struct delayed_work *dwork, 4878425e3d5STejun Heo unsigned long delay) 4888425e3d5STejun Heo { 4898425e3d5STejun Heo return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); 4908425e3d5STejun Heo } 4918425e3d5STejun Heo 4928425e3d5STejun Heo /** 4938425e3d5STejun Heo * schedule_work_on - put work task on a specific cpu 4948425e3d5STejun Heo * @cpu: cpu to put the work task on 4958425e3d5STejun Heo * @work: job to be done 4968425e3d5STejun Heo * 4978425e3d5STejun Heo * This puts a job on a specific cpu 4988425e3d5STejun Heo */ 4998425e3d5STejun Heo static inline bool schedule_work_on(int cpu, struct work_struct *work) 5008425e3d5STejun Heo { 5018425e3d5STejun Heo return queue_work_on(cpu, system_wq, work); 5028425e3d5STejun Heo } 5038425e3d5STejun Heo 5048425e3d5STejun Heo /** 5058425e3d5STejun Heo * schedule_work - put work task in global workqueue 5068425e3d5STejun Heo * @work: job to be done 5078425e3d5STejun Heo * 5088425e3d5STejun Heo * Returns %false if @work was already on the kernel-global workqueue and 5098425e3d5STejun Heo * %true otherwise. 5108425e3d5STejun Heo * 5118425e3d5STejun Heo * This puts a job in the kernel-global workqueue if it was not already 5128425e3d5STejun Heo * queued and leaves it in the same position on the kernel-global 5138425e3d5STejun Heo * workqueue otherwise. 5148425e3d5STejun Heo */ 5158425e3d5STejun Heo static inline bool schedule_work(struct work_struct *work) 5168425e3d5STejun Heo { 5178425e3d5STejun Heo return queue_work(system_wq, work); 5188425e3d5STejun Heo } 5198425e3d5STejun Heo 5208425e3d5STejun Heo /** 5218425e3d5STejun Heo * schedule_delayed_work_on - queue work in global workqueue on CPU after delay 5228425e3d5STejun Heo * @cpu: cpu to use 5238425e3d5STejun Heo * @dwork: job to be done 5248425e3d5STejun Heo * @delay: number of jiffies to wait 5258425e3d5STejun Heo * 5268425e3d5STejun Heo * After waiting for a given time this puts a job in the kernel-global 5278425e3d5STejun Heo * workqueue on the specified CPU. 5288425e3d5STejun Heo */ 5298425e3d5STejun Heo static inline bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork, 5308425e3d5STejun Heo unsigned long delay) 5318425e3d5STejun Heo { 5328425e3d5STejun Heo return queue_delayed_work_on(cpu, system_wq, dwork, delay); 5338425e3d5STejun Heo } 5348425e3d5STejun Heo 5358425e3d5STejun Heo /** 5368425e3d5STejun Heo * schedule_delayed_work - put work task in global workqueue after delay 5378425e3d5STejun Heo * @dwork: job to be done 5388425e3d5STejun Heo * @delay: number of jiffies to wait or 0 for immediate execution 5398425e3d5STejun Heo * 5408425e3d5STejun Heo * After waiting for a given time this puts a job in the kernel-global 5418425e3d5STejun Heo * workqueue. 5428425e3d5STejun Heo */ 5438425e3d5STejun Heo static inline bool schedule_delayed_work(struct delayed_work *dwork, 5448425e3d5STejun Heo unsigned long delay) 5458425e3d5STejun Heo { 5468425e3d5STejun Heo return queue_delayed_work(system_wq, dwork, delay); 5478425e3d5STejun Heo } 5488425e3d5STejun Heo 5498425e3d5STejun Heo /** 5508425e3d5STejun Heo * keventd_up - is workqueue initialized yet? 5518425e3d5STejun Heo */ 5528425e3d5STejun Heo static inline bool keventd_up(void) 5538425e3d5STejun Heo { 5548425e3d5STejun Heo return system_wq != NULL; 5558425e3d5STejun Heo } 5568425e3d5STejun Heo 5571da177e4SLinus Torvalds /* 5584e49627bSOleg Nesterov * Like above, but uses del_timer() instead of del_timer_sync(). This means, 5594e49627bSOleg Nesterov * if it returns 0 the timer function may be running and the queueing is in 5604e49627bSOleg Nesterov * progress. 5614e49627bSOleg Nesterov */ 562136b5721STejun Heo static inline bool __deprecated __cancel_delayed_work(struct delayed_work *work) 5634e49627bSOleg Nesterov { 564401a8d04STejun Heo bool ret; 5654e49627bSOleg Nesterov 5664e49627bSOleg Nesterov ret = del_timer(&work->timer); 5674e49627bSOleg Nesterov if (ret) 5684e49627bSOleg Nesterov work_clear_pending(&work->work); 5694e49627bSOleg Nesterov return ret; 5704e49627bSOleg Nesterov } 5714e49627bSOleg Nesterov 572606a5020STejun Heo /* used to be different but now identical to flush_work(), deprecated */ 57343829731STejun Heo static inline bool __deprecated flush_work_sync(struct work_struct *work) 574606a5020STejun Heo { 575606a5020STejun Heo return flush_work(work); 576606a5020STejun Heo } 577606a5020STejun Heo 578606a5020STejun Heo /* used to be different but now identical to flush_delayed_work(), deprecated */ 57943829731STejun Heo static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork) 580606a5020STejun Heo { 581606a5020STejun Heo return flush_delayed_work(dwork); 582606a5020STejun Heo } 583606a5020STejun Heo 5842d3854a3SRusty Russell #ifndef CONFIG_SMP 585d84ff051STejun Heo static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg) 5862d3854a3SRusty Russell { 5872d3854a3SRusty Russell return fn(arg); 5882d3854a3SRusty Russell } 5892d3854a3SRusty Russell #else 590d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg); 5912d3854a3SRusty Russell #endif /* CONFIG_SMP */ 592a25909a4SPaul E. McKenney 593a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 594a0a1a5fdSTejun Heo extern void freeze_workqueues_begin(void); 595a0a1a5fdSTejun Heo extern bool freeze_workqueues_busy(void); 596a0a1a5fdSTejun Heo extern void thaw_workqueues(void); 597a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 598a0a1a5fdSTejun Heo 599226223abSTejun Heo #ifdef CONFIG_SYSFS 600226223abSTejun Heo int workqueue_sysfs_register(struct workqueue_struct *wq); 601226223abSTejun Heo #else /* CONFIG_SYSFS */ 602226223abSTejun Heo static inline int workqueue_sysfs_register(struct workqueue_struct *wq) 603226223abSTejun Heo { return 0; } 604226223abSTejun Heo #endif /* CONFIG_SYSFS */ 605226223abSTejun Heo 6061da177e4SLinus Torvalds #endif 607