]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Generic waiting primitives. | |
3 | * | |
6d49e352 | 4 | * (C) 2004 Nadia Yvette Chambers, Oracle |
1da177e4 | 5 | */ |
1da177e4 | 6 | #include <linux/init.h> |
9984de1a | 7 | #include <linux/export.h> |
174cd4b1 | 8 | #include <linux/sched/signal.h> |
b17b0153 | 9 | #include <linux/sched/debug.h> |
1da177e4 LT |
10 | #include <linux/mm.h> |
11 | #include <linux/wait.h> | |
12 | #include <linux/hash.h> | |
cb6538e7 | 13 | #include <linux/kthread.h> |
1da177e4 | 14 | |
9d9d676f | 15 | void __init_waitqueue_head(struct wait_queue_head *wq_head, const char *name, struct lock_class_key *key) |
21d71f51 | 16 | { |
9d9d676f IM |
17 | spin_lock_init(&wq_head->lock); |
18 | lockdep_set_class_and_name(&wq_head->lock, key, name); | |
2055da97 | 19 | INIT_LIST_HEAD(&wq_head->head); |
21d71f51 | 20 | } |
eb4542b9 | 21 | |
2fc39111 | 22 | EXPORT_SYMBOL(__init_waitqueue_head); |
eb4542b9 | 23 | |
9d9d676f | 24 | void add_wait_queue(struct wait_queue_head *wq_head, struct wait_queue_entry *wq_entry) |
1da177e4 LT |
25 | { |
26 | unsigned long flags; | |
27 | ||
50816c48 | 28 | wq_entry->flags &= ~WQ_FLAG_EXCLUSIVE; |
9d9d676f IM |
29 | spin_lock_irqsave(&wq_head->lock, flags); |
30 | __add_wait_queue_entry_tail(wq_head, wq_entry); | |
31 | spin_unlock_irqrestore(&wq_head->lock, flags); | |
1da177e4 LT |
32 | } |
33 | EXPORT_SYMBOL(add_wait_queue); | |
34 | ||
9d9d676f | 35 | void add_wait_queue_exclusive(struct wait_queue_head *wq_head, struct wait_queue_entry *wq_entry) |
1da177e4 LT |
36 | { |
37 | unsigned long flags; | |
38 | ||
50816c48 | 39 | wq_entry->flags |= WQ_FLAG_EXCLUSIVE; |
9d9d676f IM |
40 | spin_lock_irqsave(&wq_head->lock, flags); |
41 | __add_wait_queue_entry_tail(wq_head, wq_entry); | |
42 | spin_unlock_irqrestore(&wq_head->lock, flags); | |
1da177e4 LT |
43 | } |
44 | EXPORT_SYMBOL(add_wait_queue_exclusive); | |
45 | ||
9d9d676f | 46 | void remove_wait_queue(struct wait_queue_head *wq_head, struct wait_queue_entry *wq_entry) |
1da177e4 LT |
47 | { |
48 | unsigned long flags; | |
49 | ||
9d9d676f IM |
50 | spin_lock_irqsave(&wq_head->lock, flags); |
51 | __remove_wait_queue(wq_head, wq_entry); | |
52 | spin_unlock_irqrestore(&wq_head->lock, flags); | |
1da177e4 LT |
53 | } |
54 | EXPORT_SYMBOL(remove_wait_queue); | |
55 | ||
56 | ||
b4145872 PZ |
57 | /* |
58 | * The core wakeup function. Non-exclusive wakeups (nr_exclusive == 0) just | |
59 | * wake everything up. If it's an exclusive wakeup (nr_exclusive == small +ve | |
60 | * number) then we wake all the non-exclusive tasks and one exclusive task. | |
61 | * | |
62 | * There are circumstances in which we can try to wake a task which has already | |
63 | * started to run but is not in state TASK_RUNNING. try_to_wake_up() returns | |
64 | * zero in this (rare) case, and we handle it by continuing to scan the queue. | |
65 | */ | |
9d9d676f | 66 | static void __wake_up_common(struct wait_queue_head *wq_head, unsigned int mode, |
b4145872 PZ |
67 | int nr_exclusive, int wake_flags, void *key) |
68 | { | |
ac6424b9 | 69 | wait_queue_entry_t *curr, *next; |
b4145872 | 70 | |
2055da97 | 71 | list_for_each_entry_safe(curr, next, &wq_head->head, entry) { |
b4145872 PZ |
72 | unsigned flags = curr->flags; |
73 | ||
74 | if (curr->func(curr, mode, wake_flags, key) && | |
75 | (flags & WQ_FLAG_EXCLUSIVE) && !--nr_exclusive) | |
76 | break; | |
77 | } | |
78 | } | |
79 | ||
80 | /** | |
81 | * __wake_up - wake up threads blocked on a waitqueue. | |
9d9d676f | 82 | * @wq_head: the waitqueue |
b4145872 PZ |
83 | * @mode: which threads |
84 | * @nr_exclusive: how many wake-one or wake-many threads to wake up | |
85 | * @key: is directly passed to the wakeup function | |
86 | * | |
87 | * It may be assumed that this function implies a write memory barrier before | |
88 | * changing the task state if and only if any tasks are woken up. | |
89 | */ | |
9d9d676f | 90 | void __wake_up(struct wait_queue_head *wq_head, unsigned int mode, |
b4145872 PZ |
91 | int nr_exclusive, void *key) |
92 | { | |
93 | unsigned long flags; | |
94 | ||
9d9d676f IM |
95 | spin_lock_irqsave(&wq_head->lock, flags); |
96 | __wake_up_common(wq_head, mode, nr_exclusive, 0, key); | |
97 | spin_unlock_irqrestore(&wq_head->lock, flags); | |
b4145872 PZ |
98 | } |
99 | EXPORT_SYMBOL(__wake_up); | |
100 | ||
101 | /* | |
102 | * Same as __wake_up but called with the spinlock in wait_queue_head_t held. | |
103 | */ | |
9d9d676f | 104 | void __wake_up_locked(struct wait_queue_head *wq_head, unsigned int mode, int nr) |
b4145872 | 105 | { |
9d9d676f | 106 | __wake_up_common(wq_head, mode, nr, 0, NULL); |
b4145872 PZ |
107 | } |
108 | EXPORT_SYMBOL_GPL(__wake_up_locked); | |
109 | ||
9d9d676f | 110 | void __wake_up_locked_key(struct wait_queue_head *wq_head, unsigned int mode, void *key) |
b4145872 | 111 | { |
9d9d676f | 112 | __wake_up_common(wq_head, mode, 1, 0, key); |
b4145872 PZ |
113 | } |
114 | EXPORT_SYMBOL_GPL(__wake_up_locked_key); | |
115 | ||
116 | /** | |
117 | * __wake_up_sync_key - wake up threads blocked on a waitqueue. | |
9d9d676f | 118 | * @wq_head: the waitqueue |
b4145872 PZ |
119 | * @mode: which threads |
120 | * @nr_exclusive: how many wake-one or wake-many threads to wake up | |
121 | * @key: opaque value to be passed to wakeup targets | |
122 | * | |
123 | * The sync wakeup differs that the waker knows that it will schedule | |
124 | * away soon, so while the target thread will be woken up, it will not | |
125 | * be migrated to another CPU - ie. the two threads are 'synchronized' | |
126 | * with each other. This can prevent needless bouncing between CPUs. | |
127 | * | |
128 | * On UP it can prevent extra preemption. | |
129 | * | |
130 | * It may be assumed that this function implies a write memory barrier before | |
131 | * changing the task state if and only if any tasks are woken up. | |
132 | */ | |
9d9d676f | 133 | void __wake_up_sync_key(struct wait_queue_head *wq_head, unsigned int mode, |
b4145872 PZ |
134 | int nr_exclusive, void *key) |
135 | { | |
136 | unsigned long flags; | |
137 | int wake_flags = 1; /* XXX WF_SYNC */ | |
138 | ||
9d9d676f | 139 | if (unlikely(!wq_head)) |
b4145872 PZ |
140 | return; |
141 | ||
142 | if (unlikely(nr_exclusive != 1)) | |
143 | wake_flags = 0; | |
144 | ||
9d9d676f IM |
145 | spin_lock_irqsave(&wq_head->lock, flags); |
146 | __wake_up_common(wq_head, mode, nr_exclusive, wake_flags, key); | |
147 | spin_unlock_irqrestore(&wq_head->lock, flags); | |
b4145872 PZ |
148 | } |
149 | EXPORT_SYMBOL_GPL(__wake_up_sync_key); | |
150 | ||
151 | /* | |
152 | * __wake_up_sync - see __wake_up_sync_key() | |
153 | */ | |
9d9d676f | 154 | void __wake_up_sync(struct wait_queue_head *wq_head, unsigned int mode, int nr_exclusive) |
b4145872 | 155 | { |
9d9d676f | 156 | __wake_up_sync_key(wq_head, mode, nr_exclusive, NULL); |
b4145872 PZ |
157 | } |
158 | EXPORT_SYMBOL_GPL(__wake_up_sync); /* For internal use only */ | |
159 | ||
1da177e4 LT |
160 | /* |
161 | * Note: we use "set_current_state()" _after_ the wait-queue add, | |
162 | * because we need a memory barrier there on SMP, so that any | |
163 | * wake-function that tests for the wait-queue being active | |
164 | * will be guaranteed to see waitqueue addition _or_ subsequent | |
165 | * tests in this thread will see the wakeup having taken place. | |
166 | * | |
167 | * The spin_unlock() itself is semi-permeable and only protects | |
168 | * one way (it only protects stuff inside the critical region and | |
169 | * stops them from bleeding out - it would still allow subsequent | |
59c51591 | 170 | * loads to move into the critical region). |
1da177e4 | 171 | */ |
7ad5b3a5 | 172 | void |
9d9d676f | 173 | prepare_to_wait(struct wait_queue_head *wq_head, struct wait_queue_entry *wq_entry, int state) |
1da177e4 LT |
174 | { |
175 | unsigned long flags; | |
176 | ||
50816c48 | 177 | wq_entry->flags &= ~WQ_FLAG_EXCLUSIVE; |
9d9d676f | 178 | spin_lock_irqsave(&wq_head->lock, flags); |
2055da97 | 179 | if (list_empty(&wq_entry->entry)) |
9d9d676f | 180 | __add_wait_queue(wq_head, wq_entry); |
a25d644f | 181 | set_current_state(state); |
9d9d676f | 182 | spin_unlock_irqrestore(&wq_head->lock, flags); |
1da177e4 LT |
183 | } |
184 | EXPORT_SYMBOL(prepare_to_wait); | |
185 | ||
7ad5b3a5 | 186 | void |
9d9d676f | 187 | prepare_to_wait_exclusive(struct wait_queue_head *wq_head, struct wait_queue_entry *wq_entry, int state) |
1da177e4 LT |
188 | { |
189 | unsigned long flags; | |
190 | ||
50816c48 | 191 | wq_entry->flags |= WQ_FLAG_EXCLUSIVE; |
9d9d676f | 192 | spin_lock_irqsave(&wq_head->lock, flags); |
2055da97 | 193 | if (list_empty(&wq_entry->entry)) |
9d9d676f | 194 | __add_wait_queue_entry_tail(wq_head, wq_entry); |
a25d644f | 195 | set_current_state(state); |
9d9d676f | 196 | spin_unlock_irqrestore(&wq_head->lock, flags); |
1da177e4 LT |
197 | } |
198 | EXPORT_SYMBOL(prepare_to_wait_exclusive); | |
199 | ||
50816c48 | 200 | void init_wait_entry(struct wait_queue_entry *wq_entry, int flags) |
0176beaf | 201 | { |
50816c48 IM |
202 | wq_entry->flags = flags; |
203 | wq_entry->private = current; | |
204 | wq_entry->func = autoremove_wake_function; | |
2055da97 | 205 | INIT_LIST_HEAD(&wq_entry->entry); |
0176beaf ON |
206 | } |
207 | EXPORT_SYMBOL(init_wait_entry); | |
208 | ||
9d9d676f | 209 | long prepare_to_wait_event(struct wait_queue_head *wq_head, struct wait_queue_entry *wq_entry, int state) |
c2d81644 ON |
210 | { |
211 | unsigned long flags; | |
b1ea06a9 | 212 | long ret = 0; |
c2d81644 | 213 | |
9d9d676f | 214 | spin_lock_irqsave(&wq_head->lock, flags); |
b1ea06a9 ON |
215 | if (unlikely(signal_pending_state(state, current))) { |
216 | /* | |
217 | * Exclusive waiter must not fail if it was selected by wakeup, | |
218 | * it should "consume" the condition we were waiting for. | |
219 | * | |
220 | * The caller will recheck the condition and return success if | |
221 | * we were already woken up, we can not miss the event because | |
9d9d676f | 222 | * wakeup locks/unlocks the same wq_head->lock. |
b1ea06a9 ON |
223 | * |
224 | * But we need to ensure that set-condition + wakeup after that | |
225 | * can't see us, it should wake up another exclusive waiter if | |
226 | * we fail. | |
227 | */ | |
2055da97 | 228 | list_del_init(&wq_entry->entry); |
b1ea06a9 ON |
229 | ret = -ERESTARTSYS; |
230 | } else { | |
2055da97 | 231 | if (list_empty(&wq_entry->entry)) { |
50816c48 | 232 | if (wq_entry->flags & WQ_FLAG_EXCLUSIVE) |
9d9d676f | 233 | __add_wait_queue_entry_tail(wq_head, wq_entry); |
b1ea06a9 | 234 | else |
9d9d676f | 235 | __add_wait_queue(wq_head, wq_entry); |
b1ea06a9 ON |
236 | } |
237 | set_current_state(state); | |
c2d81644 | 238 | } |
9d9d676f | 239 | spin_unlock_irqrestore(&wq_head->lock, flags); |
c2d81644 | 240 | |
b1ea06a9 | 241 | return ret; |
c2d81644 ON |
242 | } |
243 | EXPORT_SYMBOL(prepare_to_wait_event); | |
244 | ||
bd0f9b35 LT |
245 | /* |
246 | * Note! These two wait functions are entered with the | |
247 | * wait-queue lock held (and interrupts off in the _irq | |
248 | * case), so there is no race with testing the wakeup | |
249 | * condition in the caller before they add the wait | |
250 | * entry to the wake queue. | |
251 | */ | |
ac6424b9 | 252 | int do_wait_intr(wait_queue_head_t *wq, wait_queue_entry_t *wait) |
bd0f9b35 | 253 | { |
2055da97 | 254 | if (likely(list_empty(&wait->entry))) |
ac6424b9 | 255 | __add_wait_queue_entry_tail(wq, wait); |
bd0f9b35 LT |
256 | |
257 | set_current_state(TASK_INTERRUPTIBLE); | |
258 | if (signal_pending(current)) | |
259 | return -ERESTARTSYS; | |
260 | ||
261 | spin_unlock(&wq->lock); | |
262 | schedule(); | |
263 | spin_lock(&wq->lock); | |
264 | return 0; | |
265 | } | |
266 | EXPORT_SYMBOL(do_wait_intr); | |
267 | ||
ac6424b9 | 268 | int do_wait_intr_irq(wait_queue_head_t *wq, wait_queue_entry_t *wait) |
bd0f9b35 | 269 | { |
2055da97 | 270 | if (likely(list_empty(&wait->entry))) |
ac6424b9 | 271 | __add_wait_queue_entry_tail(wq, wait); |
bd0f9b35 LT |
272 | |
273 | set_current_state(TASK_INTERRUPTIBLE); | |
274 | if (signal_pending(current)) | |
275 | return -ERESTARTSYS; | |
276 | ||
277 | spin_unlock_irq(&wq->lock); | |
278 | schedule(); | |
279 | spin_lock_irq(&wq->lock); | |
280 | return 0; | |
281 | } | |
282 | EXPORT_SYMBOL(do_wait_intr_irq); | |
283 | ||
ee2f154a | 284 | /** |
777c6c5f | 285 | * finish_wait - clean up after waiting in a queue |
9d9d676f | 286 | * @wq_head: waitqueue waited on |
50816c48 | 287 | * @wq_entry: wait descriptor |
777c6c5f JW |
288 | * |
289 | * Sets current thread back to running state and removes | |
290 | * the wait descriptor from the given waitqueue if still | |
291 | * queued. | |
292 | */ | |
9d9d676f | 293 | void finish_wait(struct wait_queue_head *wq_head, struct wait_queue_entry *wq_entry) |
1da177e4 LT |
294 | { |
295 | unsigned long flags; | |
296 | ||
297 | __set_current_state(TASK_RUNNING); | |
298 | /* | |
299 | * We can check for list emptiness outside the lock | |
300 | * IFF: | |
301 | * - we use the "careful" check that verifies both | |
302 | * the next and prev pointers, so that there cannot | |
303 | * be any half-pending updates in progress on other | |
304 | * CPU's that we haven't seen yet (and that might | |
305 | * still change the stack area. | |
306 | * and | |
307 | * - all other users take the lock (ie we can only | |
308 | * have _one_ other CPU that looks at or modifies | |
309 | * the list). | |
310 | */ | |
2055da97 | 311 | if (!list_empty_careful(&wq_entry->entry)) { |
9d9d676f | 312 | spin_lock_irqsave(&wq_head->lock, flags); |
2055da97 | 313 | list_del_init(&wq_entry->entry); |
9d9d676f | 314 | spin_unlock_irqrestore(&wq_head->lock, flags); |
1da177e4 LT |
315 | } |
316 | } | |
317 | EXPORT_SYMBOL(finish_wait); | |
318 | ||
50816c48 | 319 | int autoremove_wake_function(struct wait_queue_entry *wq_entry, unsigned mode, int sync, void *key) |
1da177e4 | 320 | { |
50816c48 | 321 | int ret = default_wake_function(wq_entry, mode, sync, key); |
1da177e4 LT |
322 | |
323 | if (ret) | |
2055da97 | 324 | list_del_init(&wq_entry->entry); |
1da177e4 LT |
325 | return ret; |
326 | } | |
327 | EXPORT_SYMBOL(autoremove_wake_function); | |
328 | ||
cb6538e7 PZ |
329 | static inline bool is_kthread_should_stop(void) |
330 | { | |
331 | return (current->flags & PF_KTHREAD) && kthread_should_stop(); | |
332 | } | |
61ada528 PZ |
333 | |
334 | /* | |
335 | * DEFINE_WAIT_FUNC(wait, woken_wake_func); | |
336 | * | |
9d9d676f | 337 | * add_wait_queue(&wq_head, &wait); |
61ada528 PZ |
338 | * for (;;) { |
339 | * if (condition) | |
340 | * break; | |
341 | * | |
342 | * p->state = mode; condition = true; | |
343 | * smp_mb(); // A smp_wmb(); // C | |
50816c48 | 344 | * if (!wq_entry->flags & WQ_FLAG_WOKEN) wq_entry->flags |= WQ_FLAG_WOKEN; |
61ada528 PZ |
345 | * schedule() try_to_wake_up(); |
346 | * p->state = TASK_RUNNING; ~~~~~~~~~~~~~~~~~~ | |
50816c48 | 347 | * wq_entry->flags &= ~WQ_FLAG_WOKEN; condition = true; |
61ada528 | 348 | * smp_mb() // B smp_wmb(); // C |
50816c48 | 349 | * wq_entry->flags |= WQ_FLAG_WOKEN; |
61ada528 | 350 | * } |
9d9d676f | 351 | * remove_wait_queue(&wq_head, &wait); |
61ada528 PZ |
352 | * |
353 | */ | |
50816c48 | 354 | long wait_woken(struct wait_queue_entry *wq_entry, unsigned mode, long timeout) |
61ada528 PZ |
355 | { |
356 | set_current_state(mode); /* A */ | |
357 | /* | |
358 | * The above implies an smp_mb(), which matches with the smp_wmb() from | |
359 | * woken_wake_function() such that if we observe WQ_FLAG_WOKEN we must | |
360 | * also observe all state before the wakeup. | |
361 | */ | |
50816c48 | 362 | if (!(wq_entry->flags & WQ_FLAG_WOKEN) && !is_kthread_should_stop()) |
61ada528 PZ |
363 | timeout = schedule_timeout(timeout); |
364 | __set_current_state(TASK_RUNNING); | |
365 | ||
366 | /* | |
367 | * The below implies an smp_mb(), it too pairs with the smp_wmb() from | |
368 | * woken_wake_function() such that we must either observe the wait | |
369 | * condition being true _OR_ WQ_FLAG_WOKEN such that we will not miss | |
370 | * an event. | |
371 | */ | |
50816c48 | 372 | smp_store_mb(wq_entry->flags, wq_entry->flags & ~WQ_FLAG_WOKEN); /* B */ |
61ada528 PZ |
373 | |
374 | return timeout; | |
375 | } | |
376 | EXPORT_SYMBOL(wait_woken); | |
377 | ||
50816c48 | 378 | int woken_wake_function(struct wait_queue_entry *wq_entry, unsigned mode, int sync, void *key) |
61ada528 PZ |
379 | { |
380 | /* | |
381 | * Although this function is called under waitqueue lock, LOCK | |
382 | * doesn't imply write barrier and the users expects write | |
383 | * barrier semantics on wakeup functions. The following | |
384 | * smp_wmb() is equivalent to smp_wmb() in try_to_wake_up() | |
b92b8b35 | 385 | * and is paired with smp_store_mb() in wait_woken(). |
61ada528 PZ |
386 | */ |
387 | smp_wmb(); /* C */ | |
50816c48 | 388 | wq_entry->flags |= WQ_FLAG_WOKEN; |
61ada528 | 389 | |
50816c48 | 390 | return default_wake_function(wq_entry, mode, sync, key); |
61ada528 PZ |
391 | } |
392 | EXPORT_SYMBOL(woken_wake_function); |