Rev 1757 | Rev 1787 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 1757 | Rev 1780 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (C) 2001-2004 Jakub Jermar |
2 | * Copyright (C) 2001-2004 Jakub Jermar |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
13 | * documentation and/or other materials provided with the distribution. |
14 | * - The name of the author may not be used to endorse or promote products |
14 | * - The name of the author may not be used to endorse or promote products |
15 | * derived from this software without specific prior written permission. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup sync |
29 | /** @addtogroup sync |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | 32 | ||
33 | /** |
33 | /** |
34 | * @file |
34 | * @file |
35 | * @brief Wait queue. |
35 | * @brief Wait queue. |
36 | * |
36 | * |
37 | * Wait queue is the basic synchronization primitive upon which all |
37 | * Wait queue is the basic synchronization primitive upon which all |
38 | * other synchronization primitives build. |
38 | * other synchronization primitives build. |
39 | * |
39 | * |
40 | * It allows threads to wait for an event in first-come, first-served |
40 | * It allows threads to wait for an event in first-come, first-served |
41 | * fashion. Conditional operation as well as timeouts and interruptions |
41 | * fashion. Conditional operation as well as timeouts and interruptions |
42 | * are supported. |
42 | * are supported. |
43 | */ |
43 | */ |
44 | 44 | ||
45 | #include <synch/waitq.h> |
45 | #include <synch/waitq.h> |
46 | #include <synch/synch.h> |
46 | #include <synch/synch.h> |
47 | #include <synch/spinlock.h> |
47 | #include <synch/spinlock.h> |
48 | #include <proc/thread.h> |
48 | #include <proc/thread.h> |
49 | #include <proc/scheduler.h> |
49 | #include <proc/scheduler.h> |
50 | #include <arch/asm.h> |
50 | #include <arch/asm.h> |
51 | #include <arch/types.h> |
51 | #include <arch/types.h> |
52 | #include <typedefs.h> |
52 | #include <typedefs.h> |
53 | #include <time/timeout.h> |
53 | #include <time/timeout.h> |
54 | #include <arch.h> |
54 | #include <arch.h> |
55 | #include <context.h> |
55 | #include <context.h> |
56 | #include <adt/list.h> |
56 | #include <adt/list.h> |
57 | 57 | ||
58 | static void waitq_timeouted_sleep(void *data); |
58 | static void waitq_timeouted_sleep(void *data); |
59 | 59 | ||
60 | /** Initialize wait queue |
60 | /** Initialize wait queue |
61 | * |
61 | * |
62 | * Initialize wait queue. |
62 | * Initialize wait queue. |
63 | * |
63 | * |
64 | * @param wq Pointer to wait queue to be initialized. |
64 | * @param wq Pointer to wait queue to be initialized. |
65 | */ |
65 | */ |
66 | void waitq_initialize(waitq_t *wq) |
66 | void waitq_initialize(waitq_t *wq) |
67 | { |
67 | { |
68 | spinlock_initialize(&wq->lock, "waitq_lock"); |
68 | spinlock_initialize(&wq->lock, "waitq_lock"); |
69 | list_initialize(&wq->head); |
69 | list_initialize(&wq->head); |
70 | wq->missed_wakeups = 0; |
70 | wq->missed_wakeups = 0; |
71 | } |
71 | } |
72 | 72 | ||
73 | /** Handle timeout during waitq_sleep_timeout() call |
73 | /** Handle timeout during waitq_sleep_timeout() call |
74 | * |
74 | * |
75 | * This routine is called when waitq_sleep_timeout() timeouts. |
75 | * This routine is called when waitq_sleep_timeout() timeouts. |
76 | * Interrupts are disabled. |
76 | * Interrupts are disabled. |
77 | * |
77 | * |
78 | * It is supposed to try to remove 'its' thread from the wait queue; |
78 | * It is supposed to try to remove 'its' thread from the wait queue; |
79 | * it can eventually fail to achieve this goal when these two events |
79 | * it can eventually fail to achieve this goal when these two events |
80 | * overlap. In that case it behaves just as though there was no |
80 | * overlap. In that case it behaves just as though there was no |
81 | * timeout at all. |
81 | * timeout at all. |
82 | * |
82 | * |
83 | * @param data Pointer to the thread that called waitq_sleep_timeout(). |
83 | * @param data Pointer to the thread that called waitq_sleep_timeout(). |
84 | */ |
84 | */ |
85 | void waitq_timeouted_sleep(void *data) |
85 | void waitq_timeouted_sleep(void *data) |
86 | { |
86 | { |
87 | thread_t *t = (thread_t *) data; |
87 | thread_t *t = (thread_t *) data; |
88 | waitq_t *wq; |
88 | waitq_t *wq; |
89 | bool do_wakeup = false; |
89 | bool do_wakeup = false; |
90 | 90 | ||
91 | spinlock_lock(&threads_lock); |
91 | spinlock_lock(&threads_lock); |
92 | if (!thread_exists(t)) |
92 | if (!thread_exists(t)) |
93 | goto out; |
93 | goto out; |
94 | 94 | ||
95 | grab_locks: |
95 | grab_locks: |
96 | spinlock_lock(&t->lock); |
96 | spinlock_lock(&t->lock); |
97 | if ((wq = t->sleep_queue)) { /* assignment */ |
97 | if ((wq = t->sleep_queue)) { /* assignment */ |
98 | if (!spinlock_trylock(&wq->lock)) { |
98 | if (!spinlock_trylock(&wq->lock)) { |
99 | spinlock_unlock(&t->lock); |
99 | spinlock_unlock(&t->lock); |
100 | goto grab_locks; /* avoid deadlock */ |
100 | goto grab_locks; /* avoid deadlock */ |
101 | } |
101 | } |
102 | 102 | ||
103 | list_remove(&t->wq_link); |
103 | list_remove(&t->wq_link); |
104 | t->saved_context = t->sleep_timeout_context; |
104 | t->saved_context = t->sleep_timeout_context; |
105 | do_wakeup = true; |
105 | do_wakeup = true; |
106 | t->sleep_queue = NULL; |
106 | t->sleep_queue = NULL; |
107 | spinlock_unlock(&wq->lock); |
107 | spinlock_unlock(&wq->lock); |
108 | } |
108 | } |
109 | 109 | ||
110 | t->timeout_pending = false; |
110 | t->timeout_pending = false; |
111 | spinlock_unlock(&t->lock); |
111 | spinlock_unlock(&t->lock); |
112 | 112 | ||
113 | if (do_wakeup) |
113 | if (do_wakeup) |
114 | thread_ready(t); |
114 | thread_ready(t); |
115 | 115 | ||
116 | out: |
116 | out: |
117 | spinlock_unlock(&threads_lock); |
117 | spinlock_unlock(&threads_lock); |
118 | } |
118 | } |
119 | 119 | ||
120 | /** Interrupt sleeping thread. |
120 | /** Interrupt sleeping thread. |
121 | * |
121 | * |
122 | * This routine attempts to interrupt a thread from its sleep in a waitqueue. |
122 | * This routine attempts to interrupt a thread from its sleep in a waitqueue. |
123 | * If the thread is not found sleeping, no action is taken. |
123 | * If the thread is not found sleeping, no action is taken. |
124 | * |
124 | * |
125 | * @param t Thread to be interrupted. |
125 | * @param t Thread to be interrupted. |
126 | */ |
126 | */ |
127 | void waitq_interrupt_sleep(thread_t *t) |
127 | void waitq_interrupt_sleep(thread_t *t) |
128 | { |
128 | { |
129 | waitq_t *wq; |
129 | waitq_t *wq; |
130 | bool do_wakeup = false; |
130 | bool do_wakeup = false; |
131 | ipl_t ipl; |
131 | ipl_t ipl; |
132 | 132 | ||
133 | ipl = interrupts_disable(); |
133 | ipl = interrupts_disable(); |
134 | spinlock_lock(&threads_lock); |
134 | spinlock_lock(&threads_lock); |
135 | if (!thread_exists(t)) |
135 | if (!thread_exists(t)) |
136 | goto out; |
136 | goto out; |
137 | 137 | ||
138 | grab_locks: |
138 | grab_locks: |
139 | spinlock_lock(&t->lock); |
139 | spinlock_lock(&t->lock); |
140 | if ((wq = t->sleep_queue)) { /* assignment */ |
140 | if ((wq = t->sleep_queue)) { /* assignment */ |
141 | if (!(t->sleep_interruptible)) { |
141 | if (!(t->sleep_interruptible)) { |
142 | /* |
142 | /* |
143 | * The sleep cannot be interrupted. |
143 | * The sleep cannot be interrupted. |
144 | */ |
144 | */ |
145 | spinlock_unlock(&t->lock); |
145 | spinlock_unlock(&t->lock); |
146 | goto out; |
146 | goto out; |
147 | } |
147 | } |
148 | 148 | ||
149 | if (!spinlock_trylock(&wq->lock)) { |
149 | if (!spinlock_trylock(&wq->lock)) { |
150 | spinlock_unlock(&t->lock); |
150 | spinlock_unlock(&t->lock); |
151 | goto grab_locks; /* avoid deadlock */ |
151 | goto grab_locks; /* avoid deadlock */ |
152 | } |
152 | } |
153 | 153 | ||
154 | if (t->timeout_pending && timeout_unregister(&t->sleep_timeout)) |
154 | if (t->timeout_pending && timeout_unregister(&t->sleep_timeout)) |
155 | t->timeout_pending = false; |
155 | t->timeout_pending = false; |
156 | 156 | ||
157 | list_remove(&t->wq_link); |
157 | list_remove(&t->wq_link); |
158 | t->saved_context = t->sleep_interruption_context; |
158 | t->saved_context = t->sleep_interruption_context; |
159 | do_wakeup = true; |
159 | do_wakeup = true; |
160 | t->sleep_queue = NULL; |
160 | t->sleep_queue = NULL; |
161 | spinlock_unlock(&wq->lock); |
161 | spinlock_unlock(&wq->lock); |
162 | } |
162 | } |
163 | spinlock_unlock(&t->lock); |
163 | spinlock_unlock(&t->lock); |
164 | 164 | ||
165 | if (do_wakeup) |
165 | if (do_wakeup) |
166 | thread_ready(t); |
166 | thread_ready(t); |
167 | 167 | ||
168 | out: |
168 | out: |
169 | spinlock_unlock(&threads_lock); |
169 | spinlock_unlock(&threads_lock); |
170 | interrupts_restore(ipl); |
170 | interrupts_restore(ipl); |
171 | } |
171 | } |
172 | 172 | ||
173 | /** Sleep until either wakeup, timeout or interruption occurs |
173 | /** Sleep until either wakeup, timeout or interruption occurs |
174 | * |
174 | * |
175 | * This is a sleep implementation which allows itself to time out or to be |
175 | * This is a sleep implementation which allows itself to time out or to be |
176 | * interrupted from the sleep, restoring a failover context. |
176 | * interrupted from the sleep, restoring a failover context. |
177 | * |
177 | * |
178 | * Sleepers are organised in a FIFO fashion in a structure called wait queue. |
178 | * Sleepers are organised in a FIFO fashion in a structure called wait queue. |
179 | * |
179 | * |
180 | * This function is really basic in that other functions as waitq_sleep() |
180 | * This function is really basic in that other functions as waitq_sleep() |
181 | * and all the *_timeout() functions use it. |
181 | * and all the *_timeout() functions use it. |
182 | * |
182 | * |
183 | * @param wq Pointer to wait queue. |
183 | * @param wq Pointer to wait queue. |
184 | * @param usec Timeout in microseconds. |
184 | * @param usec Timeout in microseconds. |
185 | * @param flags Specify mode of the sleep. |
185 | * @param flags Specify mode of the sleep. |
186 | * |
186 | * |
187 | * The sleep can be interrupted only if the |
187 | * The sleep can be interrupted only if the |
188 | * SYNCH_FLAGS_INTERRUPTIBLE bit is specified in flags. |
188 | * SYNCH_FLAGS_INTERRUPTIBLE bit is specified in flags. |
189 | |
189 | |
190 | * If usec is greater than zero, regardless of the value of the |
190 | * If usec is greater than zero, regardless of the value of the |
191 | * SYNCH_FLAGS_NON_BLOCKING bit in flags, the call will not return until either timeout, |
191 | * SYNCH_FLAGS_NON_BLOCKING bit in flags, the call will not return until either timeout, |
192 | * interruption or wakeup comes. |
192 | * interruption or wakeup comes. |
193 | * |
193 | * |
194 | * If usec is zero and the SYNCH_FLAGS_NON_BLOCKING bit is not set in flags, the call |
194 | * If usec is zero and the SYNCH_FLAGS_NON_BLOCKING bit is not set in flags, the call |
195 | * will not return until wakeup or interruption comes. |
195 | * will not return until wakeup or interruption comes. |
196 | * |
196 | * |
197 | * If usec is zero and the SYNCH_FLAGS_NON_BLOCKING bit is set in flags, the call will |
197 | * If usec is zero and the SYNCH_FLAGS_NON_BLOCKING bit is set in flags, the call will |
198 | * immediately return, reporting either success or failure. |
198 | * immediately return, reporting either success or failure. |
199 | * |
199 | * |
200 | * @return Returns one of: ESYNCH_WOULD_BLOCK, ESYNCH_TIMEOUT, ESYNCH_INTERRUPTED, |
200 | * @return Returns one of: ESYNCH_WOULD_BLOCK, ESYNCH_TIMEOUT, ESYNCH_INTERRUPTED, |
201 | * ESYNCH_OK_ATOMIC, ESYNCH_OK_BLOCKED. |
201 | * ESYNCH_OK_ATOMIC, ESYNCH_OK_BLOCKED. |
202 | * |
202 | * |
203 | * @li ESYNCH_WOULD_BLOCK means that the sleep failed because at the time |
203 | * @li ESYNCH_WOULD_BLOCK means that the sleep failed because at the time |
204 | * of the call there was no pending wakeup. |
204 | * of the call there was no pending wakeup. |
205 | * |
205 | * |
206 | * @li ESYNCH_TIMEOUT means that the sleep timed out. |
206 | * @li ESYNCH_TIMEOUT means that the sleep timed out. |
207 | * |
207 | * |
208 | * @li ESYNCH_INTERRUPTED means that somebody interrupted the sleeping thread. |
208 | * @li ESYNCH_INTERRUPTED means that somebody interrupted the sleeping thread. |
209 | * |
209 | * |
210 | * @li ESYNCH_OK_ATOMIC means that the sleep succeeded and that there was |
210 | * @li ESYNCH_OK_ATOMIC means that the sleep succeeded and that there was |
211 | * a pending wakeup at the time of the call. The caller was not put |
211 | * a pending wakeup at the time of the call. The caller was not put |
212 | * asleep at all. |
212 | * asleep at all. |
213 | * |
213 | * |
214 | * @li ESYNCH_OK_BLOCKED means that the sleep succeeded; the full sleep was |
214 | * @li ESYNCH_OK_BLOCKED means that the sleep succeeded; the full sleep was |
215 | * attempted. |
215 | * attempted. |
216 | */ |
216 | */ |
217 | int waitq_sleep_timeout(waitq_t *wq, __u32 usec, int flags) |
217 | int waitq_sleep_timeout(waitq_t *wq, uint32_t usec, int flags) |
218 | { |
218 | { |
219 | ipl_t ipl; |
219 | ipl_t ipl; |
220 | int rc; |
220 | int rc; |
221 | 221 | ||
222 | ipl = waitq_sleep_prepare(wq); |
222 | ipl = waitq_sleep_prepare(wq); |
223 | rc = waitq_sleep_timeout_unsafe(wq, usec, flags); |
223 | rc = waitq_sleep_timeout_unsafe(wq, usec, flags); |
224 | waitq_sleep_finish(wq, rc, ipl); |
224 | waitq_sleep_finish(wq, rc, ipl); |
225 | return rc; |
225 | return rc; |
226 | } |
226 | } |
227 | 227 | ||
228 | /** Prepare to sleep in a waitq. |
228 | /** Prepare to sleep in a waitq. |
229 | * |
229 | * |
230 | * This function will return holding the lock of the wait queue |
230 | * This function will return holding the lock of the wait queue |
231 | * and interrupts disabled. |
231 | * and interrupts disabled. |
232 | * |
232 | * |
233 | * @param wq Wait queue. |
233 | * @param wq Wait queue. |
234 | * |
234 | * |
235 | * @return Interrupt level as it existed on entry to this function. |
235 | * @return Interrupt level as it existed on entry to this function. |
236 | */ |
236 | */ |
237 | ipl_t waitq_sleep_prepare(waitq_t *wq) |
237 | ipl_t waitq_sleep_prepare(waitq_t *wq) |
238 | { |
238 | { |
239 | ipl_t ipl; |
239 | ipl_t ipl; |
240 | 240 | ||
241 | restart: |
241 | restart: |
242 | ipl = interrupts_disable(); |
242 | ipl = interrupts_disable(); |
243 | 243 | ||
244 | if (THREAD) { /* needed during system initiailzation */ |
244 | if (THREAD) { /* needed during system initiailzation */ |
245 | /* |
245 | /* |
246 | * Busy waiting for a delayed timeout. |
246 | * Busy waiting for a delayed timeout. |
247 | * This is an important fix for the race condition between |
247 | * This is an important fix for the race condition between |
248 | * a delayed timeout and a next call to waitq_sleep_timeout(). |
248 | * a delayed timeout and a next call to waitq_sleep_timeout(). |
249 | * Simply, the thread is not allowed to go to sleep if |
249 | * Simply, the thread is not allowed to go to sleep if |
250 | * there are timeouts in progress. |
250 | * there are timeouts in progress. |
251 | */ |
251 | */ |
252 | spinlock_lock(&THREAD->lock); |
252 | spinlock_lock(&THREAD->lock); |
253 | if (THREAD->timeout_pending) { |
253 | if (THREAD->timeout_pending) { |
254 | spinlock_unlock(&THREAD->lock); |
254 | spinlock_unlock(&THREAD->lock); |
255 | interrupts_restore(ipl); |
255 | interrupts_restore(ipl); |
256 | goto restart; |
256 | goto restart; |
257 | } |
257 | } |
258 | spinlock_unlock(&THREAD->lock); |
258 | spinlock_unlock(&THREAD->lock); |
259 | } |
259 | } |
260 | 260 | ||
261 | spinlock_lock(&wq->lock); |
261 | spinlock_lock(&wq->lock); |
262 | return ipl; |
262 | return ipl; |
263 | } |
263 | } |
264 | 264 | ||
265 | /** Finish waiting in a wait queue. |
265 | /** Finish waiting in a wait queue. |
266 | * |
266 | * |
267 | * This function restores interrupts to the state that existed prior |
267 | * This function restores interrupts to the state that existed prior |
268 | * to the call to waitq_sleep_prepare(). If necessary, the wait queue |
268 | * to the call to waitq_sleep_prepare(). If necessary, the wait queue |
269 | * lock is released. |
269 | * lock is released. |
270 | * |
270 | * |
271 | * @param wq Wait queue. |
271 | * @param wq Wait queue. |
272 | * @param rc Return code of waitq_sleep_timeout_unsafe(). |
272 | * @param rc Return code of waitq_sleep_timeout_unsafe(). |
273 | * @param ipl Interrupt level returned by waitq_sleep_prepare(). |
273 | * @param ipl Interrupt level returned by waitq_sleep_prepare(). |
274 | */ |
274 | */ |
275 | void waitq_sleep_finish(waitq_t *wq, int rc, ipl_t ipl) |
275 | void waitq_sleep_finish(waitq_t *wq, int rc, ipl_t ipl) |
276 | { |
276 | { |
277 | switch (rc) { |
277 | switch (rc) { |
278 | case ESYNCH_WOULD_BLOCK: |
278 | case ESYNCH_WOULD_BLOCK: |
279 | case ESYNCH_OK_ATOMIC: |
279 | case ESYNCH_OK_ATOMIC: |
280 | spinlock_unlock(&wq->lock); |
280 | spinlock_unlock(&wq->lock); |
281 | break; |
281 | break; |
282 | default: |
282 | default: |
283 | break; |
283 | break; |
284 | } |
284 | } |
285 | interrupts_restore(ipl); |
285 | interrupts_restore(ipl); |
286 | } |
286 | } |
287 | 287 | ||
288 | /** Internal implementation of waitq_sleep_timeout(). |
288 | /** Internal implementation of waitq_sleep_timeout(). |
289 | * |
289 | * |
290 | * This function implements logic of sleeping in a wait queue. |
290 | * This function implements logic of sleeping in a wait queue. |
291 | * This call must be preceeded by a call to waitq_sleep_prepare() |
291 | * This call must be preceeded by a call to waitq_sleep_prepare() |
292 | * and followed by a call to waitq_slee_finish(). |
292 | * and followed by a call to waitq_slee_finish(). |
293 | * |
293 | * |
294 | * @param wq See waitq_sleep_timeout(). |
294 | * @param wq See waitq_sleep_timeout(). |
295 | * @param usec See waitq_sleep_timeout(). |
295 | * @param usec See waitq_sleep_timeout(). |
296 | * @param flags See waitq_sleep_timeout(). |
296 | * @param flags See waitq_sleep_timeout(). |
297 | * |
297 | * |
298 | * @return See waitq_sleep_timeout(). |
298 | * @return See waitq_sleep_timeout(). |
299 | */ |
299 | */ |
300 | int waitq_sleep_timeout_unsafe(waitq_t *wq, __u32 usec, int flags) |
300 | int waitq_sleep_timeout_unsafe(waitq_t *wq, uint32_t usec, int flags) |
301 | { |
301 | { |
302 | /* checks whether to go to sleep at all */ |
302 | /* checks whether to go to sleep at all */ |
303 | if (wq->missed_wakeups) { |
303 | if (wq->missed_wakeups) { |
304 | wq->missed_wakeups--; |
304 | wq->missed_wakeups--; |
305 | return ESYNCH_OK_ATOMIC; |
305 | return ESYNCH_OK_ATOMIC; |
306 | } |
306 | } |
307 | else { |
307 | else { |
308 | if ((flags & SYNCH_FLAGS_NON_BLOCKING) && (usec == 0)) { |
308 | if ((flags & SYNCH_FLAGS_NON_BLOCKING) && (usec == 0)) { |
309 | /* return immediatelly instead of going to sleep */ |
309 | /* return immediatelly instead of going to sleep */ |
310 | return ESYNCH_WOULD_BLOCK; |
310 | return ESYNCH_WOULD_BLOCK; |
311 | } |
311 | } |
312 | } |
312 | } |
313 | 313 | ||
314 | /* |
314 | /* |
315 | * Now we are firmly decided to go to sleep. |
315 | * Now we are firmly decided to go to sleep. |
316 | */ |
316 | */ |
317 | spinlock_lock(&THREAD->lock); |
317 | spinlock_lock(&THREAD->lock); |
318 | 318 | ||
319 | if (flags & SYNCH_FLAGS_INTERRUPTIBLE) { |
319 | if (flags & SYNCH_FLAGS_INTERRUPTIBLE) { |
320 | 320 | ||
321 | /* |
321 | /* |
322 | * If the thread was already interrupted, |
322 | * If the thread was already interrupted, |
323 | * don't go to sleep at all. |
323 | * don't go to sleep at all. |
324 | */ |
324 | */ |
325 | if (THREAD->interrupted) { |
325 | if (THREAD->interrupted) { |
326 | spinlock_unlock(&THREAD->lock); |
326 | spinlock_unlock(&THREAD->lock); |
327 | spinlock_unlock(&wq->lock); |
327 | spinlock_unlock(&wq->lock); |
328 | return ESYNCH_INTERRUPTED; |
328 | return ESYNCH_INTERRUPTED; |
329 | } |
329 | } |
330 | 330 | ||
331 | /* |
331 | /* |
332 | * Set context that will be restored if the sleep |
332 | * Set context that will be restored if the sleep |
333 | * of this thread is ever interrupted. |
333 | * of this thread is ever interrupted. |
334 | */ |
334 | */ |
335 | THREAD->sleep_interruptible = true; |
335 | THREAD->sleep_interruptible = true; |
336 | if (!context_save(&THREAD->sleep_interruption_context)) { |
336 | if (!context_save(&THREAD->sleep_interruption_context)) { |
337 | /* Short emulation of scheduler() return code. */ |
337 | /* Short emulation of scheduler() return code. */ |
338 | spinlock_unlock(&THREAD->lock); |
338 | spinlock_unlock(&THREAD->lock); |
339 | return ESYNCH_INTERRUPTED; |
339 | return ESYNCH_INTERRUPTED; |
340 | } |
340 | } |
341 | 341 | ||
342 | } else { |
342 | } else { |
343 | THREAD->sleep_interruptible = false; |
343 | THREAD->sleep_interruptible = false; |
344 | } |
344 | } |
345 | 345 | ||
346 | if (usec) { |
346 | if (usec) { |
347 | /* We use the timeout variant. */ |
347 | /* We use the timeout variant. */ |
348 | if (!context_save(&THREAD->sleep_timeout_context)) { |
348 | if (!context_save(&THREAD->sleep_timeout_context)) { |
349 | /* Short emulation of scheduler() return code. */ |
349 | /* Short emulation of scheduler() return code. */ |
350 | spinlock_unlock(&THREAD->lock); |
350 | spinlock_unlock(&THREAD->lock); |
351 | return ESYNCH_TIMEOUT; |
351 | return ESYNCH_TIMEOUT; |
352 | } |
352 | } |
353 | THREAD->timeout_pending = true; |
353 | THREAD->timeout_pending = true; |
354 | timeout_register(&THREAD->sleep_timeout, (__u64) usec, waitq_timeouted_sleep, THREAD); |
354 | timeout_register(&THREAD->sleep_timeout, (uint64_t) usec, waitq_timeouted_sleep, THREAD); |
355 | } |
355 | } |
356 | 356 | ||
357 | list_append(&THREAD->wq_link, &wq->head); |
357 | list_append(&THREAD->wq_link, &wq->head); |
358 | 358 | ||
359 | /* |
359 | /* |
360 | * Suspend execution. |
360 | * Suspend execution. |
361 | */ |
361 | */ |
362 | THREAD->state = Sleeping; |
362 | THREAD->state = Sleeping; |
363 | THREAD->sleep_queue = wq; |
363 | THREAD->sleep_queue = wq; |
364 | 364 | ||
365 | spinlock_unlock(&THREAD->lock); |
365 | spinlock_unlock(&THREAD->lock); |
366 | 366 | ||
367 | scheduler(); /* wq->lock is released in scheduler_separated_stack() */ |
367 | scheduler(); /* wq->lock is released in scheduler_separated_stack() */ |
368 | 368 | ||
369 | return ESYNCH_OK_BLOCKED; |
369 | return ESYNCH_OK_BLOCKED; |
370 | } |
370 | } |
371 | 371 | ||
372 | 372 | ||
373 | /** Wake up first thread sleeping in a wait queue |
373 | /** Wake up first thread sleeping in a wait queue |
374 | * |
374 | * |
375 | * Wake up first thread sleeping in a wait queue. |
375 | * Wake up first thread sleeping in a wait queue. |
376 | * This is the SMP- and IRQ-safe wrapper meant for |
376 | * This is the SMP- and IRQ-safe wrapper meant for |
377 | * general use. |
377 | * general use. |
378 | * |
378 | * |
379 | * Besides its 'normal' wakeup operation, it attempts |
379 | * Besides its 'normal' wakeup operation, it attempts |
380 | * to unregister possible timeout. |
380 | * to unregister possible timeout. |
381 | * |
381 | * |
382 | * @param wq Pointer to wait queue. |
382 | * @param wq Pointer to wait queue. |
383 | * @param all If this is non-zero, all sleeping threads |
383 | * @param all If this is non-zero, all sleeping threads |
384 | * will be woken up and missed count will be zeroed. |
384 | * will be woken up and missed count will be zeroed. |
385 | */ |
385 | */ |
386 | void waitq_wakeup(waitq_t *wq, bool all) |
386 | void waitq_wakeup(waitq_t *wq, bool all) |
387 | { |
387 | { |
388 | ipl_t ipl; |
388 | ipl_t ipl; |
389 | 389 | ||
390 | ipl = interrupts_disable(); |
390 | ipl = interrupts_disable(); |
391 | spinlock_lock(&wq->lock); |
391 | spinlock_lock(&wq->lock); |
392 | 392 | ||
393 | _waitq_wakeup_unsafe(wq, all); |
393 | _waitq_wakeup_unsafe(wq, all); |
394 | 394 | ||
395 | spinlock_unlock(&wq->lock); |
395 | spinlock_unlock(&wq->lock); |
396 | interrupts_restore(ipl); |
396 | interrupts_restore(ipl); |
397 | } |
397 | } |
398 | 398 | ||
399 | /** Internal SMP- and IRQ-unsafe version of waitq_wakeup() |
399 | /** Internal SMP- and IRQ-unsafe version of waitq_wakeup() |
400 | * |
400 | * |
401 | * This is the internal SMP- and IRQ-unsafe version |
401 | * This is the internal SMP- and IRQ-unsafe version |
402 | * of waitq_wakeup(). It assumes wq->lock is already |
402 | * of waitq_wakeup(). It assumes wq->lock is already |
403 | * locked and interrupts are already disabled. |
403 | * locked and interrupts are already disabled. |
404 | * |
404 | * |
405 | * @param wq Pointer to wait queue. |
405 | * @param wq Pointer to wait queue. |
406 | * @param all If this is non-zero, all sleeping threads |
406 | * @param all If this is non-zero, all sleeping threads |
407 | * will be woken up and missed count will be zeroed. |
407 | * will be woken up and missed count will be zeroed. |
408 | */ |
408 | */ |
409 | void _waitq_wakeup_unsafe(waitq_t *wq, bool all) |
409 | void _waitq_wakeup_unsafe(waitq_t *wq, bool all) |
410 | { |
410 | { |
411 | thread_t *t; |
411 | thread_t *t; |
412 | 412 | ||
413 | loop: |
413 | loop: |
414 | if (list_empty(&wq->head)) { |
414 | if (list_empty(&wq->head)) { |
415 | wq->missed_wakeups++; |
415 | wq->missed_wakeups++; |
416 | if (all) |
416 | if (all) |
417 | wq->missed_wakeups = 0; |
417 | wq->missed_wakeups = 0; |
418 | return; |
418 | return; |
419 | } |
419 | } |
420 | 420 | ||
421 | t = list_get_instance(wq->head.next, thread_t, wq_link); |
421 | t = list_get_instance(wq->head.next, thread_t, wq_link); |
422 | 422 | ||
423 | /* |
423 | /* |
424 | * Lock the thread prior to removing it from the wq. |
424 | * Lock the thread prior to removing it from the wq. |
425 | * This is not necessary because of mutual exclusion |
425 | * This is not necessary because of mutual exclusion |
426 | * (the link belongs to the wait queue), but because |
426 | * (the link belongs to the wait queue), but because |
427 | * of synchronization with waitq_timeouted_sleep() |
427 | * of synchronization with waitq_timeouted_sleep() |
428 | * and waitq_interrupt_sleep(). |
428 | * and waitq_interrupt_sleep(). |
429 | * |
429 | * |
430 | * In order for these two functions to work, the following |
430 | * In order for these two functions to work, the following |
431 | * invariant must hold: |
431 | * invariant must hold: |
432 | * |
432 | * |
433 | * t->sleep_queue != NULL <=> t sleeps in a wait queue |
433 | * t->sleep_queue != NULL <=> t sleeps in a wait queue |
434 | * |
434 | * |
435 | * For an observer who locks the thread, the invariant |
435 | * For an observer who locks the thread, the invariant |
436 | * holds only when the lock is held prior to removing |
436 | * holds only when the lock is held prior to removing |
437 | * it from the wait queue. |
437 | * it from the wait queue. |
438 | */ |
438 | */ |
439 | spinlock_lock(&t->lock); |
439 | spinlock_lock(&t->lock); |
440 | list_remove(&t->wq_link); |
440 | list_remove(&t->wq_link); |
441 | 441 | ||
442 | if (t->timeout_pending && timeout_unregister(&t->sleep_timeout)) |
442 | if (t->timeout_pending && timeout_unregister(&t->sleep_timeout)) |
443 | t->timeout_pending = false; |
443 | t->timeout_pending = false; |
444 | t->sleep_queue = NULL; |
444 | t->sleep_queue = NULL; |
445 | spinlock_unlock(&t->lock); |
445 | spinlock_unlock(&t->lock); |
446 | 446 | ||
447 | thread_ready(t); |
447 | thread_ready(t); |
448 | 448 | ||
449 | if (all) |
449 | if (all) |
450 | goto loop; |
450 | goto loop; |
451 | } |
451 | } |
452 | 452 | ||
453 | /** @} |
453 | /** @} |
454 | */ |
454 | */ |
455 | 455 |