From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2E6D2C07E9A for ; Wed, 14 Jul 2021 09:49:37 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id C3AAA61279 for ; Wed, 14 Jul 2021 09:49:36 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org C3AAA61279 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:57250 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m3bWJ-0002kP-UQ for qemu-devel@archiver.kernel.org; Wed, 14 Jul 2021 05:49:35 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:35212) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m3bKb-000358-S4 for qemu-devel@nongnu.org; Wed, 14 Jul 2021 05:37:29 -0400 Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]:44553) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m3bKZ-0004hK-My for qemu-devel@nongnu.org; Wed, 14 Jul 2021 05:37:29 -0400 Received: by mail-wm1-x32f.google.com with SMTP id l8-20020a05600c1d08b02902333d79327aso381742wms.3 for ; Wed, 14 Jul 2021 02:37:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=V2k26oi2LiEioZB/feP47Q2t0koGpAhQkbvn0KZWlzA=; b=ok0AYfrrJYTyG5ic11q+imA5+v49A8PMuFTeGda9w2VSP6/PRIgKeqehH1pIzY3B4/ VcajBHe0JsCk14R8rxR2ajDtHuj4iAo+IBgyNZt+Os/k9z4wn4Nm2ouyCizZ5hbFChzz 3+bTVwS23NIp4+ArrQkF06GcKo0URzi5kSqHmNDoIzpBJYtx8DtFUGnhweYrkHxaPvYw YRlbK0Nm7TOlWnc5UgfmGHh8YM4nrUP0hWJwWlL7IZdSAGVfFp+r0dQZZU5I3BJ1yqJe QDPheRSUvKZA7XfHTs7QvyedbG2AmrekEZAeuG/Gqoq/XGBcs3auGyJbwhw/MA93G7xA WtKQ== 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=V2k26oi2LiEioZB/feP47Q2t0koGpAhQkbvn0KZWlzA=; b=lO9wcxjubz4/rSXvg9VKB4kC+p++4tZDYXzIR2ejEMMf8ZwW4sYz+huR9lsYGk8os8 NGcTWUU5WbBqB/yN+Wqwm59ierCXRymMPZ7DQM1FWL5C/2Upx7426WHsNzbJ5IUN2bIY fqHENjU6hzeE3KuuY9Nv37qHmxBjED0E8/fi0sxKAKqsbqSJj2ur6FwhQ4Eg1ss+EUqS 3QXh/LYQnD82Y7UT8UrIK/dAbfXRyCK6VwPv4SnMWJ4PL7UxeO5lG4T6r4im+WML1SQU DXIggBk+EGMlsO7V9GAQyAmJ5wAy/LYHtCHb+D21ZzNUgm+HC2boqpBFfaq5RT0GFB66 mpBw== X-Gm-Message-State: AOAM531enUDSUKc4IIuSzzoIvSi+XGat3VuVDlB2WzJCDtaCmZhvcZDS WpSB0dtDP1fPdvMJaMRGPtqQhw== X-Google-Smtp-Source: ABdhPJylPmJ1dB3DVfE+/CT24e+kExhV+x2MwMCkNHUTPSZHW7dVlZ5z04kApMJ9BmaKH3ESrEYJLw== X-Received: by 2002:a7b:c2a2:: with SMTP id c2mr10286735wmk.89.1626255446153; Wed, 14 Jul 2021 02:37:26 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id l20sm1661556wmq.3.2021.07.14.02.37.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Jul 2021 02:37:20 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id E5EFF1FF96; Wed, 14 Jul 2021 10:37:19 +0100 (BST) From: =?UTF-8?q?Alex=20Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v1 03/21] docs: add a section on the generalities of vhost-user Date: Wed, 14 Jul 2021 10:37:01 +0100 Message-Id: <20210714093719.21429-4-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210714093719.21429-1-alex.bennee@linaro.org> References: <20210714093719.21429-1-alex.bennee@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2a00:1450:4864:20::32f; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x32f.google.com 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, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no 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: =?UTF-8?q?Alex=20Benn=C3=A9e?= , Stefan Hajnoczi , "Michael S. Tsirkin" Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" While we do mention some of this stuff in the various daemons and manuals the subtleties of the socket and memory sharing are sometimes missed. This document attempts to give some background on vhost-user daemons in general terms. Signed-off-by: Alex Bennée Cc: Stefan Hajnoczi --- v2 - drop reference to socket direction (it can be either) - mention memory-backend-memfd object - mention requirement to match system memory size --- docs/interop/vhost-user.rst | 4 +- docs/system/device-emulation.rst | 1 + docs/system/devices/vhost-user.rst | 59 ++++++++++++++++++++++++++++++ 3 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 docs/system/devices/vhost-user.rst diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst index d6085f7045..f46423b6f3 100644 --- a/docs/interop/vhost-user.rst +++ b/docs/interop/vhost-user.rst @@ -1,3 +1,5 @@ +.. _vhost_user_proto: + =================== Vhost-user Protocol =================== @@ -6,7 +8,7 @@ Vhost-user Protocol :Licence: This work is licensed under the terms of the GNU GPL, version 2 or later. See the COPYING file in the top-level directory. - + .. contents:: Table of Contents Introduction diff --git a/docs/system/device-emulation.rst b/docs/system/device-emulation.rst index a0f00bc340..5aca6ed66b 100644 --- a/docs/system/device-emulation.rst +++ b/docs/system/device-emulation.rst @@ -75,4 +75,5 @@ Emulated Devices devices/net.rst devices/nvme.rst devices/usb.rst + devices/vhost-user.rst devices/virtio-pmem.rst diff --git a/docs/system/devices/vhost-user.rst b/docs/system/devices/vhost-user.rst new file mode 100644 index 0000000000..86128114fa --- /dev/null +++ b/docs/system/devices/vhost-user.rst @@ -0,0 +1,59 @@ +.. _vhost_user: + +vhost-user back ends +-------------------- + +vhost-user back ends are way to service the request of VirtIO devices +outside of QEMU itself. To do this there are a number of things +required. + +vhost-user device +=================== + +These are simple stub devices that ensure the VirtIO device is visible +to the guest. The code is mostly boilerplate although each device has +a ``chardev`` option which specifies the ID of the ``--chardev`` +device that connects via a socket to the vhost-user *daemon*. + +vhost-user daemon +================= + +This is a separate process that is connected to by QEMU via a socket +following the :ref:`vhost_user_proto`. There are a number of daemons +that can be built when enabled by the project although any daemon that +meets the specification for a given device can be used. + +Shared memory object +==================== + +In order for the daemon to access the VirtIO queues to process the +requests it needs access to the guest's address space. This is +achieved via the ``memory-backend-file`` or ``memory-backend-memfd`` +objects. A reference to a file-descriptor which can access this object +will be passed via the socket as part of the protocol negotiation. + +Currently the shared memory object needs to match the size of the main +system memory as defined by the ``-m`` argument. + +Example +======= + +First start you daemon. + +.. parsed-literal:: + + $ virtio-foo --socket-path=/var/run/foo.sock $OTHER_ARGS + +The you start your QEMU instance specifying the device, chardev and +memory objects. + +.. parsed-literal:: + + $ |qemu_system| \\ + -m 4096 \\ + -chardev socket,id=ba1,path=/var/run/foo.sock \\ + -device vhost-user-foo,chardev=ba1,$OTHER_ARGS \\ + -object memory-backend-memfd,id=mem,size=4G,share=on \\ + -numa node,memdev=mem \\ + ... + -- 2.20.1