From nobody Tue May 21 20:55:31 2024 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=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1607510787; cv=none; d=zohomail.com; s=zohoarc; b=MusI803fdE7SPgDyMp7kpwV/kXYaAt7jToN/Td83SE+lmguHoYa2S2eTOpB9UyBlj6B225Yk+gp+A1vNYJK8x1XoQ/IbnsdKlbPk2qn8cY+ndEu8zp+Zf4jXEvVs0M4OT/IBq4F4IYkeiFERTDXnY0nm4aoXXxJXJW4iLaOn8JA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1607510787; h=Content-Type: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=aSFlnPPNsnlstEhWLbzSSNHJELlJMFm5l9F9Az8p8oc=; b=eJcrg8YnB4Vrijq0bjnT7PGsxz5faVlrjy0iDSTUH7pRsVFcW2Al+k5iZdRCoiQG4+7k18IajEQ1kXluLzfYJvpwIKWLVAx83kCrglYBVHomWQt4ljyRpIDpA058GlPvAAuAFSpNPMl2G6GiCHPqIM0RBHZYM2UfzeON7Cyb97E= 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 1607510787682779.4885135857703; Wed, 9 Dec 2020 02:46:27 -0800 (PST) Received: from localhost ([::1]:57342 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kmwzK-0001px-2b for importer@patchew.org; Wed, 09 Dec 2020 05:46:26 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:44740) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kmwre-0003pJ-Dc for qemu-devel@nongnu.org; Wed, 09 Dec 2020 05:38:30 -0500 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:59370) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kmwrS-0007WA-T3 for qemu-devel@nongnu.org; Wed, 09 Dec 2020 05:38:30 -0500 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-495-1Jj2NpIQNLWZyP33eFhJGw-1; Wed, 09 Dec 2020 05:38:13 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 93C445203; Wed, 9 Dec 2020 10:38:12 +0000 (UTC) Received: from localhost (ovpn-115-48.ams2.redhat.com [10.36.115.48]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0FB595D9D3; Wed, 9 Dec 2020 10:38:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1607510297; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=aSFlnPPNsnlstEhWLbzSSNHJELlJMFm5l9F9Az8p8oc=; b=UEMKQAhjfBmNwapL7HUW9KFP4h6srnTvgH6ViEKLTt2yKEQQlMFguKfhSoWE9c48cbjD5B dSReG4CTe99CZ4LfReYX1ZHBm0EUQChk3Hx4s6DK3Gw1Q9Nzig0azVOisnR1GatbDU7m9Z E8H/Vk/PRKFCVHcB7znEUNQ8dbN7zbg= X-MC-Unique: 1Jj2NpIQNLWZyP33eFhJGw-1 From: Stefan Hajnoczi To: qemu-devel@nongnu.org Subject: [PATCH v3 1/3] docs: generate qemu-storage-daemon-qmp-ref(7) man page Date: Wed, 9 Dec 2020 10:38:00 +0000 Message-Id: <20201209103802.350848-2-stefanha@redhat.com> In-Reply-To: <20201209103802.350848-1-stefanha@redhat.com> References: <20201209103802.350848-1-stefanha@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=stefanha@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com 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=216.205.24.124; envelope-from=stefanha@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -3 X-Spam_score: -0.4 X-Spam_bar: / X-Spam_report: (-0.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, MIME_BASE64_TEXT=1.741, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=unavailable 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: Kevin Wolf , Peter Maydell , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , qemu-block@nongnu.org, Kashyap Chamarthy , afrosi@redhat.com, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Markus Armbruster , Stefan Hajnoczi , Laszlo Ersek 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" Although individual qemu-storage-daemon QMP commands are identical to QEMU QMP commands, qemu-storage-daemon only supports a subset of QEMU's QMP commands. Generate a manual page of just the commands supported by qemu-storage-daemon so that users know exactly what is available in qemu-storage-daemon. Add an h1 heading in storage-daemon/qapi/qapi-schema.json so that block-core.json is at the h2 heading level. Signed-off-by: Stefan Hajnoczi --- docs/interop/index.rst | 1 + docs/interop/qemu-storage-daemon-qmp-ref.rst | 13 +++++++++++++ storage-daemon/qapi/qapi-schema.json | 3 +++ docs/interop/conf.py | 2 ++ docs/meson.build | 1 + 5 files changed, 20 insertions(+) create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.rst diff --git a/docs/interop/index.rst b/docs/interop/index.rst index cd78d679d8..95d56495f6 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -20,6 +20,7 @@ Contents: qemu-ga qemu-ga-ref qemu-qmp-ref + qemu-storage-daemon-qmp-ref vhost-user vhost-user-gpu vhost-vdpa diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst b/docs/interop/qe= mu-storage-daemon-qmp-ref.rst new file mode 100644 index 0000000000..caf9dad23a --- /dev/null +++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst @@ -0,0 +1,13 @@ +QEMU Storage Daemon QMP Reference Manual +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. + TODO: the old Texinfo manual used to note that this manual + is GPL-v2-or-later. We should make that reader-visible + both here and in our Sphinx manuals more generally. + +.. + TODO: display the QEMU version, both here and in our Sphinx manuals + more generally. + +.. qapi-doc:: storage-daemon/qapi/qapi-schema.json diff --git a/storage-daemon/qapi/qapi-schema.json b/storage-daemon/qapi/qap= i-schema.json index c6ad5ae1e3..28117c3aac 100644 --- a/storage-daemon/qapi/qapi-schema.json +++ b/storage-daemon/qapi/qapi-schema.json @@ -15,6 +15,9 @@ =20 { 'include': '../../qapi/pragma.json' } =20 +## +# =3D Block devices +## { 'include': '../../qapi/block-core.json' } { 'include': '../../qapi/block-export.json' } { 'include': '../../qapi/char.json' } diff --git a/docs/interop/conf.py b/docs/interop/conf.py index 2634ca3410..f4370aaa13 100644 --- a/docs/interop/conf.py +++ b/docs/interop/conf.py @@ -23,4 +23,6 @@ man_pages =3D [ [], 7), ('qemu-qmp-ref', 'qemu-qmp-ref', 'QEMU QMP Reference Manual', [], 7), + ('qemu-storage-daemon-qmp-ref', 'qemu-storage-daemon-qmp-ref', + 'QEMU Storage Daemon QMP Reference Manual', [], 7), ] diff --git a/docs/meson.build b/docs/meson.build index ebd85d59f9..df5dc50485 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -56,6 +56,7 @@ if build_docs 'qemu-ga.8': (have_tools ? 'man8' : ''), 'qemu-ga-ref.7': 'man7', 'qemu-qmp-ref.7': 'man7', + 'qemu-storage-daemon-qmp-ref.7': (have_tools ? 'man7' : ''), }, 'tools': { 'qemu-img.1': (have_tools ? 'man1' : ''), --=20 2.28.0 From nobody Tue May 21 20:55:31 2024 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=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1607510543; cv=none; d=zohomail.com; s=zohoarc; b=OpgWHrNhS7sAkMrENpMreIJWePqo2XyPT4v97lXorXEaJMiCcnJADurZn03u4CUtKr5PGbMiP15S6n5LnahCn+K3lZHW/z3GhGIuLdcY25dJK8BVAfTtrXZ1dOlDYTHTDYWbTfu4FiSXf+w5bKKQO9PFcsnEQDSOOoq/af1g1/Q= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1607510543; h=Content-Type: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=hreV1IzxceEdbU/nR3Eg4NJVsYEDlrMuEtOPsPEZinE=; b=RHXcbT9eF87w/BcZV07CWLgjRzSCe3eIc+I5E3xit8cHtNFUaUgfMebO+GCGol5RyyVlvPYwyQOr/OLzIup36vAj928UHkmDSQgZ7sWXqissAmgYwLKL8815fJ7l3PBxV+W751CWkvm1EE1OHqi7XmJzCAtLeIALKz7kzOO2Wy4= 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 1607510543374882.6943527207166; Wed, 9 Dec 2020 02:42:23 -0800 (PST) Received: from localhost ([::1]:49798 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kmwvN-0006yD-Mx for importer@patchew.org; Wed, 09 Dec 2020 05:42:21 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:44626) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kmwrU-0003XG-TC for qemu-devel@nongnu.org; Wed, 09 Dec 2020 05:38:20 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:51815) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kmwrS-0007VX-Qk for qemu-devel@nongnu.org; Wed, 09 Dec 2020 05:38:20 -0500 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-142-nakLfyV6Oy-zKe5tQYlDAQ-1; Wed, 09 Dec 2020 05:38:15 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 283CA520E; Wed, 9 Dec 2020 10:38:14 +0000 (UTC) Received: from localhost (ovpn-115-48.ams2.redhat.com [10.36.115.48]) by smtp.corp.redhat.com (Postfix) with ESMTP id B7E5910023AF; Wed, 9 Dec 2020 10:38:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1607510296; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=hreV1IzxceEdbU/nR3Eg4NJVsYEDlrMuEtOPsPEZinE=; b=iBNJVIOAbdfY/vqW7iNUE4VkNmAschu08eGjGkRr9j+YR2LYk0uxaQUtEvfs/kop/lceBK dn2AfAFGqyJzSontt1K79f40VUkAUmwC25g0fYbdcUVbawGuk84G7W5BWGK71jFeU8SCvV 4LiuhV4E1r6vhtoLbjdOygYYQk52fpI= X-MC-Unique: nakLfyV6Oy-zKe5tQYlDAQ-1 From: Stefan Hajnoczi To: qemu-devel@nongnu.org Subject: [PATCH v3 2/3] docs: add qemu-storage-daemon(1) man page Date: Wed, 9 Dec 2020 10:38:01 +0000 Message-Id: <20201209103802.350848-3-stefanha@redhat.com> In-Reply-To: <20201209103802.350848-1-stefanha@redhat.com> References: <20201209103802.350848-1-stefanha@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=stefanha@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com 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=63.128.21.124; envelope-from=stefanha@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -3 X-Spam_score: -0.4 X-Spam_bar: / X-Spam_report: (-0.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, MIME_BASE64_TEXT=1.741, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, 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: Kevin Wolf , Peter Maydell , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , qemu-block@nongnu.org, Kashyap Chamarthy , afrosi@redhat.com, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Markus Armbruster , Stefan Hajnoczi , Laszlo Ersek 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" Document the qemu-storage-daemon tool. Most of the command-line options are identical to their QEMU counterparts. Perhaps Sphinx hxtool integration could be extended to extract documentation for individual command-line options so they can be shared. For now the qemu-storage-daemon simply refers to the qemu(1) man page where the command-line options are identical. Signed-off-by: Stefan Hajnoczi --- docs/tools/index.rst | 1 + docs/tools/qemu-storage-daemon.rst | 148 +++++++++++++++++++++++++++++ docs/tools/conf.py | 2 + 3 files changed, 151 insertions(+) create mode 100644 docs/tools/qemu-storage-daemon.rst diff --git a/docs/tools/index.rst b/docs/tools/index.rst index b99f86c7c6..3a5829c17a 100644 --- a/docs/tools/index.rst +++ b/docs/tools/index.rst @@ -11,6 +11,7 @@ Contents: :maxdepth: 2 =20 qemu-img + qemu-storage-daemon qemu-nbd qemu-pr-helper qemu-trace-stap diff --git a/docs/tools/qemu-storage-daemon.rst b/docs/tools/qemu-storage-d= aemon.rst new file mode 100644 index 0000000000..f63627eaf6 --- /dev/null +++ b/docs/tools/qemu-storage-daemon.rst @@ -0,0 +1,148 @@ +QEMU Storage Daemon +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Synopsis +-------- + +**qemu-storage-daemon** [options] + +Description +----------- + +qemu-storage-daemon provides disk image functionality from QEMU, qemu-img,= and +qemu-nbd in a long-running process controlled via QMP commands without run= ning +a virtual machine. It can export disk images, run block job operations, and +perform other disk-related operations. The daemon is controlled via a QMP +monitor and initial configuration from the command-line. + +The daemon offers the following subset of QEMU features: + +* Block nodes +* Block jobs +* Block exports +* Throttle groups +* Character devices +* Crypto and secrets +* QMP +* IOThreads + +Commands can be sent over a QEMU Monitor Protocol (QMP) connection. See the +:manpage:`qemu-storage-daemon-qmp-ref(7)` manual page for a description of= the +commands. + +The daemon runs until it is stopped using the ``quit`` QMP command or +SIGINT/SIGHUP/SIGTERM. + +**Warning:** Never modify images in use by a running virtual machine or any +other process; this may destroy the image. Also, be aware that querying an +image that is being modified by another process may encounter inconsistent +state. + +Options +------- + +.. program:: qemu-storage-daemon + +Standard options: + +.. option:: -h, --help + + Display help and exit + +.. option:: -V, --version + + Display version information and exit + +.. option:: -T, --trace [[enable=3D]PATTERN][,events=3DFILE][,file=3DFILE] + + .. include:: ../qemu-option-trace.rst.inc + +.. option:: --blockdev BLOCKDEVDEF + + is a block node definition. See the :manpage:`qemu(1)` manual page for a + description of block node properties and the :manpage:`qemu-block-driver= s(7)` + manual page for a description of driver-specific parameters. + +.. option:: --chardev CHARDEVDEF + + is a character device definition. See the :manpage:`qemu(1)` manual page= for + a description of character device properties. A common character device + definition configures a UNIX domain socket:: + + --chardev socket,id=3Dchar1,path=3D/tmp/qmp.sock,server,nowait + +.. option:: --export [type=3D]nbd,id=3D,node-name=3D[,name= =3D][,writable=3Don|off][,bitmap=3D] + --export [type=3D]vhost-user-blk,id=3D,node-name=3D,addr.= type=3Dunix,addr.path=3D[,writable=3Don|off][,logical-block-si= ze=3D][,num-queues=3D] + --export [type=3D]vhost-user-blk,id=3D,node-name=3D,addr.= type=3Dfd,addr.str=3D[,writable=3Don|off][,logical-block-size=3D][,num-queues=3D] + + is a block export definition. ``node-name`` is the block node that shoul= d be + exported. ``writable`` determines whether or not the export allows write + requests for modifying data (the default is off). + + The ``nbd`` export type requires ``--nbd-server`` (see below). ``name`` = is + the NBD export name. ``bitmap`` is the name of a dirty bitmap reachable = from + the block node, so the NBD client can use NBD_OPT_SET_META_CONTEXT with = the + metadata context name "qemu:dirty-bitmap:BITMAP" to inspect the bitmap. + + The ``vhost-user-blk`` export type takes a vhost-user socket address on = which + it accept incoming connections. Both + ``addr.type=3Dunix,addr.path=3D`` for UNIX domain sockets a= nd + ``addr.type=3Dfd,addr.str=3D`` for file descriptor passing are suppo= rted. + ``logical-block-size`` sets the logical block size in bytes (the default= is + 512). ``num-queues`` sets the number of virtqueues (the default is 1). + +.. option:: --monitor MONITORDEF + + is a QMP monitor definition. See the :manpage:`qemu(1)` manual page for + a description of QMP monitor properties. A common QMP monitor definition + configures a monitor on character device ``char1``:: + + --monitor chardev=3Dchar1 + +.. option:: --nbd-server addr.type=3Dinet,addr.host=3D,addr.port=3D<= port>[,tls-creds=3D][,tls-authz=3D][,max-connections=3D] + --nbd-server addr.type=3Dunix,addr.path=3D[,tls-creds=3D][,tls= -authz=3D][,max-connections=3D] + + is a server for NBD exports. Both TCP and UNIX domain sockets are suppor= ted. + TLS encryption can be configured using ``--object`` tls-creds-* and auth= z-* + secrets (see below). + + To configure an NBD server on UNIX domain socket path ``/tmp/nbd.sock``:: + + --nbd-server addr.type=3Dunix,addr.path=3D/tmp/nbd.sock + +.. option:: --object help + --object ,help + --object [,=3D...] + + is a QEMU user creatable object definition. List object types with ``hel= p``. + List object properties with ``,help``. See the :manpage:`qemu(1)` + manual page for a description of the object properties. + +Examples +-------- +Launch the daemon with QMP monitor socket ``qmp.sock`` so clients can exec= ute +QMP commands:: + + $ qemu-storage-daemon \ + --chardev socket,path=3Dqmp.sock,server,nowait,id=3Dchar1 \ + --monitor chardev=3Dchar1 + +Export raw image file ``disk.img`` over NBD UNIX domain socket ``nbd.sock`= `:: + + $ qemu-storage-daemon \ + --blockdev driver=3Dfile,node-name=3Ddisk,filename=3Ddisk.img \ + --nbd-server addr.type=3Dunix,addr.path=3Dnbd.sock \ + --export type=3Dnbd,id=3Dexport,node-name=3Ddisk,writable=3Don + +Export a qcow2 image file ``disk.qcow2`` as a vhosts-user-blk device over = UNIX +domain socket ``vhost-user-blk.sock``:: + + $ qemu-storage-daemon \ + --blockdev driver=3Dfile,node-name=3Dfile,filename=3Ddisk.qcow2 \ + --blockdev driver=3Dqcow2,node-name=3Dqcow2,file=3Dfile \ + --export type=3Dvhost-user-blk,id=3Dexport,addr.type=3Dunix,addr.pat= h=3Dvhost-user-blk.sock,node-name=3Dqcow2 + +See also +-------- + +:manpage:`qemu(1)`, :manpage:`qemu-block-drivers(7)`, :manpage:`qemu-stora= ge-daemon-qmp-ref(7)` diff --git a/docs/tools/conf.py b/docs/tools/conf.py index 4760d36ff2..7072d99324 100644 --- a/docs/tools/conf.py +++ b/docs/tools/conf.py @@ -20,6 +20,8 @@ html_theme_options['description'] =3D \ man_pages =3D [ ('qemu-img', 'qemu-img', u'QEMU disk image utility', ['Fabrice Bellard'], 1), + ('qemu-storage-daemon', 'qemu-storage-daemon', u'QEMU storage daemon', + [], 1), ('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server', ['Anthony Liguori '], 8), ('qemu-pr-helper', 'qemu-pr-helper', 'QEMU persistent reservation help= er', --=20 2.28.0 From nobody Tue May 21 20:55:31 2024 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=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1607510500; cv=none; d=zohomail.com; s=zohoarc; b=EQv2js1g42f7QyyN1v3SpB0OVOG74vJ/Jsyz1m+Dx7UVYDBcRY80c4GSlAECjSmdFtfwQ6X4GlXHUVgp1AnXpLDkK7iZbrEDyJWWb5yavI9AdKNz86sqTiyqrIOiEAlM3bhf1sK+i7ty56o51X4aPaMGQz05Vssb+FkRk++eMb4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1607510500; h=Content-Type: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=5FFZucyiN8e3EVU9t97lvTtOxjCtUDTOCND4Sc1aaDU=; b=iNCdZJrtCNIy1Z5H3n5PDUKH+n50xp/js5Z/UmBwIu/yRj2OAKgCG/f/wYvTtwng/bKK9lWuLUCD/fyz8zNIxdyj//cmfMatpUpSWtlLGszarAelMLufH99fXK5PjhiOHhWZvSg4McQ0288Np1tC6x3OvSPlC4i5xAsgEAxW1qU= 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 1607510500741663.3737744550153; Wed, 9 Dec 2020 02:41:40 -0800 (PST) Received: from localhost ([::1]:48706 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kmwuh-0006X5-GK for importer@patchew.org; Wed, 09 Dec 2020 05:41:39 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:44690) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kmwra-0003ea-1N for qemu-devel@nongnu.org; Wed, 09 Dec 2020 05:38:26 -0500 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:56182) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kmwrY-0007YT-Ch for qemu-devel@nongnu.org; Wed, 09 Dec 2020 05:38:25 -0500 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-133-M4SNVbhlMbC7xRjgIAkzwA-1; Wed, 09 Dec 2020 05:38:20 -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 02E6D1005504; Wed, 9 Dec 2020 10:38:19 +0000 (UTC) Received: from localhost (ovpn-115-48.ams2.redhat.com [10.36.115.48]) by smtp.corp.redhat.com (Postfix) with ESMTP id 76A156064B; Wed, 9 Dec 2020 10:38:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1607510303; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=5FFZucyiN8e3EVU9t97lvTtOxjCtUDTOCND4Sc1aaDU=; b=iXcHuGz/LK/n928Gv4hG3u1CQlasSAaY548vskAqgBDosriD3vA1JDeTFXzGtWrWicwlEw PKaSAd4pEpJhpi7YY7ijyHv9fb242ZsmrP83FcVsjymUHX/t9oOW5kDtZPVOn84RFgTaUR kJJBAWbcOjsV2On0zX3LQGKwJyU9BLo= X-MC-Unique: M4SNVbhlMbC7xRjgIAkzwA-1 From: Stefan Hajnoczi To: qemu-devel@nongnu.org Subject: [PATCH v3 3/3] MAINTAINERS: add Kevin Wolf as storage daemon maintainer Date: Wed, 9 Dec 2020 10:38:02 +0000 Message-Id: <20201209103802.350848-4-stefanha@redhat.com> In-Reply-To: <20201209103802.350848-1-stefanha@redhat.com> References: <20201209103802.350848-1-stefanha@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=stefanha@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com 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=216.205.24.124; envelope-from=stefanha@redhat.com; helo=us-smtp-delivery-124.mimecast.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, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=unavailable 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: Kevin Wolf , Peter Maydell , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , qemu-block@nongnu.org, Kashyap Chamarthy , afrosi@redhat.com, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Markus Armbruster , Stefan Hajnoczi , Laszlo Ersek 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" The MAINTAINERS file was not updated when the storage daemon was merged. Signed-off-by: Stefan Hajnoczi Acked-by: Kevin Wolf Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- MAINTAINERS | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 68bc160f41..8676730cc9 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2146,6 +2146,15 @@ F: qobject/block-qdict.c F: tests/check-block-qdict.c T: git https://repo.or.cz/qemu/kevin.git block =20 +Storage daemon +M: Kevin Wolf +L: qemu-block@nongnu.org +S: Supported +F: storage-daemon/ +F: docs/interop/qemu-storage-daemon-qmp-ref.rst +F: docs/tools/qemu-storage-daemon.rst +T: git https://repo.or.cz/qemu/kevin.git block + Block I/O path M: Stefan Hajnoczi M: Fam Zheng --=20 2.28.0