From nobody Mon Nov 10 19:43:37 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org ARC-Seal: i=1; a=rsa-sha256; t=1558118384; cv=none; d=zoho.com; s=zohoarc; b=Uki243Du1IIsSKa7mO4jYJXIVKNAC0j40WET4E4KAxFCYhk1meVXGUy0HXihDy7UMm/pSmYe5vpAZk8s8KdFpHNZ//4cJASTVgF0rGFoTrSb2OrMWu2FcqFVxgYrxKQXJ8IZXoSltgWyhXZyrRKX/mfmfAjEntmL104l3KVoMfM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1558118384; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=3OEF2AlABoNU0OgZ+vlFvYOO4gFsvTzZmeHk8aZ1o70=; b=EqqvWrxQwvOcSx4hMVsttyEAcgZb+0eDNy28hxeu6sCd6kqTSTXdZnS4pIm1oPjd1mvrwugcTvwhzM8XvqtfMFegAYAujqFJac1thea7ATDVy7xuACDCKYufVnXYqO/IVJ4xCO4klhCJnvaBNrTqmgCRhPaVgM5Tkr1fj46LZQ8= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (209.51.188.17 [209.51.188.17]) by mx.zohomail.com with SMTPS id 1558118384093103.4411296678577; Fri, 17 May 2019 11:39:44 -0700 (PDT) Received: from localhost ([127.0.0.1]:52363 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hRhla-0000Wz-1L for importer@patchew.org; Fri, 17 May 2019 14:39:38 -0400 Received: from eggs.gnu.org ([209.51.188.92]:56343) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hRhfH-0004Ah-Fq for qemu-devel@nongnu.org; Fri, 17 May 2019 14:33:09 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hRhfF-0006Lc-CT for qemu-devel@nongnu.org; Fri, 17 May 2019 14:33:07 -0400 Received: from mx0b-001b2d01.pphosted.com ([148.163.158.5]:52328 helo=mx0a-001b2d01.pphosted.com) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hRhfF-0006Ko-5h for qemu-devel@nongnu.org; Fri, 17 May 2019 14:33:05 -0400 Received: from pps.filterd (m0098413.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x4HINeis130605 for ; Fri, 17 May 2019 14:33:02 -0400 Received: from e06smtp01.uk.ibm.com (e06smtp01.uk.ibm.com [195.75.94.97]) by mx0b-001b2d01.pphosted.com with ESMTP id 2sj0n3ky8f-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 17 May 2019 14:33:02 -0400 Received: from localhost by e06smtp01.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Fri, 17 May 2019 19:33:00 +0100 Received: from b06cxnps4075.portsmouth.uk.ibm.com (9.149.109.197) by e06smtp01.uk.ibm.com (192.168.101.131) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Fri, 17 May 2019 19:32:58 +0100 Received: from d06av25.portsmouth.uk.ibm.com (d06av25.portsmouth.uk.ibm.com [9.149.105.61]) by b06cxnps4075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x4HIWvIJ53674102 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 17 May 2019 18:32:57 GMT Received: from d06av25.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id A163411C04C; Fri, 17 May 2019 18:32:57 +0000 (GMT) Received: from d06av25.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 8EF6711C06E; Fri, 17 May 2019 18:32:57 +0000 (GMT) Received: from smtp.lab.toulouse-stg.fr.ibm.com (unknown [9.101.4.1]) by d06av25.portsmouth.uk.ibm.com (Postfix) with ESMTP; Fri, 17 May 2019 18:32:57 +0000 (GMT) Received: from bahia.ibmuc.com (sig-9-145-156-103.de.ibm.com [9.145.156.103]) by smtp.lab.toulouse-stg.fr.ibm.com (Postfix) with ESMTP id 1D2232203F3; Fri, 17 May 2019 20:32:57 +0200 (CEST) From: Greg Kurz To: qemu-devel@nongnu.org Date: Fri, 17 May 2019 20:32:40 +0200 X-Mailer: git-send-email 2.17.2 In-Reply-To: <20190517183240.689188-1-groug@kaod.org> References: <20190517183240.689188-1-groug@kaod.org> X-TM-AS-GCONF: 00 x-cbid: 19051718-4275-0000-0000-00000335EB48 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 19051718-4276-0000-0000-0000384577DD Message-Id: <20190517183240.689188-7-groug@kaod.org> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2019-05-17_11:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1034 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905170108 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] X-Received-From: 148.163.158.5 Subject: [Qemu-devel] [PULL 6/6] virtfs: Fix documentation of -fsdev and -virtfs X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Maydell , Greg Kurz Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" This fixes several things: - add "id" description to -virtfs documentation - split the description into several lines in both usage and documentation for accurateness and clarity - add documentation and usage of the synth fsdriver - add "throttling.*" description to -fsdev local - add some missing periods - add proper reference to the virtfs-proxy-helper(1) manual page - document that the virtio device may be either virtio-9p-pci, virtio-9p-ccw or virtio-9p-device, depending on the machine type Buglink: https://bugs.launchpad.net/qemu/+bug/1581976 Signed-off-by: Greg Kurz Acked-by: Thomas Huth --- qemu-options.hx | 93 +++++++++++++++++++++++++++++++++++-------------- 1 file changed, 66 insertions(+), 27 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index e54c56593b25..5daa5a8fb0a8 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -1232,26 +1232,35 @@ the write back by pressing @key{C-a s} (@pxref{disk= _images}). ETEXI =20 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, - "-fsdev fsdriver,id=3Did[,path=3Dpath,][security_model=3D{mapped-xattr= |mapped-file|passthrough|none}]\n" - " [,writeout=3Dimmediate][,readonly][,socket=3Dsocket|sock_fd=3Dsock_f= d][,fmode=3Dfmode][,dmode=3Ddmode]\n" + "-fsdev local,id=3Did,path=3Dpath,security_model=3Dmapped-xattr|mapped= -file|passthrough|none\n" + " [,writeout=3Dimmediate][,readonly][,fmode=3Dfmode][,dmode=3Ddmode]\n" " [[,throttling.bps-total=3Db]|[[,throttling.bps-read=3Dr][,throttling= .bps-write=3Dw]]]\n" " [[,throttling.iops-total=3Di]|[[,throttling.iops-read=3Dr][,throttli= ng.iops-write=3Dw]]]\n" " [[,throttling.bps-total-max=3Dbm]|[[,throttling.bps-read-max=3Drm][,= throttling.bps-write-max=3Dwm]]]\n" " [[,throttling.iops-total-max=3Dim]|[[,throttling.iops-read-max=3Dirm= ][,throttling.iops-write-max=3Diwm]]]\n" - " [[,throttling.iops-size=3Dis]]\n", + " [[,throttling.iops-size=3Dis]]\n" + "-fsdev proxy,id=3Did,socket=3Dsocket[,writeout=3Dimmediate][,readonly= ]\n" + "-fsdev proxy,id=3Did,sock_fd=3Dsock_fd[,writeout=3Dimmediate][,readon= ly]\n" + "-fsdev synth,id=3Did\n", QEMU_ARCH_ALL) =20 STEXI =20 -@item -fsdev @var{fsdriver},id=3D@var{id},path=3D@var{path},[security_mode= l=3D@var{security_model}][,writeout=3D@var{writeout}][,readonly][,socket=3D= @var{socket}|sock_fd=3D@var{sock_fd}][,fmode=3D@var{fmode}][,dmode=3D@var{d= mode}] +@item -fsdev local,id=3D@var{id},path=3D@var{path},security_model=3D@var{s= ecurity_model} [,writeout=3D@var{writeout}][,readonly][,fmode=3D@var{fmode}= ][,dmode=3D@var{dmode}] [,throttling.@var{option}=3D@var{value}[,throttling= .@var{option}=3D@var{value}[,...]]] +@itemx -fsdev proxy,id=3D@var{id},socket=3D@var{socket}[,writeout=3D@var{w= riteout}][,readonly] +@itemx -fsdev proxy,id=3D@var{id},sock_fd=3D@var{sock_fd}[,writeout=3D@var= {writeout}][,readonly] +@itemx -fsdev synth,id=3D@var{id}[,readonly] @findex -fsdev Define a new file system device. Valid options are: @table @option -@item @var{fsdriver} -This option specifies the fs driver backend to use. -Currently "local" and "proxy" file system drivers are supported. +@item local +Accesses to the filesystem are done by QEMU. +@item proxy +Accesses to the filesystem are done by virtfs-proxy-helper(1). +@item synth +Synthetic filesystem, only used by QTests. @item id=3D@var{id} -Specifies identifier for this device +Specifies identifier for this device. @item path=3D@var{path} Specifies the export path for the file system device. Files under this path will be available to the 9p client on the guest. @@ -1279,48 +1288,76 @@ Enables exporting 9p share as a readonly mount for = guests. By default read-write access is given. @item socket=3D@var{socket} Enables proxy filesystem driver to use passed socket file for communicating -with virtfs-proxy-helper +with virtfs-proxy-helper(1). @item sock_fd=3D@var{sock_fd} Enables proxy filesystem driver to use passed socket descriptor for -communicating with virtfs-proxy-helper. Usually a helper like libvirt -will create socketpair and pass one of the fds as sock_fd +communicating with virtfs-proxy-helper(1). Usually a helper like libvirt +will create socketpair and pass one of the fds as sock_fd. @item fmode=3D@var{fmode} Specifies the default mode for newly created files on the host. Works only with security models "mapped-xattr" and "mapped-file". @item dmode=3D@var{dmode} Specifies the default mode for newly created directories on the host. Works only with security models "mapped-xattr" and "mapped-file". +@item throttling.bps-total=3D@var{b},throttling.bps-read=3D@var{r},throttl= ing.bps-write=3D@var{w} +Specify bandwidth throttling limits in bytes per second, either for all re= quest +types or for reads or writes only. +@item throttling.bps-total-max=3D@var{bm},bps-read-max=3D@var{rm},bps-writ= e-max=3D@var{wm} +Specify bursts in bytes per second, either for all request types or for re= ads +or writes only. Bursts allow the guest I/O to spike above the limit +temporarily. +@item throttling.iops-total=3D@var{i},throttling.iops-read=3D@var{r}, thro= ttling.iops-write=3D@var{w} +Specify request rate limits in requests per second, either for all request +types or for reads or writes only. +@item throttling.iops-total-max=3D@var{im},throttling.iops-read-max=3D@var= {irm}, throttling.iops-write-max=3D@var{iwm} +Specify bursts in requests per second, either for all request types or for= reads +or writes only. Bursts allow the guest I/O to spike above the limit tempo= rarily. +@item throttling.iops-size=3D@var{is} +Let every @var{is} bytes of a request count as a new request for iops +throttling purposes. @end table =20 --fsdev option is used along with -device driver "virtio-9p-pci". -@item -device virtio-9p-pci,fsdev=3D@var{id},mount_tag=3D@var{mount_tag} -Options for virtio-9p-pci driver are: +-fsdev option is used along with -device driver "virtio-9p-...". +@item -device virtio-9p-@var{type},fsdev=3D@var{id},mount_tag=3D@var{mount= _tag} +Options for virtio-9p-... driver are: @table @option +@item @var{type} +Specifies the variant to be used. Supported values are "pci", "ccw" or "de= vice", +depending on the machine type. @item fsdev=3D@var{id} -Specifies the id value specified along with -fsdev option +Specifies the id value specified along with -fsdev option. @item mount_tag=3D@var{mount_tag} -Specifies the tag name to be used by the guest to mount this export point +Specifies the tag name to be used by the guest to mount this export point. @end table =20 ETEXI =20 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, - "-virtfs local,path=3Dpath,mount_tag=3Dtag,security_model=3D[mapped-xa= ttr|mapped-file|passthrough|none]\n" - " [,id=3Did][,writeout=3Dimmediate][,readonly][,socket=3Dsocket= |sock_fd=3Dsock_fd][,fmode=3Dfmode][,dmode=3Ddmode]\n", + "-virtfs local,path=3Dpath,mount_tag=3Dtag,security_model=3Dmapped-xat= tr|mapped-file|passthrough|none\n" + " [,id=3Did][,writeout=3Dimmediate][,readonly][,fmode=3Dfmode][= ,dmode=3Ddmode]\n" + "-virtfs proxy,mount_tag=3Dtag,socket=3Dsocket[,id=3Did][,writeout=3Di= mmediate][,readonly]\n" + "-virtfs proxy,mount_tag=3Dtag,sock_fd=3Dsock_fd[,id=3Did][,writeout= =3Dimmediate][,readonly]\n" + "-virtfs synth,mount_tag=3Dtag[,id=3Did][,readonly]\n", QEMU_ARCH_ALL) =20 STEXI =20 -@item -virtfs @var{fsdriver}[,path=3D@var{path}],mount_tag=3D@var{mount_ta= g}[,security_model=3D@var{security_model}][,writeout=3D@var{writeout}][,rea= donly][,socket=3D@var{socket}|sock_fd=3D@var{sock_fd}][,fmode=3D@var{fmode}= ][,dmode=3D@var{dmode}] +@item -virtfs local,path=3D@var{path},mount_tag=3D@var{mount_tag} ,securit= y_model=3D@var{security_model}[,writeout=3D@var{writeout}][,readonly] [,fmo= de=3D@var{fmode}][,dmode=3D@var{dmode}] +@itemx -virtfs proxy,socket=3D@var{socket},mount_tag=3D@var{mount_tag} [,w= riteout=3D@var{writeout}][,readonly] +@itemx -virtfs proxy,sock_fd=3D@var{sock_fd},mount_tag=3D@var{mount_tag} [= ,writeout=3D@var{writeout}][,readonly] +@itemx -virtfs synth,mount_tag=3D@var{mount_tag} @findex -virtfs =20 -The general form of a Virtual File system pass-through options are: +Define a new filesystem device and expose it to the guest using a virtio-9= p-device. The general form of a Virtual File system pass-through options ar= e: @table @option -@item @var{fsdriver} -This option specifies the fs driver backend to use. -Currently "local" and "proxy" file system drivers are supported. +@item local +Accesses to the filesystem are done by QEMU. +@item proxy +Accesses to the filesystem are done by virtfs-proxy-helper(1). +@item synth +Synthetic filesystem, only used by QTests. @item id=3D@var{id} -Specifies identifier for this device +Specifies identifier for the filesystem device @item path=3D@var{path} Specifies the export path for the file system device. Files under this path will be available to the 9p client on the guest. @@ -1348,17 +1385,19 @@ Enables exporting 9p share as a readonly mount for = guests. By default read-write access is given. @item socket=3D@var{socket} Enables proxy filesystem driver to use passed socket file for -communicating with virtfs-proxy-helper. Usually a helper like libvirt -will create socketpair and pass one of the fds as sock_fd +communicating with virtfs-proxy-helper(1). Usually a helper like libvirt +will create socketpair and pass one of the fds as sock_fd. @item sock_fd Enables proxy filesystem driver to use passed 'sock_fd' as the socket -descriptor for interfacing with virtfs-proxy-helper +descriptor for interfacing with virtfs-proxy-helper(1). @item fmode=3D@var{fmode} Specifies the default mode for newly created files on the host. Works only with security models "mapped-xattr" and "mapped-file". @item dmode=3D@var{dmode} Specifies the default mode for newly created directories on the host. Works only with security models "mapped-xattr" and "mapped-file". +@item mount_tag=3D@var{mount_tag} +Specifies the tag name to be used by the guest to mount this export point. @end table ETEXI =20 --=20 2.17.2