Greg Kroah-Hartman | b244131 | 2017-11-01 15:07:57 +0100 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2 | /* |
| 3 | * workqueue.h --- work queue handling for Linux. |
| 4 | */ |
| 5 | |
| 6 | #ifndef _LINUX_WORKQUEUE_H |
| 7 | #define _LINUX_WORKQUEUE_H |
| 8 | |
| 9 | #include <linux/timer.h> |
| 10 | #include <linux/linkage.h> |
| 11 | #include <linux/bitops.h> |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 12 | #include <linux/lockdep.h> |
Tejun Heo | 7a22ad7 | 2010-06-29 10:07:13 +0200 | [diff] [blame] | 13 | #include <linux/threads.h> |
Arun Sharma | 60063497 | 2011-07-26 16:09:06 -0700 | [diff] [blame] | 14 | #include <linux/atomic.h> |
Tejun Heo | 7a4e344 | 2013-03-12 11:30:00 -0700 | [diff] [blame] | 15 | #include <linux/cpumask.h> |
Tejun Heo | 05f0fe6 | 2018-03-14 12:45:13 -0700 | [diff] [blame] | 16 | #include <linux/rcupdate.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 17 | |
| 18 | struct workqueue_struct; |
| 19 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 20 | struct work_struct; |
| 21 | typedef void (*work_func_t)(struct work_struct *work); |
Kees Cook | 8c20feb | 2017-10-04 16:27:07 -0700 | [diff] [blame] | 22 | void delayed_work_timer_fn(struct timer_list *t); |
David Howells | 6bb49e5 | 2006-11-22 14:54:45 +0000 | [diff] [blame] | 23 | |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 24 | /* |
| 25 | * The first word is the work queue pointer and the flags rolled into |
| 26 | * one |
| 27 | */ |
| 28 | #define work_data_bits(work) ((unsigned long *)(&(work)->data)) |
| 29 | |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 30 | enum { |
| 31 | WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */ |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 32 | WORK_STRUCT_DELAYED_BIT = 1, /* work item is delayed */ |
Tejun Heo | 112202d | 2013-02-13 19:29:12 -0800 | [diff] [blame] | 33 | WORK_STRUCT_PWQ_BIT = 2, /* data points to pwq */ |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 34 | WORK_STRUCT_LINKED_BIT = 3, /* next work is linked to this one */ |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 35 | #ifdef CONFIG_DEBUG_OBJECTS_WORK |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 36 | WORK_STRUCT_STATIC_BIT = 4, /* static initializer (debugobjects) */ |
| 37 | WORK_STRUCT_COLOR_SHIFT = 5, /* color for workqueue flushing */ |
Tejun Heo | 0f90004 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 38 | #else |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 39 | WORK_STRUCT_COLOR_SHIFT = 4, /* color for workqueue flushing */ |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 40 | #endif |
| 41 | |
Tejun Heo | 73f53c4 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 42 | WORK_STRUCT_COLOR_BITS = 4, |
| 43 | |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 44 | WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT, |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 45 | WORK_STRUCT_DELAYED = 1 << WORK_STRUCT_DELAYED_BIT, |
Tejun Heo | 112202d | 2013-02-13 19:29:12 -0800 | [diff] [blame] | 46 | WORK_STRUCT_PWQ = 1 << WORK_STRUCT_PWQ_BIT, |
Tejun Heo | affee4b | 2010-06-29 10:07:12 +0200 | [diff] [blame] | 47 | WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT, |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 48 | #ifdef CONFIG_DEBUG_OBJECTS_WORK |
| 49 | WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT, |
| 50 | #else |
| 51 | WORK_STRUCT_STATIC = 0, |
| 52 | #endif |
| 53 | |
Tejun Heo | 73f53c4 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 54 | /* |
| 55 | * The last color is no color used for works which don't |
| 56 | * participate in workqueue flushing. |
| 57 | */ |
| 58 | WORK_NR_COLORS = (1 << WORK_STRUCT_COLOR_BITS) - 1, |
| 59 | WORK_NO_COLOR = WORK_NR_COLORS, |
| 60 | |
Lai Jiangshan | 79bc251 | 2014-05-22 16:43:44 +0800 | [diff] [blame] | 61 | /* not bound to any CPU, prefer the local CPU */ |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 62 | WORK_CPU_UNBOUND = NR_CPUS, |
Tejun Heo | bdbc5dd | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 63 | |
Tejun Heo | 73f53c4 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 64 | /* |
Tejun Heo | 112202d | 2013-02-13 19:29:12 -0800 | [diff] [blame] | 65 | * Reserve 7 bits off of pwq pointer w/ debugobjects turned off. |
| 66 | * This makes pwqs aligned to 256 bytes and allows 15 workqueue |
| 67 | * flush colors. |
Tejun Heo | 73f53c4 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 68 | */ |
| 69 | WORK_STRUCT_FLAG_BITS = WORK_STRUCT_COLOR_SHIFT + |
| 70 | WORK_STRUCT_COLOR_BITS, |
| 71 | |
Tejun Heo | 112202d | 2013-02-13 19:29:12 -0800 | [diff] [blame] | 72 | /* data contains off-queue information when !WORK_STRUCT_PWQ */ |
Lai Jiangshan | 45d9550 | 2013-02-19 12:17:01 -0800 | [diff] [blame] | 73 | WORK_OFFQ_FLAG_BASE = WORK_STRUCT_COLOR_SHIFT, |
Tejun Heo | bbb68df | 2012-08-03 10:30:46 -0700 | [diff] [blame] | 74 | |
Tejun Heo | 8603e1b3 | 2015-03-05 08:04:13 -0500 | [diff] [blame] | 75 | __WORK_OFFQ_CANCELING = WORK_OFFQ_FLAG_BASE, |
| 76 | WORK_OFFQ_CANCELING = (1 << __WORK_OFFQ_CANCELING), |
Tejun Heo | bbb68df | 2012-08-03 10:30:46 -0700 | [diff] [blame] | 77 | |
Tejun Heo | 715b06b | 2013-01-24 11:01:33 -0800 | [diff] [blame] | 78 | /* |
| 79 | * When a work item is off queue, its high bits point to the last |
Tejun Heo | 7c3eed5 | 2013-01-24 11:01:33 -0800 | [diff] [blame] | 80 | * pool it was on. Cap at 31 bits and use the highest number to |
| 81 | * indicate that no pool is associated. |
Tejun Heo | 715b06b | 2013-01-24 11:01:33 -0800 | [diff] [blame] | 82 | */ |
Tejun Heo | bbb68df | 2012-08-03 10:30:46 -0700 | [diff] [blame] | 83 | WORK_OFFQ_FLAG_BITS = 1, |
Tejun Heo | 7c3eed5 | 2013-01-24 11:01:33 -0800 | [diff] [blame] | 84 | WORK_OFFQ_POOL_SHIFT = WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS, |
| 85 | WORK_OFFQ_LEFT = BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT, |
| 86 | WORK_OFFQ_POOL_BITS = WORK_OFFQ_LEFT <= 31 ? WORK_OFFQ_LEFT : 31, |
| 87 | WORK_OFFQ_POOL_NONE = (1LU << WORK_OFFQ_POOL_BITS) - 1, |
Tejun Heo | b549007 | 2012-08-03 10:30:46 -0700 | [diff] [blame] | 88 | |
| 89 | /* convenience constants */ |
Tejun Heo | 0f90004 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 90 | WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1, |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 91 | WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK, |
Tejun Heo | 7c3eed5 | 2013-01-24 11:01:33 -0800 | [diff] [blame] | 92 | WORK_STRUCT_NO_POOL = (unsigned long)WORK_OFFQ_POOL_NONE << WORK_OFFQ_POOL_SHIFT, |
Tejun Heo | dcd989c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 93 | |
| 94 | /* bit mask for work_busy() return values */ |
| 95 | WORK_BUSY_PENDING = 1 << 0, |
| 96 | WORK_BUSY_RUNNING = 1 << 1, |
Tejun Heo | 3d1cb20 | 2013-04-30 15:27:22 -0700 | [diff] [blame] | 97 | |
| 98 | /* maximum string length for set_worker_desc() */ |
| 99 | WORKER_DESC_LEN = 24, |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 100 | }; |
| 101 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | struct work_struct { |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 103 | atomic_long_t data; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 104 | struct list_head entry; |
David Howells | 6bb49e5 | 2006-11-22 14:54:45 +0000 | [diff] [blame] | 105 | work_func_t func; |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 106 | #ifdef CONFIG_LOCKDEP |
| 107 | struct lockdep_map lockdep_map; |
| 108 | #endif |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 109 | }; |
| 110 | |
Arnd Bergmann | a45463c | 2017-02-01 18:01:17 +0100 | [diff] [blame] | 111 | #define WORK_DATA_INIT() ATOMIC_LONG_INIT((unsigned long)WORK_STRUCT_NO_POOL) |
Tejun Heo | 7a22ad7 | 2010-06-29 10:07:13 +0200 | [diff] [blame] | 112 | #define WORK_DATA_STATIC_INIT() \ |
Arnd Bergmann | a45463c | 2017-02-01 18:01:17 +0100 | [diff] [blame] | 113 | ATOMIC_LONG_INIT((unsigned long)(WORK_STRUCT_NO_POOL | WORK_STRUCT_STATIC)) |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 114 | |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 115 | struct delayed_work { |
| 116 | struct work_struct work; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 117 | struct timer_list timer; |
Lai Jiangshan | 60c057b | 2013-02-06 18:04:53 -0800 | [diff] [blame] | 118 | |
| 119 | /* target workqueue and CPU ->timer uses to queue ->work */ |
| 120 | struct workqueue_struct *wq; |
Tejun Heo | 1265057 | 2012-08-08 09:38:42 -0700 | [diff] [blame] | 121 | int cpu; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | }; |
| 123 | |
Tejun Heo | 05f0fe6 | 2018-03-14 12:45:13 -0700 | [diff] [blame] | 124 | struct rcu_work { |
| 125 | struct work_struct work; |
| 126 | struct rcu_head rcu; |
| 127 | |
| 128 | /* target workqueue ->rcu uses to queue ->work */ |
| 129 | struct workqueue_struct *wq; |
| 130 | }; |
| 131 | |
Silvio Fricke | 42412c3 | 2016-10-28 10:14:09 +0200 | [diff] [blame] | 132 | /** |
| 133 | * struct workqueue_attrs - A struct for workqueue attributes. |
Tejun Heo | d55262c | 2013-04-01 11:23:38 -0700 | [diff] [blame] | 134 | * |
Silvio Fricke | 42412c3 | 2016-10-28 10:14:09 +0200 | [diff] [blame] | 135 | * This can be used to change attributes of an unbound workqueue. |
Tejun Heo | 7a4e344 | 2013-03-12 11:30:00 -0700 | [diff] [blame] | 136 | */ |
| 137 | struct workqueue_attrs { |
Silvio Fricke | 42412c3 | 2016-10-28 10:14:09 +0200 | [diff] [blame] | 138 | /** |
| 139 | * @nice: nice level |
| 140 | */ |
| 141 | int nice; |
| 142 | |
| 143 | /** |
| 144 | * @cpumask: allowed CPUs |
| 145 | */ |
| 146 | cpumask_var_t cpumask; |
| 147 | |
| 148 | /** |
| 149 | * @no_numa: disable NUMA affinity |
| 150 | * |
| 151 | * Unlike other fields, ``no_numa`` isn't a property of a worker_pool. It |
| 152 | * only modifies how :c:func:`apply_workqueue_attrs` select pools and thus |
| 153 | * doesn't participate in pool hash calculations or equality comparisons. |
| 154 | */ |
| 155 | bool no_numa; |
Tejun Heo | 7a4e344 | 2013-03-12 11:30:00 -0700 | [diff] [blame] | 156 | }; |
| 157 | |
Jean Delvare | bf6aede | 2009-04-02 16:56:54 -0700 | [diff] [blame] | 158 | static inline struct delayed_work *to_delayed_work(struct work_struct *work) |
| 159 | { |
| 160 | return container_of(work, struct delayed_work, work); |
| 161 | } |
| 162 | |
Tejun Heo | 05f0fe6 | 2018-03-14 12:45:13 -0700 | [diff] [blame] | 163 | static inline struct rcu_work *to_rcu_work(struct work_struct *work) |
| 164 | { |
| 165 | return container_of(work, struct rcu_work, work); |
| 166 | } |
| 167 | |
James Bottomley | 1fa44ec | 2006-02-23 12:43:43 -0600 | [diff] [blame] | 168 | struct execute_work { |
| 169 | struct work_struct work; |
| 170 | }; |
| 171 | |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 172 | #ifdef CONFIG_LOCKDEP |
| 173 | /* |
| 174 | * NB: because we have to copy the lockdep_map, setting _key |
| 175 | * here is required, otherwise it could get initialised to the |
| 176 | * copy of the lockdep_map! |
| 177 | */ |
| 178 | #define __WORK_INIT_LOCKDEP_MAP(n, k) \ |
| 179 | .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k), |
| 180 | #else |
| 181 | #define __WORK_INIT_LOCKDEP_MAP(n, k) |
| 182 | #endif |
| 183 | |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 184 | #define __WORK_INITIALIZER(n, f) { \ |
| 185 | .data = WORK_DATA_STATIC_INIT(), \ |
| 186 | .entry = { &(n).entry, &(n).entry }, \ |
| 187 | .func = (f), \ |
| 188 | __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 189 | } |
| 190 | |
Tejun Heo | f991b31 | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 191 | #define __DELAYED_WORK_INITIALIZER(n, f, tflags) { \ |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 192 | .work = __WORK_INITIALIZER((n).work, (f)), \ |
Kees Cook | 841b86f | 2017-10-23 09:40:42 +0200 | [diff] [blame] | 193 | .timer = __TIMER_INITIALIZER(delayed_work_timer_fn,\ |
Tejun Heo | e0aecdd | 2012-08-21 13:18:24 -0700 | [diff] [blame] | 194 | (tflags) | TIMER_IRQSAFE), \ |
Phil Carmody | dd6414b | 2010-10-20 15:57:33 -0700 | [diff] [blame] | 195 | } |
| 196 | |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 197 | #define DECLARE_WORK(n, f) \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 198 | struct work_struct n = __WORK_INITIALIZER(n, f) |
| 199 | |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 200 | #define DECLARE_DELAYED_WORK(n, f) \ |
Tejun Heo | f991b31 | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 201 | struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0) |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 202 | |
Tejun Heo | 203b42f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 203 | #define DECLARE_DEFERRABLE_WORK(n, f) \ |
Tejun Heo | f991b31 | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 204 | struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE) |
Phil Carmody | dd6414b | 2010-10-20 15:57:33 -0700 | [diff] [blame] | 205 | |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 206 | #ifdef CONFIG_DEBUG_OBJECTS_WORK |
| 207 | extern void __init_work(struct work_struct *work, int onstack); |
| 208 | extern void destroy_work_on_stack(struct work_struct *work); |
Thomas Gleixner | ea2e64f | 2014-03-23 14:20:44 +0000 | [diff] [blame] | 209 | extern void destroy_delayed_work_on_stack(struct delayed_work *work); |
Tejun Heo | 4690c4a | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 210 | static inline unsigned int work_static(struct work_struct *work) |
| 211 | { |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 212 | return *work_data_bits(work) & WORK_STRUCT_STATIC; |
Tejun Heo | 4690c4a | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 213 | } |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 214 | #else |
| 215 | static inline void __init_work(struct work_struct *work, int onstack) { } |
| 216 | static inline void destroy_work_on_stack(struct work_struct *work) { } |
Thomas Gleixner | ea2e64f | 2014-03-23 14:20:44 +0000 | [diff] [blame] | 217 | static inline void destroy_delayed_work_on_stack(struct delayed_work *work) { } |
Tejun Heo | 4690c4a | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 218 | static inline unsigned int work_static(struct work_struct *work) { return 0; } |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 219 | #endif |
| 220 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 221 | /* |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 222 | * initialize all of a work item in one go |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 223 | * |
Dmitri Vorobiev | b9049df | 2009-06-23 12:09:29 +0200 | [diff] [blame] | 224 | * NOTE! No point in using "atomic_long_set()": using a direct |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 225 | * assignment of the work data initializer allows the compiler |
| 226 | * to generate better code. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 227 | */ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 228 | #ifdef CONFIG_LOCKDEP |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 229 | #define __INIT_WORK(_work, _func, _onstack) \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 230 | do { \ |
| 231 | static struct lock_class_key __key; \ |
| 232 | \ |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 233 | __init_work((_work), _onstack); \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 234 | (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \ |
Byungchul Park | fd1a5b0 | 2017-10-25 17:56:04 +0900 | [diff] [blame] | 235 | lockdep_init_map(&(_work)->lockdep_map, "(work_completion)"#_work, &__key, 0); \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 236 | INIT_LIST_HEAD(&(_work)->entry); \ |
Tejun Heo | f073f92 | 2014-03-07 10:24:50 -0500 | [diff] [blame] | 237 | (_work)->func = (_func); \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 238 | } while (0) |
| 239 | #else |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 240 | #define __INIT_WORK(_work, _func, _onstack) \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 241 | do { \ |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 242 | __init_work((_work), _onstack); \ |
Oleg Nesterov | 23b2e59 | 2007-05-09 02:34:19 -0700 | [diff] [blame] | 243 | (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 244 | INIT_LIST_HEAD(&(_work)->entry); \ |
Tejun Heo | f073f92 | 2014-03-07 10:24:50 -0500 | [diff] [blame] | 245 | (_work)->func = (_func); \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 246 | } while (0) |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 247 | #endif |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 248 | |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 249 | #define INIT_WORK(_work, _func) \ |
Valentin Rothberg | 9da7dae | 2015-01-06 17:29:29 +0100 | [diff] [blame] | 250 | __INIT_WORK((_work), (_func), 0) |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 251 | |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 252 | #define INIT_WORK_ONSTACK(_work, _func) \ |
Valentin Rothberg | 9da7dae | 2015-01-06 17:29:29 +0100 | [diff] [blame] | 253 | __INIT_WORK((_work), (_func), 1) |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 254 | |
Tejun Heo | f991b31 | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 255 | #define __INIT_DELAYED_WORK(_work, _func, _tflags) \ |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 256 | do { \ |
| 257 | INIT_WORK(&(_work)->work, (_func)); \ |
Kees Cook | 919b250 | 2017-10-22 18:48:43 -0700 | [diff] [blame] | 258 | __init_timer(&(_work)->timer, \ |
| 259 | delayed_work_timer_fn, \ |
| 260 | (_tflags) | TIMER_IRQSAFE); \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 261 | } while (0) |
| 262 | |
Tejun Heo | f991b31 | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 263 | #define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags) \ |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 264 | do { \ |
| 265 | INIT_WORK_ONSTACK(&(_work)->work, (_func)); \ |
Kees Cook | 919b250 | 2017-10-22 18:48:43 -0700 | [diff] [blame] | 266 | __init_timer_on_stack(&(_work)->timer, \ |
| 267 | delayed_work_timer_fn, \ |
| 268 | (_tflags) | TIMER_IRQSAFE); \ |
Peter Zijlstra | 6d612b0 | 2009-01-12 12:52:23 +0100 | [diff] [blame] | 269 | } while (0) |
| 270 | |
Tejun Heo | f991b31 | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 271 | #define INIT_DELAYED_WORK(_work, _func) \ |
| 272 | __INIT_DELAYED_WORK(_work, _func, 0) |
| 273 | |
| 274 | #define INIT_DELAYED_WORK_ONSTACK(_work, _func) \ |
| 275 | __INIT_DELAYED_WORK_ONSTACK(_work, _func, 0) |
| 276 | |
Tejun Heo | 203b42f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 277 | #define INIT_DEFERRABLE_WORK(_work, _func) \ |
Tejun Heo | f991b31 | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 278 | __INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE) |
| 279 | |
| 280 | #define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func) \ |
| 281 | __INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE) |
Venki Pallipadi | 2828703 | 2007-05-08 00:27:47 -0700 | [diff] [blame] | 282 | |
Tejun Heo | 05f0fe6 | 2018-03-14 12:45:13 -0700 | [diff] [blame] | 283 | #define INIT_RCU_WORK(_work, _func) \ |
| 284 | INIT_WORK(&(_work)->work, (_func)) |
| 285 | |
| 286 | #define INIT_RCU_WORK_ONSTACK(_work, _func) \ |
| 287 | INIT_WORK_ONSTACK(&(_work)->work, (_func)) |
| 288 | |
David Howells | 365970a | 2006-11-22 14:54:49 +0000 | [diff] [blame] | 289 | /** |
| 290 | * work_pending - Find out whether a work item is currently pending |
| 291 | * @work: The work item in question |
| 292 | */ |
| 293 | #define work_pending(work) \ |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 294 | test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) |
David Howells | 365970a | 2006-11-22 14:54:49 +0000 | [diff] [blame] | 295 | |
| 296 | /** |
| 297 | * delayed_work_pending - Find out whether a delayable work item is currently |
| 298 | * pending |
Jonathan Corbet | 355c0663 | 2015-08-13 17:52:02 -0600 | [diff] [blame] | 299 | * @w: The work item in question |
David Howells | 365970a | 2006-11-22 14:54:49 +0000 | [diff] [blame] | 300 | */ |
Linus Torvalds | 0221872 | 2006-12-15 14:13:51 -0800 | [diff] [blame] | 301 | #define delayed_work_pending(w) \ |
| 302 | work_pending(&(w)->work) |
David Howells | 365970a | 2006-11-22 14:54:49 +0000 | [diff] [blame] | 303 | |
Tejun Heo | c54fce6 | 2010-09-10 16:51:36 +0200 | [diff] [blame] | 304 | /* |
| 305 | * Workqueue flags and constants. For details, please refer to |
Silvio Fricke | 42412c3 | 2016-10-28 10:14:09 +0200 | [diff] [blame] | 306 | * Documentation/core-api/workqueue.rst. |
Tejun Heo | c54fce6 | 2010-09-10 16:51:36 +0200 | [diff] [blame] | 307 | */ |
Tejun Heo | 97e37d7 | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 308 | enum { |
Tejun Heo | c7fc77f | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 309 | WQ_UNBOUND = 1 << 1, /* not bound to any cpu */ |
Tejun Heo | 58a69cb | 2011-02-16 09:25:31 +0100 | [diff] [blame] | 310 | WQ_FREEZABLE = 1 << 2, /* freeze during suspend */ |
Tejun Heo | 6370a6a | 2010-10-11 15:12:27 +0200 | [diff] [blame] | 311 | WQ_MEM_RECLAIM = 1 << 3, /* may be used for memory reclaim */ |
Tejun Heo | 649027d | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 312 | WQ_HIGHPRI = 1 << 4, /* high priority */ |
Geert Uytterhoeven | 41f5009 | 2014-03-24 21:37:02 +0100 | [diff] [blame] | 313 | WQ_CPU_INTENSIVE = 1 << 5, /* cpu intensive workqueue */ |
Tejun Heo | 226223a | 2013-03-12 11:30:05 -0700 | [diff] [blame] | 314 | WQ_SYSFS = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */ |
Tejun Heo | b71ab8c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 315 | |
Viresh Kumar | cee22a1 | 2013-04-08 16:45:40 +0530 | [diff] [blame] | 316 | /* |
| 317 | * Per-cpu workqueues are generally preferred because they tend to |
| 318 | * show better performance thanks to cache locality. Per-cpu |
| 319 | * workqueues exclude the scheduler from choosing the CPU to |
| 320 | * execute the worker threads, which has an unfortunate side effect |
| 321 | * of increasing power consumption. |
| 322 | * |
| 323 | * The scheduler considers a CPU idle if it doesn't have any task |
| 324 | * to execute and tries to keep idle cores idle to conserve power; |
| 325 | * however, for example, a per-cpu work item scheduled from an |
| 326 | * interrupt handler on an idle CPU will force the scheduler to |
| 327 | * excute the work item on that CPU breaking the idleness, which in |
| 328 | * turn may lead to more scheduling choices which are sub-optimal |
| 329 | * in terms of power consumption. |
| 330 | * |
| 331 | * Workqueues marked with WQ_POWER_EFFICIENT are per-cpu by default |
| 332 | * but become unbound if workqueue.power_efficient kernel param is |
| 333 | * specified. Per-cpu workqueues which are identified to |
| 334 | * contribute significantly to power-consumption are identified and |
| 335 | * marked with this flag and enabling the power_efficient mode |
| 336 | * leads to noticeable power saving at the cost of small |
| 337 | * performance disadvantage. |
| 338 | * |
| 339 | * http://thread.gmane.org/gmane.linux.kernel/1480396 |
| 340 | */ |
| 341 | WQ_POWER_EFFICIENT = 1 << 7, |
| 342 | |
Tejun Heo | 618b01e | 2013-03-12 11:30:04 -0700 | [diff] [blame] | 343 | __WQ_DRAINING = 1 << 16, /* internal: workqueue is draining */ |
Tejun Heo | 8719dce | 2013-03-12 11:30:04 -0700 | [diff] [blame] | 344 | __WQ_ORDERED = 1 << 17, /* internal: workqueue is ordered */ |
Tejun Heo | 23d11a5 | 2016-01-29 05:59:46 -0500 | [diff] [blame] | 345 | __WQ_LEGACY = 1 << 18, /* internal: create*_workqueue() */ |
Ben Hutchings | fbf1c41 | 2017-09-03 01:18:41 +0100 | [diff] [blame] | 346 | __WQ_ORDERED_EXPLICIT = 1 << 19, /* internal: alloc_ordered_workqueue() */ |
Tejun Heo | e41e704 | 2010-08-24 14:22:47 +0200 | [diff] [blame] | 347 | |
Tejun Heo | b71ab8c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 348 | WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */ |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 349 | WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */ |
Tejun Heo | b71ab8c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 350 | WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2, |
Tejun Heo | 97e37d7 | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 351 | }; |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 352 | |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 353 | /* unbound wq's aren't per-cpu, scale max_active according to #cpus */ |
| 354 | #define WQ_UNBOUND_MAX_ACTIVE \ |
| 355 | max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU) |
| 356 | |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 357 | /* |
| 358 | * System-wide workqueues which are always present. |
| 359 | * |
| 360 | * system_wq is the one used by schedule[_delayed]_work[_on](). |
| 361 | * Multi-CPU multi-threaded. There are users which expect relatively |
| 362 | * short queue flush time. Don't queue works which can run for too |
| 363 | * long. |
| 364 | * |
Lai Jiangshan | 73e4354 | 2014-05-22 16:42:41 +0800 | [diff] [blame] | 365 | * system_highpri_wq is similar to system_wq but for work items which |
| 366 | * require WQ_HIGHPRI. |
| 367 | * |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 368 | * system_long_wq is similar to system_wq but may host long running |
| 369 | * works. Queue flushing might take relatively long. |
| 370 | * |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 371 | * system_unbound_wq is unbound workqueue. Workers are not bound to |
| 372 | * any specific CPU, not concurrency managed, and all queued works are |
| 373 | * executed immediately as long as max_active limit is not reached and |
| 374 | * resources are available. |
Tejun Heo | 4149efb | 2011-02-08 10:39:03 +0100 | [diff] [blame] | 375 | * |
Tejun Heo | 24d51ad | 2011-02-21 09:52:50 +0100 | [diff] [blame] | 376 | * system_freezable_wq is equivalent to system_wq except that it's |
| 377 | * freezable. |
Viresh Kumar | 0668106 | 2013-04-24 17:12:54 +0530 | [diff] [blame] | 378 | * |
| 379 | * *_power_efficient_wq are inclined towards saving power and converted |
| 380 | * into WQ_UNBOUND variants if 'wq_power_efficient' is enabled; otherwise, |
| 381 | * they are same as their non-power-efficient counterparts - e.g. |
| 382 | * system_power_efficient_wq is identical to system_wq if |
| 383 | * 'wq_power_efficient' is disabled. See WQ_POWER_EFFICIENT for more info. |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 384 | */ |
| 385 | extern struct workqueue_struct *system_wq; |
Lai Jiangshan | 73e4354 | 2014-05-22 16:42:41 +0800 | [diff] [blame] | 386 | extern struct workqueue_struct *system_highpri_wq; |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 387 | extern struct workqueue_struct *system_long_wq; |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 388 | extern struct workqueue_struct *system_unbound_wq; |
Tejun Heo | 24d51ad | 2011-02-21 09:52:50 +0100 | [diff] [blame] | 389 | extern struct workqueue_struct *system_freezable_wq; |
Viresh Kumar | 0668106 | 2013-04-24 17:12:54 +0530 | [diff] [blame] | 390 | extern struct workqueue_struct *system_power_efficient_wq; |
| 391 | extern struct workqueue_struct *system_freezable_power_efficient_wq; |
Tejun Heo | ae930e0 | 2012-08-20 14:51:23 -0700 | [diff] [blame] | 392 | |
Tejun Heo | b196be8 | 2012-01-10 15:11:35 -0800 | [diff] [blame] | 393 | /** |
| 394 | * alloc_workqueue - allocate a workqueue |
| 395 | * @fmt: printf format for the name of the workqueue |
| 396 | * @flags: WQ_* flags |
| 397 | * @max_active: max in-flight work items, 0 for default |
Bart Van Assche | 669de8b | 2019-02-14 15:00:54 -0800 | [diff] [blame] | 398 | * remaining args: args for @fmt |
Tejun Heo | b196be8 | 2012-01-10 15:11:35 -0800 | [diff] [blame] | 399 | * |
| 400 | * Allocate a workqueue with the specified parameters. For detailed |
Silvio Fricke | 42412c3 | 2016-10-28 10:14:09 +0200 | [diff] [blame] | 401 | * information on WQ_* flags, please refer to |
| 402 | * Documentation/core-api/workqueue.rst. |
Tejun Heo | b196be8 | 2012-01-10 15:11:35 -0800 | [diff] [blame] | 403 | * |
Tejun Heo | b196be8 | 2012-01-10 15:11:35 -0800 | [diff] [blame] | 404 | * RETURNS: |
| 405 | * Pointer to the allocated workqueue on success, %NULL on failure. |
| 406 | */ |
Bart Van Assche | 669de8b | 2019-02-14 15:00:54 -0800 | [diff] [blame] | 407 | struct workqueue_struct *alloc_workqueue(const char *fmt, |
| 408 | unsigned int flags, |
| 409 | int max_active, ...); |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 410 | |
Tejun Heo | 81dcaf6 | 2010-09-16 10:17:35 +0200 | [diff] [blame] | 411 | /** |
| 412 | * alloc_ordered_workqueue - allocate an ordered workqueue |
Tejun Heo | b196be8 | 2012-01-10 15:11:35 -0800 | [diff] [blame] | 413 | * @fmt: printf format for the name of the workqueue |
Tejun Heo | 58a69cb | 2011-02-16 09:25:31 +0100 | [diff] [blame] | 414 | * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful) |
Jonathan Corbet | 355c0663 | 2015-08-13 17:52:02 -0600 | [diff] [blame] | 415 | * @args...: args for @fmt |
Tejun Heo | 81dcaf6 | 2010-09-16 10:17:35 +0200 | [diff] [blame] | 416 | * |
| 417 | * Allocate an ordered workqueue. An ordered workqueue executes at |
| 418 | * most one work item at any given time in the queued order. They are |
| 419 | * implemented as unbound workqueues with @max_active of one. |
| 420 | * |
| 421 | * RETURNS: |
| 422 | * Pointer to the allocated workqueue on success, %NULL on failure. |
| 423 | */ |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 424 | #define alloc_ordered_workqueue(fmt, flags, args...) \ |
Tejun Heo | 0a94efb | 2017-07-23 08:36:15 -0400 | [diff] [blame] | 425 | alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | \ |
| 426 | __WQ_ORDERED_EXPLICIT | (flags), 1, ##args) |
Tejun Heo | 81dcaf6 | 2010-09-16 10:17:35 +0200 | [diff] [blame] | 427 | |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 428 | #define create_workqueue(name) \ |
Tejun Heo | 23d11a5 | 2016-01-29 05:59:46 -0500 | [diff] [blame] | 429 | alloc_workqueue("%s", __WQ_LEGACY | WQ_MEM_RECLAIM, 1, (name)) |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 430 | #define create_freezable_workqueue(name) \ |
Tejun Heo | 23d11a5 | 2016-01-29 05:59:46 -0500 | [diff] [blame] | 431 | alloc_workqueue("%s", __WQ_LEGACY | WQ_FREEZABLE | WQ_UNBOUND | \ |
| 432 | WQ_MEM_RECLAIM, 1, (name)) |
Tejun Heo | ee64e7f | 2012-08-21 13:18:23 -0700 | [diff] [blame] | 433 | #define create_singlethread_workqueue(name) \ |
Tejun Heo | 23d11a5 | 2016-01-29 05:59:46 -0500 | [diff] [blame] | 434 | alloc_ordered_workqueue("%s", __WQ_LEGACY | WQ_MEM_RECLAIM, name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 435 | |
| 436 | extern void destroy_workqueue(struct workqueue_struct *wq); |
| 437 | |
Daniel Jordan | 513c98d | 2019-09-05 21:40:22 -0400 | [diff] [blame] | 438 | struct workqueue_attrs *alloc_workqueue_attrs(void); |
| 439 | void free_workqueue_attrs(struct workqueue_attrs *attrs); |
| 440 | int apply_workqueue_attrs(struct workqueue_struct *wq, |
| 441 | const struct workqueue_attrs *attrs); |
Lai Jiangshan | 042f7df | 2015-04-30 17:16:12 +0800 | [diff] [blame] | 442 | int workqueue_set_unbound_cpumask(cpumask_var_t cpumask); |
Tejun Heo | 7a4e344 | 2013-03-12 11:30:00 -0700 | [diff] [blame] | 443 | |
Tejun Heo | d4283e9 | 2012-08-03 10:30:44 -0700 | [diff] [blame] | 444 | extern bool queue_work_on(int cpu, struct workqueue_struct *wq, |
Zhang Rui | c1a220e | 2008-07-23 21:28:39 -0700 | [diff] [blame] | 445 | struct work_struct *work); |
Alexander Duyck | 8204e0c | 2019-01-22 10:39:26 -0800 | [diff] [blame] | 446 | extern bool queue_work_node(int node, struct workqueue_struct *wq, |
| 447 | struct work_struct *work); |
Tejun Heo | d4283e9 | 2012-08-03 10:30:44 -0700 | [diff] [blame] | 448 | extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, |
Oleg Nesterov | 28e53bd | 2007-05-09 02:34:22 -0700 | [diff] [blame] | 449 | struct delayed_work *work, unsigned long delay); |
Tejun Heo | 8376fe2 | 2012-08-03 10:30:47 -0700 | [diff] [blame] | 450 | extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, |
| 451 | struct delayed_work *dwork, unsigned long delay); |
Tejun Heo | 05f0fe6 | 2018-03-14 12:45:13 -0700 | [diff] [blame] | 452 | extern bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork); |
Oleg Nesterov | 28e53bd | 2007-05-09 02:34:22 -0700 | [diff] [blame] | 453 | |
Harvey Harrison | b3c9752 | 2008-02-13 15:03:15 -0800 | [diff] [blame] | 454 | extern void flush_workqueue(struct workqueue_struct *wq); |
Tejun Heo | 9c5a2ba | 2011-04-05 18:01:44 +0200 | [diff] [blame] | 455 | extern void drain_workqueue(struct workqueue_struct *wq); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 456 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 457 | extern int schedule_on_each_cpu(work_func_t func); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 458 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 459 | int execute_in_process_context(work_func_t fn, struct execute_work *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 460 | |
Tejun Heo | 401a8d0 | 2010-09-16 10:36:00 +0200 | [diff] [blame] | 461 | extern bool flush_work(struct work_struct *work); |
| 462 | extern bool cancel_work_sync(struct work_struct *work); |
| 463 | |
| 464 | extern bool flush_delayed_work(struct delayed_work *dwork); |
Tejun Heo | 57b30ae | 2012-08-21 13:18:24 -0700 | [diff] [blame] | 465 | extern bool cancel_delayed_work(struct delayed_work *dwork); |
Tejun Heo | 401a8d0 | 2010-09-16 10:36:00 +0200 | [diff] [blame] | 466 | extern bool cancel_delayed_work_sync(struct delayed_work *dwork); |
Oleg Nesterov | 28e53bd | 2007-05-09 02:34:22 -0700 | [diff] [blame] | 467 | |
Tejun Heo | 05f0fe6 | 2018-03-14 12:45:13 -0700 | [diff] [blame] | 468 | extern bool flush_rcu_work(struct rcu_work *rwork); |
| 469 | |
Tejun Heo | dcd989c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 470 | extern void workqueue_set_max_active(struct workqueue_struct *wq, |
| 471 | int max_active); |
Lukas Wunner | 27d4ee0 | 2018-02-11 10:38:28 +0100 | [diff] [blame] | 472 | extern struct work_struct *current_work(void); |
Tejun Heo | e6267616 | 2013-03-12 17:41:37 -0700 | [diff] [blame] | 473 | extern bool current_is_workqueue_rescuer(void); |
Tejun Heo | d84ff05 | 2013-03-12 11:29:59 -0700 | [diff] [blame] | 474 | extern bool workqueue_congested(int cpu, struct workqueue_struct *wq); |
Tejun Heo | dcd989c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 475 | extern unsigned int work_busy(struct work_struct *work); |
Tejun Heo | 3d1cb20 | 2013-04-30 15:27:22 -0700 | [diff] [blame] | 476 | extern __printf(1, 2) void set_worker_desc(const char *fmt, ...); |
| 477 | extern void print_worker_info(const char *log_lvl, struct task_struct *task); |
Tejun Heo | 3494fc3 | 2015-03-09 09:22:28 -0400 | [diff] [blame] | 478 | extern void show_workqueue_state(void); |
Tejun Heo | 6b59808 | 2018-05-18 08:47:13 -0700 | [diff] [blame] | 479 | extern void wq_worker_comm(char *buf, size_t size, struct task_struct *task); |
Tejun Heo | dcd989c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 480 | |
Tejun Heo | 8425e3d5 | 2013-03-13 16:51:36 -0700 | [diff] [blame] | 481 | /** |
| 482 | * queue_work - queue work on a workqueue |
| 483 | * @wq: workqueue to use |
| 484 | * @work: work to queue |
| 485 | * |
| 486 | * Returns %false if @work was already on a queue, %true otherwise. |
| 487 | * |
| 488 | * We queue the work to the CPU on which it was submitted, but if the CPU dies |
| 489 | * it can be processed by another CPU. |
| 490 | */ |
| 491 | static inline bool queue_work(struct workqueue_struct *wq, |
| 492 | struct work_struct *work) |
| 493 | { |
| 494 | return queue_work_on(WORK_CPU_UNBOUND, wq, work); |
| 495 | } |
| 496 | |
| 497 | /** |
| 498 | * queue_delayed_work - queue work on a workqueue after delay |
| 499 | * @wq: workqueue to use |
| 500 | * @dwork: delayable work to queue |
| 501 | * @delay: number of jiffies to wait before queueing |
| 502 | * |
| 503 | * Equivalent to queue_delayed_work_on() but tries to use the local CPU. |
| 504 | */ |
| 505 | static inline bool queue_delayed_work(struct workqueue_struct *wq, |
| 506 | struct delayed_work *dwork, |
| 507 | unsigned long delay) |
| 508 | { |
| 509 | return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); |
| 510 | } |
| 511 | |
| 512 | /** |
| 513 | * mod_delayed_work - modify delay of or queue a delayed work |
| 514 | * @wq: workqueue to use |
| 515 | * @dwork: work to queue |
| 516 | * @delay: number of jiffies to wait before queueing |
| 517 | * |
| 518 | * mod_delayed_work_on() on local CPU. |
| 519 | */ |
| 520 | static inline bool mod_delayed_work(struct workqueue_struct *wq, |
| 521 | struct delayed_work *dwork, |
| 522 | unsigned long delay) |
| 523 | { |
| 524 | return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); |
| 525 | } |
| 526 | |
| 527 | /** |
| 528 | * schedule_work_on - put work task on a specific cpu |
| 529 | * @cpu: cpu to put the work task on |
| 530 | * @work: job to be done |
| 531 | * |
| 532 | * This puts a job on a specific cpu |
| 533 | */ |
| 534 | static inline bool schedule_work_on(int cpu, struct work_struct *work) |
| 535 | { |
| 536 | return queue_work_on(cpu, system_wq, work); |
| 537 | } |
| 538 | |
| 539 | /** |
| 540 | * schedule_work - put work task in global workqueue |
| 541 | * @work: job to be done |
| 542 | * |
| 543 | * Returns %false if @work was already on the kernel-global workqueue and |
| 544 | * %true otherwise. |
| 545 | * |
| 546 | * This puts a job in the kernel-global workqueue if it was not already |
| 547 | * queued and leaves it in the same position on the kernel-global |
| 548 | * workqueue otherwise. |
| 549 | */ |
| 550 | static inline bool schedule_work(struct work_struct *work) |
| 551 | { |
| 552 | return queue_work(system_wq, work); |
| 553 | } |
| 554 | |
| 555 | /** |
Lai Jiangshan | 37b1ef3 | 2015-05-20 14:41:19 +0800 | [diff] [blame] | 556 | * flush_scheduled_work - ensure that any scheduled work has run to completion. |
| 557 | * |
| 558 | * Forces execution of the kernel-global workqueue and blocks until its |
| 559 | * completion. |
| 560 | * |
| 561 | * Think twice before calling this function! It's very easy to get into |
| 562 | * trouble if you don't take great care. Either of the following situations |
| 563 | * will lead to deadlock: |
| 564 | * |
| 565 | * One of the work items currently on the workqueue needs to acquire |
| 566 | * a lock held by your code or its caller. |
| 567 | * |
| 568 | * Your code is running in the context of a work routine. |
| 569 | * |
| 570 | * They will be detected by lockdep when they occur, but the first might not |
| 571 | * occur very often. It depends on what work items are on the workqueue and |
| 572 | * what locks they need, which you have no control over. |
| 573 | * |
| 574 | * In most situations flushing the entire workqueue is overkill; you merely |
| 575 | * need to know that a particular work item isn't queued and isn't running. |
| 576 | * In such cases you should use cancel_delayed_work_sync() or |
| 577 | * cancel_work_sync() instead. |
| 578 | */ |
| 579 | static inline void flush_scheduled_work(void) |
| 580 | { |
| 581 | flush_workqueue(system_wq); |
| 582 | } |
| 583 | |
| 584 | /** |
Tejun Heo | 8425e3d5 | 2013-03-13 16:51:36 -0700 | [diff] [blame] | 585 | * schedule_delayed_work_on - queue work in global workqueue on CPU after delay |
| 586 | * @cpu: cpu to use |
| 587 | * @dwork: job to be done |
| 588 | * @delay: number of jiffies to wait |
| 589 | * |
| 590 | * After waiting for a given time this puts a job in the kernel-global |
| 591 | * workqueue on the specified CPU. |
| 592 | */ |
| 593 | static inline bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork, |
| 594 | unsigned long delay) |
| 595 | { |
| 596 | return queue_delayed_work_on(cpu, system_wq, dwork, delay); |
| 597 | } |
| 598 | |
| 599 | /** |
| 600 | * schedule_delayed_work - put work task in global workqueue after delay |
| 601 | * @dwork: job to be done |
| 602 | * @delay: number of jiffies to wait or 0 for immediate execution |
| 603 | * |
| 604 | * After waiting for a given time this puts a job in the kernel-global |
| 605 | * workqueue. |
| 606 | */ |
| 607 | static inline bool schedule_delayed_work(struct delayed_work *dwork, |
| 608 | unsigned long delay) |
| 609 | { |
| 610 | return queue_delayed_work(system_wq, dwork, delay); |
| 611 | } |
| 612 | |
Rusty Russell | 2d3854a | 2008-11-05 13:39:10 +1100 | [diff] [blame] | 613 | #ifndef CONFIG_SMP |
Tejun Heo | d84ff05 | 2013-03-12 11:29:59 -0700 | [diff] [blame] | 614 | static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg) |
Rusty Russell | 2d3854a | 2008-11-05 13:39:10 +1100 | [diff] [blame] | 615 | { |
| 616 | return fn(arg); |
| 617 | } |
Thomas Gleixner | 0e8d6a9 | 2017-04-12 22:07:28 +0200 | [diff] [blame] | 618 | static inline long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg) |
| 619 | { |
| 620 | return fn(arg); |
| 621 | } |
Rusty Russell | 2d3854a | 2008-11-05 13:39:10 +1100 | [diff] [blame] | 622 | #else |
Tejun Heo | d84ff05 | 2013-03-12 11:29:59 -0700 | [diff] [blame] | 623 | long work_on_cpu(int cpu, long (*fn)(void *), void *arg); |
Thomas Gleixner | 0e8d6a9 | 2017-04-12 22:07:28 +0200 | [diff] [blame] | 624 | long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg); |
Rusty Russell | 2d3854a | 2008-11-05 13:39:10 +1100 | [diff] [blame] | 625 | #endif /* CONFIG_SMP */ |
Paul E. McKenney | a25909a | 2010-05-13 12:32:28 -0700 | [diff] [blame] | 626 | |
Tejun Heo | a0a1a5f | 2010-06-29 10:07:12 +0200 | [diff] [blame] | 627 | #ifdef CONFIG_FREEZER |
| 628 | extern void freeze_workqueues_begin(void); |
| 629 | extern bool freeze_workqueues_busy(void); |
| 630 | extern void thaw_workqueues(void); |
| 631 | #endif /* CONFIG_FREEZER */ |
| 632 | |
Tejun Heo | 226223a | 2013-03-12 11:30:05 -0700 | [diff] [blame] | 633 | #ifdef CONFIG_SYSFS |
| 634 | int workqueue_sysfs_register(struct workqueue_struct *wq); |
| 635 | #else /* CONFIG_SYSFS */ |
| 636 | static inline int workqueue_sysfs_register(struct workqueue_struct *wq) |
| 637 | { return 0; } |
| 638 | #endif /* CONFIG_SYSFS */ |
| 639 | |
Tejun Heo | 82607adc | 2015-12-08 11:28:04 -0500 | [diff] [blame] | 640 | #ifdef CONFIG_WQ_WATCHDOG |
| 641 | void wq_watchdog_touch(int cpu); |
| 642 | #else /* CONFIG_WQ_WATCHDOG */ |
| 643 | static inline void wq_watchdog_touch(int cpu) { } |
| 644 | #endif /* CONFIG_WQ_WATCHDOG */ |
| 645 | |
Thomas Gleixner | 7ee681b | 2016-07-13 17:16:29 +0000 | [diff] [blame] | 646 | #ifdef CONFIG_SMP |
| 647 | int workqueue_prepare_cpu(unsigned int cpu); |
| 648 | int workqueue_online_cpu(unsigned int cpu); |
| 649 | int workqueue_offline_cpu(unsigned int cpu); |
| 650 | #endif |
| 651 | |
Tejun Heo | 3347fa0 | 2016-09-16 15:49:32 -0400 | [diff] [blame] | 652 | int __init workqueue_init_early(void); |
| 653 | int __init workqueue_init(void); |
| 654 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 655 | #endif |