Skip to content
Snippets Groups Projects
  • Stefan Hajnoczi's avatar
    06e0f098
    io: follow coroutine AioContext in qio_channel_yield() · 06e0f098
    Stefan Hajnoczi authored
    
    The ongoing QEMU multi-queue block layer effort makes it possible for multiple
    threads to process I/O in parallel. The nbd block driver is not compatible with
    the multi-queue block layer yet because QIOChannel cannot be used easily from
    coroutines running in multiple threads. This series changes the QIOChannel API
    to make that possible.
    
    In the current API, calling qio_channel_attach_aio_context() sets the
    AioContext where qio_channel_yield() installs an fd handler prior to yielding:
    
      qio_channel_attach_aio_context(ioc, my_ctx);
      ...
      qio_channel_yield(ioc); // my_ctx is used here
      ...
      qio_channel_detach_aio_context(ioc);
    
    This API design has limitations: reading and writing must be done in the same
    AioContext and moving between AioContexts involves a cumbersome sequence of API
    calls that is not suitable for doing on a per-request basis.
    
    There is no fundamental reason why a QIOChannel needs to run within the
    same AioContext every time qio_channel_yield() is called. QIOChannel
    only uses the AioContext while inside qio_channel_yield(). The rest of
    the time, QIOChannel is independent of any AioContext.
    
    In the new API, qio_channel_yield() queries the AioContext from the current
    coroutine using qemu_coroutine_get_aio_context(). There is no need to
    explicitly attach/detach AioContexts anymore and
    qio_channel_attach_aio_context() and qio_channel_detach_aio_context() are gone.
    One coroutine can read from the QIOChannel while another coroutine writes from
    a different AioContext.
    
    This API change allows the nbd block driver to use QIOChannel from any thread.
    It's important to keep in mind that the block driver already synchronizes
    QIOChannel access and ensures that two coroutines never read simultaneously or
    write simultaneously.
    
    This patch updates all users of qio_channel_attach_aio_context() to the
    new API. Most conversions are simple, but vhost-user-server requires a
    new qemu_coroutine_yield() call to quiesce the vu_client_trip()
    coroutine when not attached to any AioContext.
    
    While the API is has become simpler, there is one wart: QIOChannel has a
    special case for the iohandler AioContext (used for handlers that must not run
    in nested event loops). I didn't find an elegant way preserve that behavior, so
    I added a new API called qio_channel_set_follow_coroutine_ctx(ioc, true|false)
    for opting in to the new AioContext model. By default QIOChannel uses the
    iohandler AioHandler. Code that formerly called
    qio_channel_attach_aio_context() now calls
    qio_channel_set_follow_coroutine_ctx(ioc, true) once after the QIOChannel is
    created.
    
    Signed-off-by: default avatarStefan Hajnoczi <stefanha@redhat.com>
    Reviewed-by: default avatarEric Blake <eblake@redhat.com>
    Acked-by: default avatarDaniel P. Berrangé <berrange@redhat.com>
    Message-ID: <20230830224802.493686-5-stefanha@redhat.com>
    [eblake: also fix migration/rdma.c]
    Signed-off-by: default avatarEric Blake <eblake@redhat.com>
    06e0f098
    History
    io: follow coroutine AioContext in qio_channel_yield()
    Stefan Hajnoczi authored
    
    The ongoing QEMU multi-queue block layer effort makes it possible for multiple
    threads to process I/O in parallel. The nbd block driver is not compatible with
    the multi-queue block layer yet because QIOChannel cannot be used easily from
    coroutines running in multiple threads. This series changes the QIOChannel API
    to make that possible.
    
    In the current API, calling qio_channel_attach_aio_context() sets the
    AioContext where qio_channel_yield() installs an fd handler prior to yielding:
    
      qio_channel_attach_aio_context(ioc, my_ctx);
      ...
      qio_channel_yield(ioc); // my_ctx is used here
      ...
      qio_channel_detach_aio_context(ioc);
    
    This API design has limitations: reading and writing must be done in the same
    AioContext and moving between AioContexts involves a cumbersome sequence of API
    calls that is not suitable for doing on a per-request basis.
    
    There is no fundamental reason why a QIOChannel needs to run within the
    same AioContext every time qio_channel_yield() is called. QIOChannel
    only uses the AioContext while inside qio_channel_yield(). The rest of
    the time, QIOChannel is independent of any AioContext.
    
    In the new API, qio_channel_yield() queries the AioContext from the current
    coroutine using qemu_coroutine_get_aio_context(). There is no need to
    explicitly attach/detach AioContexts anymore and
    qio_channel_attach_aio_context() and qio_channel_detach_aio_context() are gone.
    One coroutine can read from the QIOChannel while another coroutine writes from
    a different AioContext.
    
    This API change allows the nbd block driver to use QIOChannel from any thread.
    It's important to keep in mind that the block driver already synchronizes
    QIOChannel access and ensures that two coroutines never read simultaneously or
    write simultaneously.
    
    This patch updates all users of qio_channel_attach_aio_context() to the
    new API. Most conversions are simple, but vhost-user-server requires a
    new qemu_coroutine_yield() call to quiesce the vu_client_trip()
    coroutine when not attached to any AioContext.
    
    While the API is has become simpler, there is one wart: QIOChannel has a
    special case for the iohandler AioContext (used for handlers that must not run
    in nested event loops). I didn't find an elegant way preserve that behavior, so
    I added a new API called qio_channel_set_follow_coroutine_ctx(ioc, true|false)
    for opting in to the new AioContext model. By default QIOChannel uses the
    iohandler AioHandler. Code that formerly called
    qio_channel_attach_aio_context() now calls
    qio_channel_set_follow_coroutine_ctx(ioc, true) once after the QIOChannel is
    created.
    
    Signed-off-by: default avatarStefan Hajnoczi <stefanha@redhat.com>
    Reviewed-by: default avatarEric Blake <eblake@redhat.com>
    Acked-by: default avatarDaniel P. Berrangé <berrange@redhat.com>
    Message-ID: <20230830224802.493686-5-stefanha@redhat.com>
    [eblake: also fix migration/rdma.c]
    Signed-off-by: default avatarEric Blake <eblake@redhat.com>