diff mbox

[2/3] coroutine: Clean up qemu_coroutine_enter()

Message ID 1423564888-14933-3-git-send-email-kwolf@redhat.com
State New
Headers show

Commit Message

Kevin Wolf Feb. 10, 2015, 10:41 a.m. UTC
qemu_coroutine_enter() is now the only user of coroutine_swap(). Both
functions are short, so inline it.

Also, using COROUTINE_YIELD is now even more confusing because this code
is never called during qemu_coroutine_yield() any more. In fact, this
value is never read back, so we can just introduce a new COROUTINE_ENTER
which documents the purpose of the task switch better.

Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
 include/block/coroutine_int.h |  1 +
 qemu-coroutine.c              | 36 +++++++++++++++---------------------
 2 files changed, 16 insertions(+), 21 deletions(-)

Comments

Paolo Bonzini Feb. 10, 2015, 10:55 a.m. UTC | #1
On 10/02/2015 11:41, Kevin Wolf wrote:
> +    ret = qemu_coroutine_switch(self, co, COROUTINE_ENTER);
> +
> +    qemu_co_queue_run_restart(co);
> +
> +    switch (ret) {
> +    case COROUTINE_YIELD:
> +        return;
> +    case COROUTINE_TERMINATE:
> +        trace_qemu_coroutine_terminate(co);
> +        coroutine_delete(co);
> +        return;
> +    default:

Say you have:

  co1                                     co2
------------------------------------------------------------------------
1 qemu_co_mutex_lock(&m);
2 qemu_coroutine_yield();
3                                         qemu_co_mutex_lock(&m);
4 qemu_co_mutex_unlock(&m);
5 qemu_coroutine_yield();

Then you have:

1 mutex->locked = true;

2 coroutine_swap(co1, leader, COROUTINE_YIELD);

3 while (mutex->locked) {
     qemu_co_queue_wait(&mutex->queue);
           '--> QTAILQ_INSERT_TAIL(&queue->entries, self, co_queue_next);
                qemu_coroutine_yield();
                '--> coroutine_swap(co2, leader, COROUTINE_YIELD);
  }

4 mutex->locked = false;
  qemu_co_queue_next(&mutex->queue);
   '--> qemu_co_queue_do_restart(queue, true);
        '--> QTAILQ_REMOVE(&queue->entries, next, co_queue_next);
             QTAILQ_INSERT_TAIL(&self->co_queue_wakeup, next, co_queue_next);

5 coroutine_swap(co1, leader, COROUTINE_YIELD);

And co2 is never reentered until co1 terminates.  Right?

Paolo
Kevin Wolf Feb. 10, 2015, 11:09 a.m. UTC | #2
Am 10.02.2015 um 11:55 hat Paolo Bonzini geschrieben:
> 
> 
> On 10/02/2015 11:41, Kevin Wolf wrote:
> > +    ret = qemu_coroutine_switch(self, co, COROUTINE_ENTER);
> > +
> > +    qemu_co_queue_run_restart(co);
> > +
> > +    switch (ret) {
> > +    case COROUTINE_YIELD:
> > +        return;
> > +    case COROUTINE_TERMINATE:
> > +        trace_qemu_coroutine_terminate(co);
> > +        coroutine_delete(co);
> > +        return;
> > +    default:
> 
> Say you have:
> 
>   co1                                     co2
> ------------------------------------------------------------------------
> 1 qemu_co_mutex_lock(&m);
> 2 qemu_coroutine_yield();
> 3                                         qemu_co_mutex_lock(&m);
> 4 qemu_co_mutex_unlock(&m);
> 5 qemu_coroutine_yield();
> 
> Then you have:
> 
> 1 mutex->locked = true;
> 
> 2 coroutine_swap(co1, leader, COROUTINE_YIELD);
> 
> 3 while (mutex->locked) {
>      qemu_co_queue_wait(&mutex->queue);
>            '--> QTAILQ_INSERT_TAIL(&queue->entries, self, co_queue_next);
>                 qemu_coroutine_yield();
>                 '--> coroutine_swap(co2, leader, COROUTINE_YIELD);
>   }
> 
> 4 mutex->locked = false;
>   qemu_co_queue_next(&mutex->queue);
>    '--> qemu_co_queue_do_restart(queue, true);
>         '--> QTAILQ_REMOVE(&queue->entries, next, co_queue_next);
>              QTAILQ_INSERT_TAIL(&self->co_queue_wakeup, next, co_queue_next);
> 
> 5 coroutine_swap(co1, leader, COROUTINE_YIELD);
> 
> And co2 is never reentered until co1 terminates.  Right?

No, co2 will be reentered during the yield in line 5. However, it's not
the yielding coroutine that reenters it but the parent, which is resumed
at exactly the line of code that you quoted above.

This is actually how it always worked, even with the bug. The bug caused
it to access the queue of a random other coroutine, but that queue must
have always been empty because it was already processed when that other
coroutine yielded/terminated.

Kevin
Paolo Bonzini Feb. 10, 2015, 11:15 a.m. UTC | #3
On 10/02/2015 12:09, Kevin Wolf wrote:
>> > 
>> > 4 mutex->locked = false;
>> >   qemu_co_queue_next(&mutex->queue);
>> >    '--> qemu_co_queue_do_restart(queue, true);
>> >         '--> QTAILQ_REMOVE(&queue->entries, next, co_queue_next);
>> >              QTAILQ_INSERT_TAIL(&self->co_queue_wakeup, next, co_queue_next);
>> > 
>> > 5 coroutine_swap(co1, leader, COROUTINE_YIELD);
>> > 
>> > And co2 is never reentered until co1 terminates.  Right?
> No, co2 will be reentered during the yield in line 5. However, it's not
> the yielding coroutine that reenters it but the parent, which is resumed
> at exactly the line of code that you quoted above.

So:

5 coroutine_swap(co1, leader, COROUTINE_YIELD);
  '--> jumps back to qemu_coroutine_switch
       '--> returns to qemu_coroutine_enter

  qemu_co_queue_run_restart(co);
  '--> QTAILQ_REMOVE(&co->co_queue_wakeup, next, co_queue_next);
       qemu_coroutine_enter(next, NULL);


Thanks for the explanation.  Series:

Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Stefan Hajnoczi Feb. 18, 2015, 1:50 p.m. UTC | #4
On Tue, Feb 10, 2015 at 11:41:27AM +0100, Kevin Wolf wrote:
> qemu_coroutine_enter() is now the only user of coroutine_swap(). Both
> functions are short, so inline it.
> 
> Also, using COROUTINE_YIELD is now even more confusing because this code
> is never called during qemu_coroutine_yield() any more. In fact, this
> value is never read back, so we can just introduce a new COROUTINE_ENTER
> which documents the purpose of the task switch better.
> 
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> ---
>  include/block/coroutine_int.h |  1 +
>  qemu-coroutine.c              | 36 +++++++++++++++---------------------
>  2 files changed, 16 insertions(+), 21 deletions(-)
> 
> diff --git a/include/block/coroutine_int.h b/include/block/coroutine_int.h
> index f133d65..69b83db 100644
> --- a/include/block/coroutine_int.h
> +++ b/include/block/coroutine_int.h
> @@ -29,6 +29,7 @@
>  #include "block/coroutine.h"
>  
>  typedef enum {
> +    COROUTINE_ENTER = 0,

This makes the ucontext code harder to understand because
CoroutineAction values are used with setjmp()/longjmp() in
qemu_coroutine_switch().

The longjmp() man page says:

  If longjmp() is invoked with a second argument of 0, 1 will be
  returned instead.

I haven't checked whether or not this causes problems, but the code
would be simpler if we avoided using 0.
Kevin Wolf Feb. 18, 2015, 2:20 p.m. UTC | #5
Am 18.02.2015 um 14:50 hat Stefan Hajnoczi geschrieben:
> On Tue, Feb 10, 2015 at 11:41:27AM +0100, Kevin Wolf wrote:
> > qemu_coroutine_enter() is now the only user of coroutine_swap(). Both
> > functions are short, so inline it.
> > 
> > Also, using COROUTINE_YIELD is now even more confusing because this code
> > is never called during qemu_coroutine_yield() any more. In fact, this
> > value is never read back, so we can just introduce a new COROUTINE_ENTER
> > which documents the purpose of the task switch better.
> > 
> > Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> > ---
> >  include/block/coroutine_int.h |  1 +
> >  qemu-coroutine.c              | 36 +++++++++++++++---------------------
> >  2 files changed, 16 insertions(+), 21 deletions(-)
> > 
> > diff --git a/include/block/coroutine_int.h b/include/block/coroutine_int.h
> > index f133d65..69b83db 100644
> > --- a/include/block/coroutine_int.h
> > +++ b/include/block/coroutine_int.h
> > @@ -29,6 +29,7 @@
> >  #include "block/coroutine.h"
> >  
> >  typedef enum {
> > +    COROUTINE_ENTER = 0,
> 
> This makes the ucontext code harder to understand because
> CoroutineAction values are used with setjmp()/longjmp() in
> qemu_coroutine_switch().
> 
> The longjmp() man page says:
> 
>   If longjmp() is invoked with a second argument of 0, 1 will be
>   returned instead.
> 
> I haven't checked whether or not this causes problems, but the code
> would be simpler if we avoided using 0.

It doesn't, the value is unused where we pass COROUTINE_ENTER. But I can
make it 3 instead.

Kevin
Stefan Hajnoczi Feb. 19, 2015, 2:33 p.m. UTC | #6
On Wed, Feb 18, 2015 at 03:20:26PM +0100, Kevin Wolf wrote:
> Am 18.02.2015 um 14:50 hat Stefan Hajnoczi geschrieben:
> > On Tue, Feb 10, 2015 at 11:41:27AM +0100, Kevin Wolf wrote:
> > > qemu_coroutine_enter() is now the only user of coroutine_swap(). Both
> > > functions are short, so inline it.
> > > 
> > > Also, using COROUTINE_YIELD is now even more confusing because this code
> > > is never called during qemu_coroutine_yield() any more. In fact, this
> > > value is never read back, so we can just introduce a new COROUTINE_ENTER
> > > which documents the purpose of the task switch better.
> > > 
> > > Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> > > ---
> > >  include/block/coroutine_int.h |  1 +
> > >  qemu-coroutine.c              | 36 +++++++++++++++---------------------
> > >  2 files changed, 16 insertions(+), 21 deletions(-)
> > > 
> > > diff --git a/include/block/coroutine_int.h b/include/block/coroutine_int.h
> > > index f133d65..69b83db 100644
> > > --- a/include/block/coroutine_int.h
> > > +++ b/include/block/coroutine_int.h
> > > @@ -29,6 +29,7 @@
> > >  #include "block/coroutine.h"
> > >  
> > >  typedef enum {
> > > +    COROUTINE_ENTER = 0,
> > 
> > This makes the ucontext code harder to understand because
> > CoroutineAction values are used with setjmp()/longjmp() in
> > qemu_coroutine_switch().
> > 
> > The longjmp() man page says:
> > 
> >   If longjmp() is invoked with a second argument of 0, 1 will be
> >   returned instead.
> > 
> > I haven't checked whether or not this causes problems, but the code
> > would be simpler if we avoided using 0.
> 
> It doesn't, the value is unused where we pass COROUTINE_ENTER. But I can
> make it 3 instead.

Thanks, that would be good.

Stefan
diff mbox

Patch

diff --git a/include/block/coroutine_int.h b/include/block/coroutine_int.h
index f133d65..69b83db 100644
--- a/include/block/coroutine_int.h
+++ b/include/block/coroutine_int.h
@@ -29,6 +29,7 @@ 
 #include "block/coroutine.h"
 
 typedef enum {
+    COROUTINE_ENTER = 0,
     COROUTINE_YIELD = 1,
     COROUTINE_TERMINATE = 2,
 } CoroutineAction;
diff --git a/qemu-coroutine.c b/qemu-coroutine.c
index 5019b81..c17a92b 100644
--- a/qemu-coroutine.c
+++ b/qemu-coroutine.c
@@ -99,29 +99,10 @@  static void coroutine_delete(Coroutine *co)
     qemu_coroutine_delete(co);
 }
 
-static void coroutine_swap(Coroutine *from, Coroutine *to)
-{
-    CoroutineAction ret;
-
-    ret = qemu_coroutine_switch(from, to, COROUTINE_YIELD);
-
-    qemu_co_queue_run_restart(to);
-
-    switch (ret) {
-    case COROUTINE_YIELD:
-        return;
-    case COROUTINE_TERMINATE:
-        trace_qemu_coroutine_terminate(to);
-        coroutine_delete(to);
-        return;
-    default:
-        abort();
-    }
-}
-
 void qemu_coroutine_enter(Coroutine *co, void *opaque)
 {
     Coroutine *self = qemu_coroutine_self();
+    CoroutineAction ret;
 
     trace_qemu_coroutine_enter(self, co, opaque);
 
@@ -132,7 +113,20 @@  void qemu_coroutine_enter(Coroutine *co, void *opaque)
 
     co->caller = self;
     co->entry_arg = opaque;
-    coroutine_swap(self, co);
+    ret = qemu_coroutine_switch(self, co, COROUTINE_ENTER);
+
+    qemu_co_queue_run_restart(co);
+
+    switch (ret) {
+    case COROUTINE_YIELD:
+        return;
+    case COROUTINE_TERMINATE:
+        trace_qemu_coroutine_terminate(co);
+        coroutine_delete(co);
+        return;
+    default:
+        abort();
+    }
 }
 
 void coroutine_fn qemu_coroutine_yield(void)