Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * workqueue.h --- work queue handling for Linux. |
| 3 | */ |
| 4 | |
| 5 | #ifndef _LINUX_WORKQUEUE_H |
| 6 | #define _LINUX_WORKQUEUE_H |
| 7 | |
| 8 | #include <linux/timer.h> |
| 9 | #include <linux/linkage.h> |
| 10 | #include <linux/bitops.h> |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 11 | #include <linux/lockdep.h> |
Tejun Heo | 7a22ad7 | 2010-06-29 10:07:13 +0200 | [diff] [blame] | 12 | #include <linux/threads.h> |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 13 | #include <asm/atomic.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | |
| 15 | struct workqueue_struct; |
| 16 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 17 | struct work_struct; |
| 18 | typedef void (*work_func_t)(struct work_struct *work); |
David Howells | 6bb49e5 | 2006-11-22 14:54:45 +0000 | [diff] [blame] | 19 | |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 20 | /* |
| 21 | * The first word is the work queue pointer and the flags rolled into |
| 22 | * one |
| 23 | */ |
| 24 | #define work_data_bits(work) ((unsigned long *)(&(work)->data)) |
| 25 | |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 26 | enum { |
| 27 | WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */ |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 28 | WORK_STRUCT_DELAYED_BIT = 1, /* work item is delayed */ |
| 29 | WORK_STRUCT_CWQ_BIT = 2, /* data points to cwq */ |
| 30 | WORK_STRUCT_LINKED_BIT = 3, /* next work is linked to this one */ |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 31 | #ifdef CONFIG_DEBUG_OBJECTS_WORK |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 32 | WORK_STRUCT_STATIC_BIT = 4, /* static initializer (debugobjects) */ |
| 33 | WORK_STRUCT_COLOR_SHIFT = 5, /* color for workqueue flushing */ |
Tejun Heo | 0f90004 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 34 | #else |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 35 | WORK_STRUCT_COLOR_SHIFT = 4, /* color for workqueue flushing */ |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 36 | #endif |
| 37 | |
Tejun Heo | 73f53c4 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 38 | WORK_STRUCT_COLOR_BITS = 4, |
| 39 | |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 40 | WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT, |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 41 | WORK_STRUCT_DELAYED = 1 << WORK_STRUCT_DELAYED_BIT, |
Tejun Heo | e120153 | 2010-07-22 14:14:25 +0200 | [diff] [blame] | 42 | WORK_STRUCT_CWQ = 1 << WORK_STRUCT_CWQ_BIT, |
Tejun Heo | affee4b | 2010-06-29 10:07:12 +0200 | [diff] [blame] | 43 | WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT, |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 44 | #ifdef CONFIG_DEBUG_OBJECTS_WORK |
| 45 | WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT, |
| 46 | #else |
| 47 | WORK_STRUCT_STATIC = 0, |
| 48 | #endif |
| 49 | |
Tejun Heo | 73f53c4 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 50 | /* |
| 51 | * The last color is no color used for works which don't |
| 52 | * participate in workqueue flushing. |
| 53 | */ |
| 54 | WORK_NR_COLORS = (1 << WORK_STRUCT_COLOR_BITS) - 1, |
| 55 | WORK_NO_COLOR = WORK_NR_COLORS, |
| 56 | |
Tejun Heo | bdbc5dd | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 57 | /* special cpu IDs */ |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 58 | WORK_CPU_UNBOUND = NR_CPUS, |
| 59 | WORK_CPU_NONE = NR_CPUS + 1, |
Tejun Heo | bdbc5dd | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 60 | WORK_CPU_LAST = WORK_CPU_NONE, |
| 61 | |
Tejun Heo | 73f53c4 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 62 | /* |
Tejun Heo | e120153 | 2010-07-22 14:14:25 +0200 | [diff] [blame] | 63 | * Reserve 7 bits off of cwq pointer w/ debugobjects turned |
Tejun Heo | 8a2e8e5d | 2010-08-25 10:33:56 +0200 | [diff] [blame] | 64 | * off. This makes cwqs aligned to 256 bytes and allows 15 |
| 65 | * workqueue flush colors. |
Tejun Heo | 73f53c4 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 66 | */ |
| 67 | WORK_STRUCT_FLAG_BITS = WORK_STRUCT_COLOR_SHIFT + |
| 68 | WORK_STRUCT_COLOR_BITS, |
| 69 | |
Tejun Heo | 0f90004 | 2010-06-29 10:07:11 +0200 | [diff] [blame] | 70 | WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1, |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 71 | WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK, |
Tejun Heo | bdbc5dd | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 72 | WORK_STRUCT_NO_CPU = WORK_CPU_NONE << WORK_STRUCT_FLAG_BITS, |
Tejun Heo | dcd989c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 73 | |
| 74 | /* bit mask for work_busy() return values */ |
| 75 | WORK_BUSY_PENDING = 1 << 0, |
| 76 | WORK_BUSY_RUNNING = 1 << 1, |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 77 | }; |
| 78 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | struct work_struct { |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 80 | atomic_long_t data; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | struct list_head entry; |
David Howells | 6bb49e5 | 2006-11-22 14:54:45 +0000 | [diff] [blame] | 82 | work_func_t func; |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 83 | #ifdef CONFIG_LOCKDEP |
| 84 | struct lockdep_map lockdep_map; |
| 85 | #endif |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 86 | }; |
| 87 | |
Tejun Heo | 7a22ad7 | 2010-06-29 10:07:13 +0200 | [diff] [blame] | 88 | #define WORK_DATA_INIT() ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU) |
| 89 | #define WORK_DATA_STATIC_INIT() \ |
| 90 | ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU | WORK_STRUCT_STATIC) |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 91 | |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 92 | struct delayed_work { |
| 93 | struct work_struct work; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | struct timer_list timer; |
| 95 | }; |
| 96 | |
Jean Delvare | bf6aede | 2009-04-02 16:56:54 -0700 | [diff] [blame] | 97 | static inline struct delayed_work *to_delayed_work(struct work_struct *work) |
| 98 | { |
| 99 | return container_of(work, struct delayed_work, work); |
| 100 | } |
| 101 | |
James Bottomley | 1fa44ec | 2006-02-23 12:43:43 -0600 | [diff] [blame] | 102 | struct execute_work { |
| 103 | struct work_struct work; |
| 104 | }; |
| 105 | |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 106 | #ifdef CONFIG_LOCKDEP |
| 107 | /* |
| 108 | * NB: because we have to copy the lockdep_map, setting _key |
| 109 | * here is required, otherwise it could get initialised to the |
| 110 | * copy of the lockdep_map! |
| 111 | */ |
| 112 | #define __WORK_INIT_LOCKDEP_MAP(n, k) \ |
| 113 | .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k), |
| 114 | #else |
| 115 | #define __WORK_INIT_LOCKDEP_MAP(n, k) |
| 116 | #endif |
| 117 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 118 | #define __WORK_INITIALIZER(n, f) { \ |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 119 | .data = WORK_DATA_STATIC_INIT(), \ |
Oleg Nesterov | 23b2e59 | 2007-05-09 02:34:19 -0700 | [diff] [blame] | 120 | .entry = { &(n).entry, &(n).entry }, \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 121 | .func = (f), \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 122 | __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 123 | } |
| 124 | |
| 125 | #define __DELAYED_WORK_INITIALIZER(n, f) { \ |
| 126 | .work = __WORK_INITIALIZER((n).work, (f)), \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 127 | .timer = TIMER_INITIALIZER(NULL, 0, 0), \ |
| 128 | } |
| 129 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 130 | #define DECLARE_WORK(n, f) \ |
| 131 | struct work_struct n = __WORK_INITIALIZER(n, f) |
| 132 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 133 | #define DECLARE_DELAYED_WORK(n, f) \ |
| 134 | struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f) |
| 135 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | /* |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 137 | * initialize a work item's function pointer |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | */ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 139 | #define PREPARE_WORK(_work, _func) \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | do { \ |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 141 | (_work)->func = (_func); \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | } while (0) |
| 143 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 144 | #define PREPARE_DELAYED_WORK(_work, _func) \ |
| 145 | PREPARE_WORK(&(_work)->work, (_func)) |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 146 | |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 147 | #ifdef CONFIG_DEBUG_OBJECTS_WORK |
| 148 | extern void __init_work(struct work_struct *work, int onstack); |
| 149 | extern void destroy_work_on_stack(struct work_struct *work); |
Tejun Heo | 4690c4a | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 150 | static inline unsigned int work_static(struct work_struct *work) |
| 151 | { |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 152 | return *work_data_bits(work) & WORK_STRUCT_STATIC; |
Tejun Heo | 4690c4a | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 153 | } |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 154 | #else |
| 155 | static inline void __init_work(struct work_struct *work, int onstack) { } |
| 156 | static inline void destroy_work_on_stack(struct work_struct *work) { } |
Tejun Heo | 4690c4a | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 157 | static inline unsigned int work_static(struct work_struct *work) { return 0; } |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 158 | #endif |
| 159 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 160 | /* |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 161 | * initialize all of a work item in one go |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 162 | * |
Dmitri Vorobiev | b9049df | 2009-06-23 12:09:29 +0200 | [diff] [blame] | 163 | * NOTE! No point in using "atomic_long_set()": using a direct |
Linus Torvalds | a08727b | 2006-12-16 09:53:50 -0800 | [diff] [blame] | 164 | * assignment of the work data initializer allows the compiler |
| 165 | * to generate better code. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 166 | */ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 167 | #ifdef CONFIG_LOCKDEP |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 168 | #define __INIT_WORK(_work, _func, _onstack) \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 169 | do { \ |
| 170 | static struct lock_class_key __key; \ |
| 171 | \ |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 172 | __init_work((_work), _onstack); \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 173 | (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \ |
| 174 | lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0);\ |
| 175 | INIT_LIST_HEAD(&(_work)->entry); \ |
| 176 | PREPARE_WORK((_work), (_func)); \ |
| 177 | } while (0) |
| 178 | #else |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 179 | #define __INIT_WORK(_work, _func, _onstack) \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 180 | do { \ |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 181 | __init_work((_work), _onstack); \ |
Oleg Nesterov | 23b2e59 | 2007-05-09 02:34:19 -0700 | [diff] [blame] | 182 | (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 183 | INIT_LIST_HEAD(&(_work)->entry); \ |
| 184 | PREPARE_WORK((_work), (_func)); \ |
| 185 | } while (0) |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 186 | #endif |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 187 | |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 188 | #define INIT_WORK(_work, _func) \ |
| 189 | do { \ |
| 190 | __INIT_WORK((_work), (_func), 0); \ |
| 191 | } while (0) |
| 192 | |
| 193 | #define INIT_WORK_ON_STACK(_work, _func) \ |
| 194 | do { \ |
| 195 | __INIT_WORK((_work), (_func), 1); \ |
| 196 | } while (0) |
| 197 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 198 | #define INIT_DELAYED_WORK(_work, _func) \ |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 199 | do { \ |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 200 | INIT_WORK(&(_work)->work, (_func)); \ |
| 201 | init_timer(&(_work)->timer); \ |
| 202 | } while (0) |
| 203 | |
Peter Zijlstra | 6d612b0 | 2009-01-12 12:52:23 +0100 | [diff] [blame] | 204 | #define INIT_DELAYED_WORK_ON_STACK(_work, _func) \ |
| 205 | do { \ |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 206 | INIT_WORK_ON_STACK(&(_work)->work, (_func)); \ |
Peter Zijlstra | 6d612b0 | 2009-01-12 12:52:23 +0100 | [diff] [blame] | 207 | init_timer_on_stack(&(_work)->timer); \ |
| 208 | } while (0) |
| 209 | |
Thomas Gleixner | dc186ad | 2009-11-16 01:09:48 +0900 | [diff] [blame] | 210 | #define INIT_DELAYED_WORK_DEFERRABLE(_work, _func) \ |
Venki Pallipadi | 2828703 | 2007-05-08 00:27:47 -0700 | [diff] [blame] | 211 | do { \ |
| 212 | INIT_WORK(&(_work)->work, (_func)); \ |
| 213 | init_timer_deferrable(&(_work)->timer); \ |
| 214 | } while (0) |
| 215 | |
David Howells | 365970a | 2006-11-22 14:54:49 +0000 | [diff] [blame] | 216 | /** |
| 217 | * work_pending - Find out whether a work item is currently pending |
| 218 | * @work: The work item in question |
| 219 | */ |
| 220 | #define work_pending(work) \ |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 221 | test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) |
David Howells | 365970a | 2006-11-22 14:54:49 +0000 | [diff] [blame] | 222 | |
| 223 | /** |
| 224 | * delayed_work_pending - Find out whether a delayable work item is currently |
| 225 | * pending |
| 226 | * @work: The work item in question |
| 227 | */ |
Linus Torvalds | 0221872 | 2006-12-15 14:13:51 -0800 | [diff] [blame] | 228 | #define delayed_work_pending(w) \ |
| 229 | work_pending(&(w)->work) |
David Howells | 365970a | 2006-11-22 14:54:49 +0000 | [diff] [blame] | 230 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 231 | /** |
Oleg Nesterov | 23b2e59 | 2007-05-09 02:34:19 -0700 | [diff] [blame] | 232 | * work_clear_pending - for internal use only, mark a work item as not pending |
| 233 | * @work: The work item in question |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 234 | */ |
Oleg Nesterov | 23b2e59 | 2007-05-09 02:34:19 -0700 | [diff] [blame] | 235 | #define work_clear_pending(work) \ |
Tejun Heo | 22df02b | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 236 | clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 237 | |
Tejun Heo | c54fce6 | 2010-09-10 16:51:36 +0200 | [diff] [blame] | 238 | /* |
| 239 | * Workqueue flags and constants. For details, please refer to |
| 240 | * Documentation/workqueue.txt. |
| 241 | */ |
Tejun Heo | 97e37d7 | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 242 | enum { |
Tejun Heo | bdbc5dd | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 243 | WQ_NON_REENTRANT = 1 << 0, /* guarantee non-reentrance */ |
Tejun Heo | c7fc77f | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 244 | WQ_UNBOUND = 1 << 1, /* not bound to any cpu */ |
Tejun Heo | bdbc5dd | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 245 | WQ_FREEZEABLE = 1 << 2, /* freeze during suspend */ |
Tejun Heo | e22bee7 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 246 | WQ_RESCUER = 1 << 3, /* has an rescue worker */ |
Tejun Heo | 649027d | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 247 | WQ_HIGHPRI = 1 << 4, /* high priority */ |
Tejun Heo | fb0e7be | 2010-06-29 10:07:15 +0200 | [diff] [blame] | 248 | WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */ |
Tejun Heo | b71ab8c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 249 | |
Tejun Heo | e41e704 | 2010-08-24 14:22:47 +0200 | [diff] [blame] | 250 | WQ_DYING = 1 << 6, /* internal: workqueue is dying */ |
| 251 | |
Tejun Heo | b71ab8c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 252 | WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */ |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 253 | WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */ |
Tejun Heo | b71ab8c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 254 | WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2, |
Tejun Heo | 97e37d7 | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 255 | }; |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 256 | |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 257 | /* unbound wq's aren't per-cpu, scale max_active according to #cpus */ |
| 258 | #define WQ_UNBOUND_MAX_ACTIVE \ |
| 259 | max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU) |
| 260 | |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 261 | /* |
| 262 | * System-wide workqueues which are always present. |
| 263 | * |
| 264 | * system_wq is the one used by schedule[_delayed]_work[_on](). |
| 265 | * Multi-CPU multi-threaded. There are users which expect relatively |
| 266 | * short queue flush time. Don't queue works which can run for too |
| 267 | * long. |
| 268 | * |
| 269 | * system_long_wq is similar to system_wq but may host long running |
| 270 | * works. Queue flushing might take relatively long. |
| 271 | * |
| 272 | * system_nrt_wq is non-reentrant and guarantees that any given work |
| 273 | * item is never executed in parallel by multiple CPUs. Queue |
| 274 | * flushing might take relatively long. |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 275 | * |
| 276 | * system_unbound_wq is unbound workqueue. Workers are not bound to |
| 277 | * any specific CPU, not concurrency managed, and all queued works are |
| 278 | * executed immediately as long as max_active limit is not reached and |
| 279 | * resources are available. |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 280 | */ |
| 281 | extern struct workqueue_struct *system_wq; |
| 282 | extern struct workqueue_struct *system_long_wq; |
| 283 | extern struct workqueue_struct *system_nrt_wq; |
Tejun Heo | f342179 | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 284 | extern struct workqueue_struct *system_unbound_wq; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 285 | |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 286 | extern struct workqueue_struct * |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 287 | __alloc_workqueue_key(const char *name, unsigned int flags, int max_active, |
| 288 | struct lock_class_key *key, const char *lock_name); |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 289 | |
| 290 | #ifdef CONFIG_LOCKDEP |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 291 | #define alloc_workqueue(name, flags, max_active) \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 292 | ({ \ |
| 293 | static struct lock_class_key __key; \ |
Johannes Berg | eb13ba8 | 2008-01-16 09:51:58 +0100 | [diff] [blame] | 294 | const char *__lock_name; \ |
| 295 | \ |
| 296 | if (__builtin_constant_p(name)) \ |
| 297 | __lock_name = (name); \ |
| 298 | else \ |
| 299 | __lock_name = #name; \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 300 | \ |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 301 | __alloc_workqueue_key((name), (flags), (max_active), \ |
| 302 | &__key, __lock_name); \ |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 303 | }) |
| 304 | #else |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 305 | #define alloc_workqueue(name, flags, max_active) \ |
| 306 | __alloc_workqueue_key((name), (flags), (max_active), NULL, NULL) |
Johannes Berg | 4e6045f | 2007-10-18 23:39:55 -0700 | [diff] [blame] | 307 | #endif |
| 308 | |
Tejun Heo | 97e37d7 | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 309 | #define create_workqueue(name) \ |
Tejun Heo | d320c03 | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 310 | alloc_workqueue((name), WQ_RESCUER, 1) |
Tejun Heo | 97e37d7 | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 311 | #define create_freezeable_workqueue(name) \ |
Tejun Heo | c7fc77f | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 312 | alloc_workqueue((name), WQ_FREEZEABLE | WQ_UNBOUND | WQ_RESCUER, 1) |
Tejun Heo | 97e37d7 | 2010-06-29 10:07:10 +0200 | [diff] [blame] | 313 | #define create_singlethread_workqueue(name) \ |
Tejun Heo | c7fc77f | 2010-07-02 10:03:51 +0200 | [diff] [blame] | 314 | alloc_workqueue((name), WQ_UNBOUND | WQ_RESCUER, 1) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 315 | |
| 316 | extern void destroy_workqueue(struct workqueue_struct *wq); |
| 317 | |
Harvey Harrison | b3c9752 | 2008-02-13 15:03:15 -0800 | [diff] [blame] | 318 | extern int queue_work(struct workqueue_struct *wq, struct work_struct *work); |
Zhang Rui | c1a220e | 2008-07-23 21:28:39 -0700 | [diff] [blame] | 319 | extern int queue_work_on(int cpu, struct workqueue_struct *wq, |
| 320 | struct work_struct *work); |
Harvey Harrison | b3c9752 | 2008-02-13 15:03:15 -0800 | [diff] [blame] | 321 | extern int queue_delayed_work(struct workqueue_struct *wq, |
| 322 | struct delayed_work *work, unsigned long delay); |
Venkatesh Pallipadi | 7a6bc1c | 2006-06-28 13:50:33 -0700 | [diff] [blame] | 323 | extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq, |
Oleg Nesterov | 28e53bd | 2007-05-09 02:34:22 -0700 | [diff] [blame] | 324 | struct delayed_work *work, unsigned long delay); |
| 325 | |
Harvey Harrison | b3c9752 | 2008-02-13 15:03:15 -0800 | [diff] [blame] | 326 | extern void flush_workqueue(struct workqueue_struct *wq); |
Oleg Nesterov | 28e53bd | 2007-05-09 02:34:22 -0700 | [diff] [blame] | 327 | extern void flush_scheduled_work(void); |
Linus Torvalds | 43046b6 | 2009-10-14 09:16:42 -0700 | [diff] [blame] | 328 | extern void flush_delayed_work(struct delayed_work *work); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 329 | |
Harvey Harrison | b3c9752 | 2008-02-13 15:03:15 -0800 | [diff] [blame] | 330 | extern int schedule_work(struct work_struct *work); |
Zhang Rui | c1a220e | 2008-07-23 21:28:39 -0700 | [diff] [blame] | 331 | extern int schedule_work_on(int cpu, struct work_struct *work); |
Harvey Harrison | b3c9752 | 2008-02-13 15:03:15 -0800 | [diff] [blame] | 332 | extern int schedule_delayed_work(struct delayed_work *work, unsigned long delay); |
Oleg Nesterov | 28e53bd | 2007-05-09 02:34:22 -0700 | [diff] [blame] | 333 | extern int schedule_delayed_work_on(int cpu, struct delayed_work *work, |
| 334 | unsigned long delay); |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 335 | extern int schedule_on_each_cpu(work_func_t func); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 336 | extern int keventd_up(void); |
| 337 | |
David Howells | 65f27f3 | 2006-11-22 14:55:48 +0000 | [diff] [blame] | 338 | int execute_in_process_context(work_func_t fn, struct execute_work *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 339 | |
Oleg Nesterov | db70089 | 2008-07-25 01:47:49 -0700 | [diff] [blame] | 340 | extern int flush_work(struct work_struct *work); |
Oleg Nesterov | 1f1f642 | 2007-07-15 23:41:44 -0700 | [diff] [blame] | 341 | extern int cancel_work_sync(struct work_struct *work); |
Oleg Nesterov | 28e53bd | 2007-05-09 02:34:22 -0700 | [diff] [blame] | 342 | |
Tejun Heo | dcd989c | 2010-06-29 10:07:14 +0200 | [diff] [blame] | 343 | extern void workqueue_set_max_active(struct workqueue_struct *wq, |
| 344 | int max_active); |
| 345 | extern bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq); |
| 346 | extern unsigned int work_cpu(struct work_struct *work); |
| 347 | extern unsigned int work_busy(struct work_struct *work); |
| 348 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 349 | /* |
| 350 | * Kill off a pending schedule_delayed_work(). Note that the work callback |
Oleg Nesterov | 071b638 | 2007-04-26 15:45:32 -0700 | [diff] [blame] | 351 | * function may still be running on return from cancel_delayed_work(), unless |
| 352 | * it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or |
Oleg Nesterov | 28e53bd | 2007-05-09 02:34:22 -0700 | [diff] [blame] | 353 | * cancel_work_sync() to wait on it. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 354 | */ |
David Howells | 52bad64 | 2006-11-22 14:54:01 +0000 | [diff] [blame] | 355 | static inline int cancel_delayed_work(struct delayed_work *work) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 356 | { |
| 357 | int ret; |
| 358 | |
Oleg Nesterov | 223a10a | 2007-05-18 00:36:42 -0700 | [diff] [blame] | 359 | ret = del_timer_sync(&work->timer); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 360 | if (ret) |
Oleg Nesterov | 23b2e59 | 2007-05-09 02:34:19 -0700 | [diff] [blame] | 361 | work_clear_pending(&work->work); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 362 | return ret; |
| 363 | } |
| 364 | |
Oleg Nesterov | 4e49627 | 2009-09-05 11:17:06 -0700 | [diff] [blame] | 365 | /* |
| 366 | * Like above, but uses del_timer() instead of del_timer_sync(). This means, |
| 367 | * if it returns 0 the timer function may be running and the queueing is in |
| 368 | * progress. |
| 369 | */ |
| 370 | static inline int __cancel_delayed_work(struct delayed_work *work) |
| 371 | { |
| 372 | int ret; |
| 373 | |
| 374 | ret = del_timer(&work->timer); |
| 375 | if (ret) |
| 376 | work_clear_pending(&work->work); |
| 377 | return ret; |
| 378 | } |
| 379 | |
Oleg Nesterov | 1f1f642 | 2007-07-15 23:41:44 -0700 | [diff] [blame] | 380 | extern int cancel_delayed_work_sync(struct delayed_work *work); |
Oleg Nesterov | 1634c48 | 2007-05-09 02:34:18 -0700 | [diff] [blame] | 381 | |
Oleg Nesterov | f5a421a | 2007-07-15 23:41:44 -0700 | [diff] [blame] | 382 | /* Obsolete. use cancel_delayed_work_sync() */ |
Oleg Nesterov | 1634c48 | 2007-05-09 02:34:18 -0700 | [diff] [blame] | 383 | static inline |
| 384 | void cancel_rearming_delayed_workqueue(struct workqueue_struct *wq, |
| 385 | struct delayed_work *work) |
| 386 | { |
Oleg Nesterov | f5a421a | 2007-07-15 23:41:44 -0700 | [diff] [blame] | 387 | cancel_delayed_work_sync(work); |
| 388 | } |
| 389 | |
| 390 | /* Obsolete. use cancel_delayed_work_sync() */ |
| 391 | static inline |
| 392 | void cancel_rearming_delayed_work(struct delayed_work *work) |
| 393 | { |
| 394 | cancel_delayed_work_sync(work); |
Oleg Nesterov | 1634c48 | 2007-05-09 02:34:18 -0700 | [diff] [blame] | 395 | } |
| 396 | |
Rusty Russell | 2d3854a | 2008-11-05 13:39:10 +1100 | [diff] [blame] | 397 | #ifndef CONFIG_SMP |
| 398 | static inline long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg) |
| 399 | { |
| 400 | return fn(arg); |
| 401 | } |
| 402 | #else |
| 403 | long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg); |
| 404 | #endif /* CONFIG_SMP */ |
Paul E. McKenney | a25909a | 2010-05-13 12:32:28 -0700 | [diff] [blame] | 405 | |
Tejun Heo | a0a1a5f | 2010-06-29 10:07:12 +0200 | [diff] [blame] | 406 | #ifdef CONFIG_FREEZER |
| 407 | extern void freeze_workqueues_begin(void); |
| 408 | extern bool freeze_workqueues_busy(void); |
| 409 | extern void thaw_workqueues(void); |
| 410 | #endif /* CONFIG_FREEZER */ |
| 411 | |
Paul E. McKenney | a25909a | 2010-05-13 12:32:28 -0700 | [diff] [blame] | 412 | #ifdef CONFIG_LOCKDEP |
| 413 | int in_workqueue_context(struct workqueue_struct *wq); |
| 414 | #endif |
Linus Torvalds | 3b7433b | 2010-08-07 12:42:58 -0700 | [diff] [blame] | 415 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 416 | #endif |