2 * coroutine queues and locks
4 * Copyright (c) 2011 Kevin Wolf <kwolf@redhat.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * The lock-free mutex implementation is based on OSv
25 * (core/lfmutex.cc, include/lockfree/mutex.hh).
26 * Copyright (C) 2013 Cloudius Systems, Ltd.
29 #include "qemu/osdep.h"
30 #include "qemu/coroutine.h"
31 #include "qemu/coroutine_int.h"
32 #include "qemu/processor.h"
33 #include "qemu/queue.h"
34 #include "block/aio.h"
37 void qemu_co_queue_init(CoQueue *queue)
39 QSIMPLEQ_INIT(&queue->entries);
42 void coroutine_fn qemu_co_queue_wait_impl(CoQueue *queue, QemuLockable *lock)
44 Coroutine *self = qemu_coroutine_self();
45 QSIMPLEQ_INSERT_TAIL(&queue->entries, self, co_queue_next);
48 qemu_lockable_unlock(lock);
51 /* There is no race condition here. Other threads will call
52 * aio_co_schedule on our AioContext, which can reenter this
53 * coroutine but only after this yield and after the main loop
54 * has gone through the next iteration.
56 qemu_coroutine_yield();
57 assert(qemu_in_coroutine());
59 /* TODO: OSv implements wait morphing here, where the wakeup
60 * primitive automatically places the woken coroutine on the
61 * mutex's queue. This avoids the thundering herd effect.
62 * This could be implemented for CoMutexes, but not really for
63 * other cases of QemuLockable.
66 qemu_lockable_lock(lock);
70 static bool qemu_co_queue_do_restart(CoQueue *queue, bool single)
74 if (QSIMPLEQ_EMPTY(&queue->entries)) {
78 while ((next = QSIMPLEQ_FIRST(&queue->entries)) != NULL) {
79 QSIMPLEQ_REMOVE_HEAD(&queue->entries, co_queue_next);
88 bool qemu_co_queue_next(CoQueue *queue)
90 return qemu_co_queue_do_restart(queue, true);
93 void qemu_co_queue_restart_all(CoQueue *queue)
95 qemu_co_queue_do_restart(queue, false);
98 bool qemu_co_enter_next_impl(CoQueue *queue, QemuLockable *lock)
102 next = QSIMPLEQ_FIRST(&queue->entries);
107 QSIMPLEQ_REMOVE_HEAD(&queue->entries, co_queue_next);
109 qemu_lockable_unlock(lock);
113 qemu_lockable_lock(lock);
118 bool qemu_co_queue_empty(CoQueue *queue)
120 return QSIMPLEQ_FIRST(&queue->entries) == NULL;
123 /* The wait records are handled with a multiple-producer, single-consumer
124 * lock-free queue. There cannot be two concurrent pop_waiter() calls
125 * because pop_waiter() can only be called while mutex->handoff is zero.
126 * This can happen in three cases:
127 * - in qemu_co_mutex_unlock, before the hand-off protocol has started.
128 * In this case, qemu_co_mutex_lock will see mutex->handoff == 0 and
129 * not take part in the handoff.
130 * - in qemu_co_mutex_lock, if it steals the hand-off responsibility from
131 * qemu_co_mutex_unlock. In this case, qemu_co_mutex_unlock will fail
132 * the cmpxchg (it will see either 0 or the next sequence value) and
133 * exit. The next hand-off cannot begin until qemu_co_mutex_lock has
135 * - in qemu_co_mutex_unlock, if it takes the hand-off token itself.
136 * In this case another iteration starts with mutex->handoff == 0;
137 * a concurrent qemu_co_mutex_lock will fail the cmpxchg, and
138 * qemu_co_mutex_unlock will go back to case (1).
140 * The following functions manage this queue.
142 typedef struct CoWaitRecord {
144 QSLIST_ENTRY(CoWaitRecord) next;
147 static void push_waiter(CoMutex *mutex, CoWaitRecord *w)
149 w->co = qemu_coroutine_self();
150 QSLIST_INSERT_HEAD_ATOMIC(&mutex->from_push, w, next);
153 static void move_waiters(CoMutex *mutex)
155 QSLIST_HEAD(, CoWaitRecord) reversed;
156 QSLIST_MOVE_ATOMIC(&reversed, &mutex->from_push);
157 while (!QSLIST_EMPTY(&reversed)) {
158 CoWaitRecord *w = QSLIST_FIRST(&reversed);
159 QSLIST_REMOVE_HEAD(&reversed, next);
160 QSLIST_INSERT_HEAD(&mutex->to_pop, w, next);
164 static CoWaitRecord *pop_waiter(CoMutex *mutex)
168 if (QSLIST_EMPTY(&mutex->to_pop)) {
170 if (QSLIST_EMPTY(&mutex->to_pop)) {
174 w = QSLIST_FIRST(&mutex->to_pop);
175 QSLIST_REMOVE_HEAD(&mutex->to_pop, next);
179 static bool has_waiters(CoMutex *mutex)
181 return QSLIST_EMPTY(&mutex->to_pop) || QSLIST_EMPTY(&mutex->from_push);
184 void qemu_co_mutex_init(CoMutex *mutex)
186 memset(mutex, 0, sizeof(*mutex));
189 static void coroutine_fn qemu_co_mutex_wake(CoMutex *mutex, Coroutine *co)
191 /* Read co before co->ctx; pairs with smp_wmb() in
192 * qemu_coroutine_enter().
194 smp_read_barrier_depends();
195 mutex->ctx = co->ctx;
199 static void coroutine_fn qemu_co_mutex_lock_slowpath(AioContext *ctx,
202 Coroutine *self = qemu_coroutine_self();
204 unsigned old_handoff;
206 trace_qemu_co_mutex_lock_entry(mutex, self);
208 push_waiter(mutex, &w);
210 /* This is the "Responsibility Hand-Off" protocol; a lock() picks from
211 * a concurrent unlock() the responsibility of waking somebody up.
213 old_handoff = qatomic_mb_read(&mutex->handoff);
215 has_waiters(mutex) &&
216 qatomic_cmpxchg(&mutex->handoff, old_handoff, 0) == old_handoff) {
217 /* There can be no concurrent pops, because there can be only
218 * one active handoff at a time.
220 CoWaitRecord *to_wake = pop_waiter(mutex);
221 Coroutine *co = to_wake->co;
223 /* We got the lock ourselves! */
224 assert(to_wake == &w);
229 qemu_co_mutex_wake(mutex, co);
232 qemu_coroutine_yield();
233 trace_qemu_co_mutex_lock_return(mutex, self);
236 void coroutine_fn qemu_co_mutex_lock(CoMutex *mutex)
238 AioContext *ctx = qemu_get_current_aio_context();
239 Coroutine *self = qemu_coroutine_self();
242 /* Running a very small critical section on pthread_mutex_t and CoMutex
243 * shows that pthread_mutex_t is much faster because it doesn't actually
244 * go to sleep. What happens is that the critical section is shorter
245 * than the latency of entering the kernel and thus FUTEX_WAIT always
246 * fails. With CoMutex there is no such latency but you still want to
247 * avoid wait and wakeup. So introduce it artificially.
251 waiters = qatomic_cmpxchg(&mutex->locked, 0, 1);
253 while (waiters == 1 && ++i < 1000) {
254 if (qatomic_read(&mutex->ctx) == ctx) {
257 if (qatomic_read(&mutex->locked) == 0) {
258 goto retry_fast_path;
262 waiters = qatomic_fetch_inc(&mutex->locked);
267 trace_qemu_co_mutex_lock_uncontended(mutex, self);
270 qemu_co_mutex_lock_slowpath(ctx, mutex);
272 mutex->holder = self;
276 void coroutine_fn qemu_co_mutex_unlock(CoMutex *mutex)
278 Coroutine *self = qemu_coroutine_self();
280 trace_qemu_co_mutex_unlock_entry(mutex, self);
282 assert(mutex->locked);
283 assert(mutex->holder == self);
284 assert(qemu_in_coroutine());
287 mutex->holder = NULL;
289 if (qatomic_fetch_dec(&mutex->locked) == 1) {
290 /* No waiting qemu_co_mutex_lock(). Pfew, that was easy! */
295 CoWaitRecord *to_wake = pop_waiter(mutex);
296 unsigned our_handoff;
299 qemu_co_mutex_wake(mutex, to_wake->co);
303 /* Some concurrent lock() is in progress (we know this because
304 * mutex->locked was >1) but it hasn't yet put itself on the wait
305 * queue. Pick a sequence number for the handoff protocol (not 0).
307 if (++mutex->sequence == 0) {
311 our_handoff = mutex->sequence;
312 qatomic_mb_set(&mutex->handoff, our_handoff);
313 if (!has_waiters(mutex)) {
314 /* The concurrent lock has not added itself yet, so it
315 * will be able to pick our handoff.
320 /* Try to do the handoff protocol ourselves; if somebody else has
321 * already taken it, however, we're done and they're responsible.
323 if (qatomic_cmpxchg(&mutex->handoff, our_handoff, 0) != our_handoff) {
328 trace_qemu_co_mutex_unlock_return(mutex, self);
331 void qemu_co_rwlock_init(CoRwlock *lock)
333 memset(lock, 0, sizeof(*lock));
334 qemu_co_queue_init(&lock->queue);
335 qemu_co_mutex_init(&lock->mutex);
338 void qemu_co_rwlock_rdlock(CoRwlock *lock)
340 Coroutine *self = qemu_coroutine_self();
342 qemu_co_mutex_lock(&lock->mutex);
343 /* For fairness, wait if a writer is in line. */
344 while (lock->pending_writer) {
345 qemu_co_queue_wait(&lock->queue, &lock->mutex);
348 qemu_co_mutex_unlock(&lock->mutex);
350 /* The rest of the read-side critical section is run without the mutex. */
354 void qemu_co_rwlock_unlock(CoRwlock *lock)
356 Coroutine *self = qemu_coroutine_self();
358 assert(qemu_in_coroutine());
360 /* The critical section started in qemu_co_rwlock_wrlock. */
361 qemu_co_queue_restart_all(&lock->queue);
365 qemu_co_mutex_lock(&lock->mutex);
367 assert(lock->reader >= 0);
368 /* Wakeup only one waiting writer */
370 qemu_co_queue_next(&lock->queue);
373 qemu_co_mutex_unlock(&lock->mutex);
376 void qemu_co_rwlock_downgrade(CoRwlock *lock)
378 Coroutine *self = qemu_coroutine_self();
380 /* lock->mutex critical section started in qemu_co_rwlock_wrlock or
381 * qemu_co_rwlock_upgrade.
383 assert(lock->reader == 0);
385 qemu_co_mutex_unlock(&lock->mutex);
387 /* The rest of the read-side critical section is run without the mutex. */
391 void qemu_co_rwlock_wrlock(CoRwlock *lock)
393 qemu_co_mutex_lock(&lock->mutex);
394 lock->pending_writer++;
395 while (lock->reader) {
396 qemu_co_queue_wait(&lock->queue, &lock->mutex);
398 lock->pending_writer--;
400 /* The rest of the write-side critical section is run with
401 * the mutex taken, so that lock->reader remains zero.
402 * There is no need to update self->locks_held.
406 void qemu_co_rwlock_upgrade(CoRwlock *lock)
408 Coroutine *self = qemu_coroutine_self();
410 qemu_co_mutex_lock(&lock->mutex);
411 assert(lock->reader > 0);
413 lock->pending_writer++;
414 while (lock->reader) {
415 qemu_co_queue_wait(&lock->queue, &lock->mutex);
417 lock->pending_writer--;
419 /* The rest of the write-side critical section is run with
420 * the mutex taken, similar to qemu_co_rwlock_wrlock. Do
421 * not account for the lock twice in self->locks_held.