From patchwork Tue Sep 8 09:31:09 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefan Hajnoczi X-Patchwork-Id: 305957 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=-3.5 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED autolearn=no 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 DD93DC433E2 for ; Tue, 8 Sep 2020 09:33:53 +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 808992166E for ; Tue, 8 Sep 2020 09:33:53 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="jEMHlVh+" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 808992166E Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:55814 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kFa0e-0007ak-Lj for qemu-devel@archiver.kernel.org; Tue, 08 Sep 2020 05:33:52 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47538) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kFZyJ-0003P5-AQ for qemu-devel@nongnu.org; Tue, 08 Sep 2020 05:31:27 -0400 Received: from us-smtp-1.mimecast.com ([205.139.110.61]:22887 helo=us-smtp-delivery-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kFZyG-0001vW-CW for qemu-devel@nongnu.org; Tue, 08 Sep 2020 05:31:26 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1599557482; 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; bh=/kwpCGtCNpeoNdp7A5E/IVZ7MTOOResHJ+MCxJ1Nrbs=; b=jEMHlVh+pHyIHO5OlxHk5xx/sKYXi0zJpSWaIQyEELLkSvWs2LhKOtbvno+c+VNpf8+Tap gjyY4oNug2OqgR8eGOurzvLLkrKDHUc50M+V/iU18X+v8fhEPh78KCgqW74NqSQhDI2woH 34TOPZxAzWLiZ1SRb9Z0gbGl3nC+DEA= 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-392-aKZF6WoIP-usfzmdxAmYuw-1; Tue, 08 Sep 2020 05:31:19 -0400 X-MC-Unique: aKZF6WoIP-usfzmdxAmYuw-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 960791074642; Tue, 8 Sep 2020 09:31:18 +0000 (UTC) Received: from localhost (ovpn-114-244.ams2.redhat.com [10.36.114.244]) by smtp.corp.redhat.com (Postfix) with ESMTP id D6FDE811BC; Tue, 8 Sep 2020 09:31:14 +0000 (UTC) From: Stefan Hajnoczi To: qemu-devel@nongnu.org Subject: [PATCH 0/4] docs: add qemu-storage-daemon documentation Date: Tue, 8 Sep 2020 10:31:09 +0100 Message-Id: <20200908093113.47564-1-stefanha@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=stefanha@redhat.com X-Mimecast-Spam-Score: 0.003 X-Mimecast-Originator: redhat.com Received-SPF: pass client-ip=205.139.110.61; envelope-from=stefanha@redhat.com; helo=us-smtp-delivery-1.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/08 01:08:25 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.1, 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_P=2E_Berrang=C3=A9?= , qemu-block@nongnu.org, Kashyap Chamarthy , afrosi@redhat.com, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Markus Armbruster , Laszlo Ersek , Stefan Hajnoczi Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Add documentation for the qemu-storage-daemon program and its QMP commands. The man page looks like this: QEMU-STORAGE-DAEMON(1) QEMU QEMU-STORAGE-DAEMON(1) NAME qemu-storage-daemon - QEMU storage daemon 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 running a virtual machine. It can export disk images over NBD, run block job operations, and perform other disk-related operations. The daemon is controlled via a QMP monitor socket and initial configuration from the command-line. The daemon offers the following subset of QEMU features: =C2=B7 Blockdev nodes =C2=B7 Block jobs =C2=B7 NBD server =C2=B7 Character devices =C2=B7 Crypto and secrets =C2=B7 QMP Commands can be sent over a QEMU Monitor Protocol (QMP) connection. See the 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 queryin= g an image that is being modified by another process may encounter inconsistent state. OPTIONS Standard options: -h, --help Display this help and exit -V, --version Display version information and exit -T, --trace [[enable=3D]PATTERN][,events=3DFILE][,file=3DFILE] Specify tracing options. [enable=3D]PATTERN Immediately enable events matching PATTERN (either event= name or a globbing pattern). This option is only available if QEMU has been= compiled with the simple, log or ftrace tracing backend. To specify multiple events o= r patterns, specify the -trace option multiple times. Use -trace help to print a list of names of trace points. events=3DFILE Immediately enable events listed in FILE. The file m= ust contain one event name (as listed in the trace-events-all file) per line;= globbing patterns are accepted too. This option is only available if QEMU has been com= piled with the simple, log or ftrace tracing backend. file=3DFILE Log output traces to FILE. This option is only availabl= e if QEMU has been compiled with the simple tracing backend. --blockdev BLOCKDEVDEF is a blockdev node definition. See the qemu(1) manual page for = a description of blockdev node properties and the qemu-block-drivers(7) manua= l page for a description of driver-specific parameters. --chardev CHARDEVDEF is a character device definition. See the qemu(1) manual p= age for a description of character device properties. A common character devi= ce definition configures a UNIX domain socket: --chardev socket,id=3Dchar1,path=3D/tmp/qmp.sock,server,nowa= it --monitor MONITORDEF is a QMP monitor definition. See the qemu(1) manual page for a = description of QMP monitor properties. A common QMP monitor definition config= ures a monitor on character device char1: --monitor chardev=3Dchar1 --nbd-server addr.type=3Dinet,addr.host=3D,addr.port=3D[,t= ls-creds=3D][,tls-authz=3D] --nbd-server addr.type=3Dunix,addr.path=3D[,tls-creds=3D][,t= ls-authz=3D] is a NBD server definition. Both TCP and UNIX domain sockets ar= e supported. TLS encryption can be configured using --object tls-creds-* and= authz-* 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 --object help --object ,help --object [,=3D...] is a QEMU user creatable object definition. List object typ= es with help. List object properties with ,help. See the qemu(1) manua= l page for a description of the object properties. The most common object type is a secret, whi= ch is used to supply passwords and/or encryption keys. SEE ALSO qemu(1), qemu-block-drivers(7), qemu-storage-daemon-qmp-ref(7) COPYRIGHT 2020, The QEMU Project Developers 5.1.50 Sep 08, 2020 QEMU-STORAGE-DAEMON(1) Stefan Hajnoczi (4): docs: lift block-core.json rST header into parents docs: generate qemu-storage-daemon-qmp-ref(7) man page docs: add qemu-storage-daemon(1) man page MAINTAINERS: add Kevin Wolf as storage daemon maintainer MAINTAINERS | 9 ++ docs/interop/firmware.json | 4 + qapi/block-core.json | 4 - qapi/block.json | 1 + docs/interop/qemu-storage-daemon-qmp-ref.texi | 80 +++++++++++++ docs/tools/conf.py | 2 + docs/tools/index.rst | 1 + docs/tools/qemu-storage-daemon.rst | 105 ++++++++++++++++++ meson.build | 9 ++ storage-daemon/qapi/meson.build | 2 + 10 files changed, 213 insertions(+), 4 deletions(-) create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.texi create mode 100644 docs/tools/qemu-storage-daemon.rst --=20 2.26.2