From nobody Mon Feb 9 14:37:55 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=gmail.com ARC-Seal: i=1; a=rsa-sha256; t=1591313824; cv=none; d=zohomail.com; s=zohoarc; b=HWYKWb3kZa41vUhLlyvLfJ/lzALA/R9jeD4h0L5LlZMy6LW2/uc4zGucaMG1qk8ZkRiD4pBpULlUyQhkvi1dFellIBPDqoSrqNWysfn/+WQWsBVgvtWpOiHh30+a6vxmcS5Yz2FNxj56VDrx2wY6WiJLPeez35jW1WlpqMLUXz4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1591313824; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=HiT8o7yPRFJc9HDdCsWuWuJTLvASD+uleZm1Tw2F1k4=; b=RAH/nfEu2B3QBxXElBvLbV1ydrmrdn5mbpqL3Kx14uGNNAsHkd1rG9swmTMk5u43GzCy3p0/+9yB8UdoG7GPT9iQoK9RqtZccUMc1UneRW+i0nKmgFJGQEyGH/qWhOiYx60FPsCCBx9Bhh+zfWxk0IpAUdpb/7KlLWsGDqBxzvI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1591313824399934.5180347022873; Thu, 4 Jun 2020 16:37:04 -0700 (PDT) Received: from localhost ([::1]:43590 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jgzPz-0003yD-5d for importer@patchew.org; Thu, 04 Jun 2020 19:37:03 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:48096) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jgzPB-0002cw-Pn for qemu-devel@nongnu.org; Thu, 04 Jun 2020 19:36:13 -0400 Received: from mail-pg1-x544.google.com ([2607:f8b0:4864:20::544]:36313) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jgzPA-00055l-CM for qemu-devel@nongnu.org; Thu, 04 Jun 2020 19:36:13 -0400 Received: by mail-pg1-x544.google.com with SMTP id t7so4244311pgt.3 for ; Thu, 04 Jun 2020 16:36:12 -0700 (PDT) Received: from localhost (tunnel570486-pt.tunnel.tserv25.sin1.ipv6.he.net. [2001:470:35:3d5::2]) by smtp.gmail.com with ESMTPSA id z20sm4913443pgv.52.2020.06.04.16.36.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Jun 2020 16:36:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=HiT8o7yPRFJc9HDdCsWuWuJTLvASD+uleZm1Tw2F1k4=; b=SuJyUz2qAbQ3gTCJy9cdnACBvUmcS8xIDb+lQxSDI4MsZxnE8+d4VOLXqQmL2OFKln Y2eiPWp6w1kY/eDNqydsjuSppfmIxV3kMTAkMg3+LPV8boTuGW4YhqHVQHUAdXehO1Z0 BiPP/cg0m2r8uxUQgcvkEt7s5ft18+IRAnpjnqUU9oGDOmXZAAtjiXT2plATSCF5am84 nQNtHM0oNzbMPG+BtAHwBamnqKLapU1gNKXG0S/vf0sxLYHPdD67O5qh9jp0uaNkq1Pi Or7rarGcQxjWFLLp9bFHf+B+mUiz8EUawgZidRlKIzUKY44rhAMPd5dsS1mUM7xeaco7 Jp8g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=HiT8o7yPRFJc9HDdCsWuWuJTLvASD+uleZm1Tw2F1k4=; b=CAerG1khiBM2/yYU8I69b7tY37Hi7nEthBP03EcR/s4oLzPZ/PcVddQhI5ntYAo5xM XgiCrXQsRdos75ziw7Em7eNBjPR7w8rlPRG4CCoD4zFBdOAqfCa9j3PEeyIGqiINMFfu T4MyTkqaWSpT8lhWG5zw4FLYaeaVakbcKk0BvoKgZl6uZh06T1d8mLJ78YU9GN/WWmub glJG2Mi9kqOI3ARLexFfQS77TcNpUXhAjOFEhuSLsQ6DuZ01aFI2wmbf/pQ/zmxn+9mk MZ8Dr7bTQHaLKTexn4kHB7r2WsJIqUhUcCM/iRcXmsKGJy2ihtAFKcOQBvZfkuNGMry8 9OBQ== X-Gm-Message-State: AOAM530EdHdf4kwIHs04AmbwcV5ws/Qz/WjG6jAMgqa/njn/NNqVMhrN Yw2Y6CxlHx4u5TeTrm/XZprBXYQpzzKnHLg1 X-Google-Smtp-Source: ABdhPJwPI918O7h28wo/hq6EtQehD/R/kuhoTJEZXFdErEYi4mAsRTlhK2uJJ26DcvlUwvCB2Ailkg== X-Received: by 2002:a05:6a00:15c7:: with SMTP id o7mr6429564pfu.51.1591313770627; Thu, 04 Jun 2020 16:36:10 -0700 (PDT) From: Coiby Xu To: qemu-devel@nongnu.org Subject: [PATCH v8 2/4] generic vhost user server Date: Fri, 5 Jun 2020 07:35:36 +0800 Message-Id: <20200604233538.256325-3-coiby.xu@gmail.com> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20200604233538.256325-1-coiby.xu@gmail.com> References: <20200604233538.256325-1-coiby.xu@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::544; envelope-from=coiby.xu@gmail.com; helo=mail-pg1-x544.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kwolf@redhat.com, bharatlkmlkvm@gmail.com, Coiby Xu , stefanha@redhat.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Sharing QEMU devices via vhost-user protocol. Only one vhost-user client can connect to the server one time. Signed-off-by: Coiby Xu --- util/Makefile.objs | 1 + util/vhost-user-server.c | 406 +++++++++++++++++++++++++++++++++++++++ util/vhost-user-server.h | 59 ++++++ 3 files changed, 466 insertions(+) create mode 100644 util/vhost-user-server.c create mode 100644 util/vhost-user-server.h diff --git a/util/Makefile.objs b/util/Makefile.objs index fe339c2636..f54a6c80ec 100644 --- a/util/Makefile.objs +++ b/util/Makefile.objs @@ -40,6 +40,7 @@ util-obj-y +=3D readline.o util-obj-y +=3D rcu.o util-obj-$(CONFIG_MEMBARRIER) +=3D sys_membarrier.o util-obj-y +=3D qemu-coroutine.o qemu-coroutine-lock.o qemu-coroutine-io.o +util-obj-$(CONFIG_LINUX) +=3D vhost-user-server.o util-obj-y +=3D qemu-coroutine-sleep.o util-obj-y +=3D qemu-co-shared-resource.o util-obj-y +=3D coroutine-$(CONFIG_COROUTINE_BACKEND).o diff --git a/util/vhost-user-server.c b/util/vhost-user-server.c new file mode 100644 index 0000000000..8fafd97bdc --- /dev/null +++ b/util/vhost-user-server.c @@ -0,0 +1,406 @@ +/* + * Sharing QEMU devices via vhost-user protocol + * + * Author: Coiby Xu + * + * This work is licensed under the terms of the GNU GPL, version 2 or + * later. See the COPYING file in the top-level directory. + */ +#include "qemu/osdep.h" +#include +#include "qemu/main-loop.h" +#include "vhost-user-server.h" + +static void vmsg_close_fds(VhostUserMsg *vmsg) +{ + int i; + for (i =3D 0; i < vmsg->fd_num; i++) { + close(vmsg->fds[i]); + } +} + +static void vmsg_unblock_fds(VhostUserMsg *vmsg) +{ + int i; + for (i =3D 0; i < vmsg->fd_num; i++) { + qemu_set_nonblock(vmsg->fds[i]); + } +} + +static void vu_accept(QIONetListener *listener, QIOChannelSocket *sioc, + gpointer opaque); + +static void close_client(VuServer *server) +{ + vu_deinit(&server->vu_dev); + server->sioc =3D NULL; + object_unref(OBJECT(server->ioc)); + + server->sioc_slave =3D NULL; + object_unref(OBJECT(server->ioc_slave)); + /* + * Set the callback function for network listener so another + * vhost-user client can connect to this server + */ + qio_net_listener_set_client_func(server->listener, + vu_accept, + server, + NULL); +} + +static void panic_cb(VuDev *vu_dev, const char *buf) +{ + VuServer *server =3D container_of(vu_dev, VuServer, vu_dev); + + if (buf) { + error_report("vu_panic: %s", buf); + } + + if (server->sioc) { + close_client(server); + } + + if (server->device_panic_notifier) { + server->device_panic_notifier(server); + } +} + +static QIOChannel *slave_io_channel(VuServer *server, int fd, + Error **local_err) +{ + if (server->sioc_slave) { + if (fd =3D=3D server->sioc_slave->fd) { + return server->ioc_slave; + } + } else { + server->sioc_slave =3D qio_channel_socket_new_fd(fd, local_err); + if (!*local_err) { + server->ioc_slave =3D QIO_CHANNEL(server->sioc_slave); + return server->ioc_slave; + } + } + + return NULL; +} + +static bool coroutine_fn +vu_message_read(VuDev *vu_dev, int conn_fd, VhostUserMsg *vmsg) +{ + struct iovec iov =3D { + .iov_base =3D (char *)vmsg, + .iov_len =3D VHOST_USER_HDR_SIZE, + }; + int rc, read_bytes =3D 0; + Error *local_err =3D NULL; + /* + * Store fds/nfds returned from qio_channel_readv_full into + * temporary variables. + * + * VhostUserMsg is a packed structure, gcc will complain about passing + * pointer to a packed structure member if we pass &VhostUserMsg.fd_num + * and &VhostUserMsg.fds directly when calling qio_channel_readv_full, + * thus two temporary variables nfds and fds are used here. + */ + size_t nfds =3D 0, nfds_t =3D 0; + int *fds =3D NULL, *fds_t =3D NULL; + VuServer *server =3D container_of(vu_dev, VuServer, vu_dev); + QIOChannel *ioc =3D NULL; + + if (conn_fd =3D=3D server->sioc->fd) { + ioc =3D server->ioc; + } else { + /* Slave communication will also use this function to read msg */ + ioc =3D slave_io_channel(server, conn_fd, &local_err); + } + + if (!ioc) { + error_report_err(local_err); + goto fail; + } + + assert(qemu_in_coroutine()); + do { + /* + * qio_channel_readv_full may have short reads, keeping calling it + * until getting VHOST_USER_HDR_SIZE or 0 bytes in total + */ + rc =3D qio_channel_readv_full(ioc, &iov, 1, &fds_t, &nfds_t, &loca= l_err); + if (rc < 0) { + if (rc =3D=3D QIO_CHANNEL_ERR_BLOCK) { + qio_channel_yield(ioc, G_IO_IN); + continue; + } else { + error_report_err(local_err); + return false; + } + } + read_bytes +=3D rc; + if (nfds_t > 0) { + fds =3D g_renew(int, fds, nfds + nfds_t); + memcpy(fds + nfds, fds_t, nfds_t *sizeof(int)); + nfds +=3D nfds_t; + if (nfds > VHOST_MEMORY_MAX_NREGIONS) { + error_report("A maximum of %d fds are allowed, " + "however got %lu fds now", + VHOST_MEMORY_MAX_NREGIONS, nfds); + goto fail; + } + g_free(fds_t); + } + if (read_bytes =3D=3D VHOST_USER_HDR_SIZE || rc =3D=3D 0) { + break; + } + iov.iov_base =3D (char *)vmsg + read_bytes; + iov.iov_len =3D VHOST_USER_HDR_SIZE - read_bytes; + } while (true); + + vmsg->fd_num =3D nfds; + if (nfds > 0) { + memcpy(vmsg->fds, fds, nfds * sizeof(int)); + } + g_free(fds); + /* qio_channel_readv_full will make socket fds blocking, unblock them = */ + vmsg_unblock_fds(vmsg); + if (vmsg->size > sizeof(vmsg->payload)) { + error_report("Error: too big message request: %d, " + "size: vmsg->size: %u, " + "while sizeof(vmsg->payload) =3D %zu", + vmsg->request, vmsg->size, sizeof(vmsg->payload)); + goto fail; + } + + struct iovec iov_payload =3D { + .iov_base =3D (char *)&vmsg->payload, + .iov_len =3D vmsg->size, + }; + if (vmsg->size) { + rc =3D qio_channel_readv_all_eof(ioc, &iov_payload, 1, &local_err); + if (rc =3D=3D -1) { + error_report_err(local_err); + goto fail; + } + } + + return true; + +fail: + vmsg_close_fds(vmsg); + + return false; +} + + +static void vu_client_start(VuServer *server); +static coroutine_fn void vu_client_trip(void *opaque) +{ + VuServer *server =3D opaque; + + while (!server->aio_context_changed && server->sioc) { + vu_dispatch(&server->vu_dev); + } + + if (server->aio_context_changed && server->sioc) { + server->aio_context_changed =3D false; + vu_client_start(server); + } +} + +static void vu_client_start(VuServer *server) +{ + server->co_trip =3D qemu_coroutine_create(vu_client_trip, server); + aio_co_enter(server->ctx, server->co_trip); +} + +/* + * a wrapper for vu_kick_cb + * + * since aio_dispatch can only pass one user data pointer to the + * callback function, pack VuDev and pvt into a struct. Then unpack it + * and pass them to vu_kick_cb + */ +static void kick_handler(void *opaque) +{ + KickInfo *kick_info =3D opaque; + kick_info->cb(kick_info->vu_dev, 0, (void *) kick_info->index); +} + + +static void +set_watch(VuDev *vu_dev, int fd, int vu_evt, + vu_watch_cb cb, void *pvt) +{ + + VuServer *server =3D container_of(vu_dev, VuServer, vu_dev); + g_assert(vu_dev); + g_assert(fd >=3D 0); + long index =3D (intptr_t) pvt; + g_assert(cb); + KickInfo *kick_info =3D &server->kick_info[index]; + if (!kick_info->cb) { + kick_info->fd =3D fd; + kick_info->cb =3D cb; + qemu_set_nonblock(fd); + aio_set_fd_handler(server->ioc->ctx, fd, false, kick_handler, + NULL, NULL, kick_info); + kick_info->vu_dev =3D vu_dev; + } +} + + +static void remove_watch(VuDev *vu_dev, int fd) +{ + VuServer *server; + int i; + int index =3D -1; + g_assert(vu_dev); + g_assert(fd >=3D 0); + + server =3D container_of(vu_dev, VuServer, vu_dev); + for (i =3D 0; i < vu_dev->max_queues; i++) { + if (server->kick_info[i].fd =3D=3D fd) { + index =3D i; + break; + } + } + + if (index =3D=3D -1) { + return; + } + server->kick_info[i].cb =3D NULL; + aio_set_fd_handler(server->ioc->ctx, fd, false, NULL, NULL, NULL, NULL= ); +} + + +static void vu_accept(QIONetListener *listener, QIOChannelSocket *sioc, + gpointer opaque) +{ + VuServer *server =3D opaque; + + if (server->sioc) { + warn_report("Only one vhost-user client is allowed to " + "connect the server one time"); + return; + } + + if (!vu_init(&server->vu_dev, server->max_queues, sioc->fd, panic_cb, + vu_message_read, set_watch, remove_watch, server->vu_ifac= e)) { + error_report("Failed to initialized libvhost-user"); + return; + } + + /* + * Unset the callback function for network listener to make another + * vhost-user client keeping waiting until this client disconnects + */ + qio_net_listener_set_client_func(server->listener, + NULL, + NULL, + NULL); + server->sioc =3D sioc; + server->kick_info =3D g_new0(KickInfo, server->max_queues); + /* + * Increase the object reference, so cioc will not freed by + * qio_net_listener_channel_func which will call object_unref(OBJECT(s= ioc)) + */ + object_ref(OBJECT(server->sioc)); + qio_channel_set_name(QIO_CHANNEL(sioc), "vhost-user client"); + server->ioc =3D QIO_CHANNEL(sioc); + object_ref(OBJECT(server->ioc)); + object_ref(OBJECT(sioc)); + qio_channel_attach_aio_context(server->ioc, server->ctx); + qio_channel_set_blocking(QIO_CHANNEL(server->sioc), false, NULL); + vu_client_start(server); +} + + +void vhost_user_server_stop(VuServer *server) +{ + if (!server) { + return; + } + + if (server->sioc) { + close_client(server); + object_unref(OBJECT(server->sioc)); + } + + if (server->listener) { + qio_net_listener_disconnect(server->listener); + object_unref(OBJECT(server->listener)); + } +} + +static void detach_context(VuServer *server) +{ + int i; + AioContext *ctx =3D server->ioc->ctx; + qio_channel_detach_aio_context(server->ioc); + for (i =3D 0; i < server->vu_dev.max_queues; i++) { + if (server->kick_info[i].cb) { + aio_set_fd_handler(ctx, server->kick_info[i].fd, false, NULL, + NULL, NULL, NULL); + } + } +} + +static void attach_context(VuServer *server, AioContext *ctx) +{ + int i; + qio_channel_attach_aio_context(server->ioc, ctx); + server->aio_context_changed =3D true; + if (server->co_trip) { + aio_co_schedule(ctx, server->co_trip); + } + for (i =3D 0; i < server->vu_dev.max_queues; i++) { + if (server->kick_info[i].cb) { + aio_set_fd_handler(ctx, server->kick_info[i].fd, false, + kick_handler, NULL, NULL, + &server->kick_info[i]); + } + } +} + +void vhost_user_server_set_aio_context(AioContext *ctx, VuServer *server) +{ + server->ctx =3D ctx ? ctx : qemu_get_aio_context(); + if (!server->sioc) { + return; + } + if (ctx) { + attach_context(server, ctx); + } else { + detach_context(server); + } +} + + +bool vhost_user_server_start(uint16_t max_queues, + SocketAddress *socket_addr, + AioContext *ctx, + VuServer *server, + void *device_panic_notifier, + const VuDevIface *vu_iface, + Error **errp) +{ + server->listener =3D qio_net_listener_new(); + if (qio_net_listener_open_sync(server->listener, socket_addr, 1, + errp) < 0) { + goto error; + } + + qio_net_listener_set_name(server->listener, "vhost-user-backend-listen= er"); + + server->vu_iface =3D vu_iface; + server->max_queues =3D max_queues; + server->ctx =3D ctx; + server->device_panic_notifier =3D device_panic_notifier; + qio_net_listener_set_client_func(server->listener, + vu_accept, + server, + NULL); + + return true; +error: + g_free(server); + return false; +} diff --git a/util/vhost-user-server.h b/util/vhost-user-server.h new file mode 100644 index 0000000000..4315556b66 --- /dev/null +++ b/util/vhost-user-server.h @@ -0,0 +1,59 @@ +/* + * Sharing QEMU devices via vhost-user protocol + * + * Author: Coiby Xu + * + * This work is licensed under the terms of the GNU GPL, version 2 or + * later. See the COPYING file in the top-level directory. + */ + +#ifndef VHOST_USER_SERVER_H +#define VHOST_USER_SERVER_H + +#include "contrib/libvhost-user/libvhost-user.h" +#include "io/channel-socket.h" +#include "io/channel-file.h" +#include "io/net-listener.h" +#include "qemu/error-report.h" +#include "qapi/error.h" +#include "standard-headers/linux/virtio_blk.h" + +typedef struct KickInfo { + VuDev *vu_dev; + int fd; /*kick fd*/ + long index; /*queue index*/ + vu_watch_cb cb; +} KickInfo; + +typedef struct VuServer { + QIONetListener *listener; + AioContext *ctx; + void (*device_panic_notifier)(struct VuServer *server) ; + int max_queues; + const VuDevIface *vu_iface; + VuDev vu_dev; + QIOChannel *ioc; /* The I/O channel with the client */ + QIOChannelSocket *sioc; /* The underlying data channel with the client= */ + /* IOChannel for fd provided via VHOST_USER_SET_SLAVE_REQ_FD */ + QIOChannel *ioc_slave; + QIOChannelSocket *sioc_slave; + Coroutine *co_trip; /* coroutine for processing VhostUserMsg */ + KickInfo *kick_info; /* an array with the length of the queue number */ + /* restart coroutine co_trip if AIOContext is changed */ + bool aio_context_changed; +} VuServer; + + +bool vhost_user_server_start(uint16_t max_queues, + SocketAddress *unix_socket, + AioContext *ctx, + VuServer *server, + void *device_panic_notifier, + const VuDevIface *vu_iface, + Error **errp); + +void vhost_user_server_stop(VuServer *server); + +void vhost_user_server_set_aio_context(AioContext *ctx, VuServer *server); + +#endif /* VHOST_USER_SERVER_H */ --=20 2.26.2