From nobody Sun Feb 8 16:52:56 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1612365978; cv=none; d=zohomail.com; s=zohoarc; b=ceRtDp+jPV9g3QI53GDAvlg0CkgtlMckUevl4rjvlHPpWr55wzQvlDItfoEmcGXVTWJTowLirgakgVmGVBOfa+SWcZuxK69davQFKJGHSJEhj31ADj0ukeMxXSFe4lSu3bxLWkr8SQcnmLdiwA/pvr7kV9m997mm4FwVuy/YtgA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1612365978; h=Content-Type:Content-Transfer-Encoding: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=CUoCRaDUyXnn6pXkHr6hYYIG97NVGusdGgTgTUa6BEM=; b=AY8z4CSs2GrmRHX0ruyGhwa9q12oeiDnOIIGYBDEx/Mz2s+qOBYLSzllGcy7RlzsK+ql9rSAYSL+ReMEatDh4L/laPE8wL9kO8lRursRmn8XBjCAkMPF7RZuYZw8KNFn/2qh75yHIErkHGXvEFJkZpg6j93VllgSAme4ILKS0mY= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1612365978206301.94789927769125; Wed, 3 Feb 2021 07:26:18 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-480-RYsU_LSdPhOlOVs69G9koA-1; Wed, 03 Feb 2021 10:26:14 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 7E2FC1015942; Wed, 3 Feb 2021 15:26:09 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1C5C550DD3; Wed, 3 Feb 2021 15:26:08 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id B863418095CC; Wed, 3 Feb 2021 15:26:06 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 113FQ6Lr002790 for ; Wed, 3 Feb 2021 10:26:06 -0500 Received: by smtp.corp.redhat.com (Postfix) id 1F7BA5D6A8; Wed, 3 Feb 2021 15:26:06 +0000 (UTC) Received: from antique-work.lan (unknown [10.40.192.101]) by smtp.corp.redhat.com (Postfix) with ESMTP id 908E85B692 for ; Wed, 3 Feb 2021 15:26:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1612365977; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=CUoCRaDUyXnn6pXkHr6hYYIG97NVGusdGgTgTUa6BEM=; b=VN4TQU4kfDWQ40bmICSqi8uVIwXymmvm+kMe15iePtGuRUEQK0ksokgfGMZaIv12JG+tGX 6KpgXN8nx6wEA31Bfw6FF7wqDTnZTxdraX3wFu6zFIzYF/1TnbNdO7ZGLm7X9FLlrUQR4L 6MtSRScB2VObI22otQzb3FUvKRHxG+Y= X-MC-Unique: RYsU_LSdPhOlOVs69G9koA-1 From: Pavel Hrdina To: libvir-list@redhat.com Subject: [libvirt PATCH v2 3/6] docs: introduces new vhostuser disk type Date: Wed, 3 Feb 2021 16:25:56 +0100 Message-Id: <78f38830fc9a42970a49eb396d34ba34798aac89.1612364698.git.phrdina@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Signed-off-by: Pavel Hrdina Reviewed-by: J=C3=A1n Tomko Reviewed-by: Peter Krempa --- Changes in v2: - edded note to documentation that most XML bits are not supported - removed mode=3D'client' from docs example and commit message docs/formatdomain.rst | 37 +++++++++++++++++++++++++++++++++-- docs/schemas/domaincommon.rng | 19 ++++++++++++++++++ 2 files changed, 54 insertions(+), 2 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 3a2fe7fa16..0f78aa3a8c 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -2419,6 +2419,13 @@ paravirtualized driver is specified via the ``disk``= element. + + + + + + + ... =20 @@ -2429,8 +2436,8 @@ paravirtualized driver is specified via the ``disk`` = element. ``type`` Valid values are "file", "block", "dir" ( :since:`since 0.7.5` ), "network" ( :since:`since 0.8.7` ), or "volume" ( :since:`since 1.0.= 5` ), - or "nvme" ( :since:`since 6.0.0` ) and refer to the underlying sourc= e for - the disk. :since:`Since 0.0.3` + or "nvme" ( :since:`since 6.0.0` ), or "vhostuser" ( :since:`since 7= .1.0` ) + and refer to the underlying source for the disk. :since:`Since 0.0.3` ``device`` Indicates how the disk is to be exposed to the guest OS. Possible va= lues for this attribute are "floppy", "disk", "cdrom", and "lun", default= ing to @@ -2581,6 +2588,23 @@ paravirtualized driver is specified via the ``disk``= element. is not involved (compared to passing say ``/dev/nvme0n1`` via ```` and therefore lower latencies can be achie= ved. =20 + ``vhostuser`` + Enables the hypervisor to connect to another process using vhost-user + protocol. Requires shared memory configured for the VM, for more det= ails + see ``access`` mode for `memoryBacking <#elementsMemoryBacking>` ele= ment. + + The ``source`` element has following mandatory attributes: + + ``type`` + The type of char device. Currently only ``unix`` type is supporte= d. + ``path`` + Path to the unix socket to be used as disk source. + + Note that the vhost server replaces both the disk frontend and backe= nd + thus almost all of the disk properties can't be configured via the + ```` XML for this disk type. Additionally features such as blo= ckjobs, + incremental backups and snapshots are not supported for this disk ty= pe. + With "file", "block", and "volume", one or more optional sub-elements ``seclabel``, `described below <#seclabel>`__ (and :since:`since 0.9.9`= ), can be used to override the domain security labeling policy for just th= at @@ -2703,6 +2727,15 @@ paravirtualized driver is specified via the ``disk``= element. of these attributes is omitted, then that field is assumed to be the default value for the current system. If both ``user`` and ``group`` are intended to be default, then the entire element may be omitted. + ``reconnect`` + For disk type ``vhostuser`` configures reconnect timeout if the conn= ection + is lost. It has two mandatory attributes: + + ``enabled`` + If the reconnect feature is enabled, accepts ``yes`` and ``no`` + ``timeout`` + The amount of seconds after which hypervisor tries to reconnect. + =20 For a "file" or "volume" disk type which represents a cdrom or floppy (= the ``device`` attribute), it is possible to define policy what to do with = the diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng index 239ae3f347..7a2706a4fb 100644 --- a/docs/schemas/domaincommon.rng +++ b/docs/schemas/domaincommon.rng @@ -1646,6 +1646,7 @@ + =20 @@ -2156,6 +2157,24 @@ =20 + + + vhostuser + + + + unix + + + + + + + + + + + (ioemu:)?(fd|hd|sd|vd|xvd|ubd)[a-zA-Z0-9_]+<= /param> --=20 2.29.2