From nobody Fri May 10 12:47:34 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; 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=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1682003232; cv=none; d=zohomail.com; s=zohoarc; b=aJy5xuD5kBYRX4fgQk9+s/fBSWhH8HEa1I/K/S5grbgYRheBEelL3j8u0/1WSWQQQlbEhULpAjO8q5g54lYftB48p5jT+Mu6sPW6TdbqDi88l3AmRRJ8aC53QxemFvmX10qMM9OrN41I5ADo44jl7aCHQcbSh0Qv18W4k9Twl7c= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1682003232; h=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=wQYohNT3C43uNg5/LiZIVBTCcgpU3EnfVN9UI96atEY=; b=mDqODzQCo+0mYL0IUiV1kp1w0204Y7h/WraEbzBHiLEtY1FKMiB03DwH44polCbmduJ5B1UN39CXWbdxMzaF+VVJt23EABQbSXspimPP2uLmrLNpGRXKw97OxHO75rTPPvM80CJJYDOnWzlFedlIC8OdUz5G5aTtouWhM1MSPBE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; 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=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1682003232943410.04922898011887; Thu, 20 Apr 2023 08:07:12 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppVpV-0004Vn-Ev; Thu, 20 Apr 2023 11:04:13 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppVpI-0003OP-0V for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:04:04 -0400 Received: from mail-wm1-x334.google.com ([2a00:1450:4864:20::334]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppVpE-0004zU-Tf for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:03:59 -0400 Received: by mail-wm1-x334.google.com with SMTP id eo4-20020a05600c82c400b003f05a99a841so1281183wmb.3 for ; Thu, 20 Apr 2023 08:03:56 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id y32-20020a05600c342000b003f173956a82sm5542458wmp.21.2023.04.20.08.03.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:03:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682003035; x=1684595035; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=wQYohNT3C43uNg5/LiZIVBTCcgpU3EnfVN9UI96atEY=; b=KJovJjaQQ+GlT1Amcrk1B4Zyrzkn6xfDuj7ogsNhkQlxT0e5D14LiWh92VNeB9rxBt Zw9ZxtLKhLpigV082ppCUkNXeTbOOlQo0aksZdV0iU2BHI31/h0nXAndLj59vk1TT4ME ZZofz1aCqL2Cz4xfxeASSApeDyIxOGEHk/BFBTOg+I98G57srVnG44jykXzhVVGzkcb5 AEokkUvWj2FSxJf4P9T17d2OWyjHFLgm2X4mokd++BK55y3O2VGVJEQYD38EDEEtOW83 jxOhTioh0bt3q0MsZBq6oGw+oIVCnWmCTnwn5Grr0gDV7KMmFh4PBUmk3ea6QFitD/hS w2jA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682003035; x=1684595035; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=wQYohNT3C43uNg5/LiZIVBTCcgpU3EnfVN9UI96atEY=; b=hM2GaODPf9f/4sQZ45diyUK5aMLDYZRvNbmQSOyWBu2JVOKzfZpgECuBkF/RqbfD8a yfilY5CzXh5Oqldc7ce6y9/VvwSIV2MbNqvUSt4hgNIzCXQz2weZ1Gtwp6EuJMlE2rMm yE1TBDh6lnyFddPIA+gfYwEfRM3ywq9QSmAEcU9OAqivmPbHJ3tomviahJ5bFW1cCt89 NWzRLhUv+ELJcD1JcdQ3Vbj8h6csljHyDrh+3gtn+NmDVmKIcXwU3fkOvq0EyrN0vJxe MNwJxYDo+e4srx78zl9yt5OgRq6oywtq8pN1eePSAFPL90uYfc61YKEkzb1jBtYLI4oa Q+gw== X-Gm-Message-State: AAQBX9fP5PCVK4Q2ki5+8Wd0ou/Nvd4Atzn8mZvc7uLsAyOswiwcyF5p mZ7531kCJNP6+P9hlH1GILF5TcOU7VzM8JWT+Ao= X-Google-Smtp-Source: AKy350a+jI/wM3/0/HHG9viJGaSfca5PEkKTCYB8WS1ZLeNhoWsx/0WmaHU55WymS03vDrzgBUrMXg== X-Received: by 2002:a1c:ed05:0:b0:3f1:72f8:6a92 with SMTP id l5-20020a1ced05000000b003f172f86a92mr1393900wmh.20.1682003035000; Thu, 20 Apr 2023 08:03:55 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Markus Armbruster Subject: [PATCH 1/2] docs/interop: Convert qmp-spec.txt to rST Date: Thu, 20 Apr 2023 16:03:51 +0100 Message-Id: <20230420150352.1039408-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230420150352.1039408-1-peter.maydell@linaro.org> References: <20230420150352.1039408-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::334; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x334.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1682003259391100001 Content-Type: text/plain; charset="utf-8" Convert the qmp-spec.txt document to restructuredText. Notable points about the conversion: * numbers at the start of section headings are removed, to match the style of the rest of the manual * cross-references to other sections or documents are hyperlinked * various formatting tweaks (notably the examples, which need the -> and <- prefixed so the QMP code-block lexer will accept them) Signed-off-by: Peter Maydell Reviewed-by: Eric Blake --- docs/interop/index.rst | 1 + docs/interop/{qmp-spec.txt =3D> qmp-spec.rst} | 325 +++++++++++--------- 2 files changed, 180 insertions(+), 146 deletions(-) rename docs/interop/{qmp-spec.txt =3D> qmp-spec.rst} (57%) diff --git a/docs/interop/index.rst b/docs/interop/index.rst index 6351ff9ba6e..ed65395bfb2 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -15,6 +15,7 @@ are useful for making QEMU interoperate with other softwa= re. dbus-display live-block-operations pr-helper + qmp-spec qemu-ga qemu-ga-ref qemu-qmp-ref diff --git a/docs/interop/qmp-spec.txt b/docs/interop/qmp-spec.rst similarity index 57% rename from docs/interop/qmp-spec.txt rename to docs/interop/qmp-spec.rst index b0e8351d5b2..545098c9931 100644 --- a/docs/interop/qmp-spec.txt +++ b/docs/interop/qmp-spec.rst @@ -1,24 +1,26 @@ - QEMU Machine Protocol Specification +.. + Copyright (C) 2009-2016 Red Hat, Inc. =20 -0. About This Document -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + This work is licensed under the terms of the GNU GPL, version 2 or + later. See the COPYING file in the top-level directory. =20 -Copyright (C) 2009-2016 Red Hat, Inc. =20 -This work is licensed under the terms of the GNU GPL, version 2 or -later. See the COPYING file in the top-level directory. +=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 +QEMU Machine Protocol Specification +=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 =20 -1. Introduction -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -This document specifies the QEMU Machine Protocol (QMP), a JSON-based +The QEMU Machine Protocol (QMP) is a JSON-based protocol which is available for applications to operate QEMU at the machine-level. It is also in use by the QEMU Guest Agent (QGA), which is available for host applications to interact with the guest -operating system. +operating system. This page specifies the general format of +the protocol; details of the commands and data structures can +be found in the :doc:`qemu-qmp-ref` and the :doc:`qemu-ga-ref`. =20 -2. Protocol Specification -=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 +.. contents:: + +Protocol Specification +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 This section details the protocol format. For the purpose of this document, "Server" is either QEMU or the QEMU Guest Agent, and @@ -30,9 +32,7 @@ following format: json-DATA-STRUCTURE-NAME =20 Where DATA-STRUCTURE-NAME is any valid JSON data structure, as defined -by the JSON standard: - -http://www.ietf.org/rfc/rfc8259.txt +by the `JSON standard `_. =20 The server expects its input to be encoded in UTF-8, and sends its output encoded in ASCII. @@ -45,83 +45,89 @@ important unless specifically documented otherwise. Re= peating a key within a json-object gives unpredictable results. =20 Also for convenience, the server will accept an extension of -'single-quoted' strings in place of the usual "double-quoted" +``'single-quoted'`` strings in place of the usual ``"double-quoted"`` json-string, and both input forms of strings understand an additional -escape sequence of "\'" for a single quote. The server will only use +escape sequence of ``\'`` for a single quote. The server will only use double quoting on output. =20 -2.1 General Definitions ------------------------ - -2.1.1 All interactions transmitted by the Server are json-objects, always - terminating with CRLF - -2.1.2 All json-objects members are mandatory when not specified otherwise - -2.2 Server Greeting +General Definitions ------------------- =20 +All interactions transmitted by the Server are json-objects, always +terminating with CRLF. + +All json-objects members are mandatory when not specified otherwise. + +Server Greeting +--------------- + Right when connected the Server will issue a greeting message, which signa= ls that the connection has been successfully established and that the Server = is ready for capabilities negotiation (for more information refer to section -'4. Capabilities Negotiation'). +`Capabilities Negotiation`_). =20 The greeting message format is: =20 -{ "QMP": { "version": json-object, "capabilities": json-array } } +.. code-block:: =20 - Where, + { "QMP": { "version": json-object, "capabilities": json-array } } =20 -- The "version" member contains the Server's version information (the form= at +Where: + +- The ``version`` member contains the Server's version information (the fo= rmat is the same of the query-version command) -- The "capabilities" member specify the availability of features beyond the +- The ``capabilities`` member specifies the availability of features beyon= d the baseline specification; the order of elements in this array has no particular significance. =20 -2.2.1 Capabilities ------------------- +Capabilities +------------ =20 Currently supported capabilities are: =20 -- "oob": the QMP server supports "out-of-band" (OOB) command - execution, as described in section "2.3.1 Out-of-band execution". +``oob`` + the QMP server supports "out-of-band" (OOB) command + execution, as described in section `Out-of-band execution`_. =20 -2.3 Issuing Commands --------------------- +Issuing Commands +---------------- =20 The format for command execution is: =20 -{ "execute": json-string, "arguments": json-object, "id": json-value } +.. code-block:: + + { "execute": json-string, "arguments": json-object, "id": json-value } =20 or =20 -{ "exec-oob": json-string, "arguments": json-object, "id": json-value } +.. code-block:: =20 - Where, + { "exec-oob": json-string, "arguments": json-object, "id": json-value } =20 -- The "execute" or "exec-oob" member identifies the command to be +Where: + +- The ``execute`` or ``exec-oob`` member identifies the command to be executed by the server. The latter requests out-of-band execution. -- The "arguments" member is used to pass any arguments required for the +- The ``arguments`` member is used to pass any arguments required for the execution of the command, it is optional when no arguments are required. Each command documents what contents will be considered valid when handling the json-argument -- The "id" member is a transaction identification associated with the +- The ``id`` member is a transaction identification associated with the command execution, it is optional and will be part of the response - if provided. The "id" member can be any json-value. A json-number + if provided. The ``id`` member can be any json-value. A json-number incremented for each successive command works fine. =20 -The actual commands are documented in the QEMU QMP reference manual -docs/interop/qemu-qmp-ref.{7,html,info,pdf,txt}. +The actual commands are documented in the :doc:`qemu-qmp-ref`. =20 -2.3.1 Out-of-band execution ---------------------------- +Out-of-band execution +--------------------- =20 The server normally reads, executes and responds to one command after the other. The client therefore receives command responses in issue order. =20 -With out-of-band execution enabled via capability negotiation (section -4.), the server reads and queues commands as they arrive. It executes +With out-of-band execution enabled via `capabilities negotiation`_, +the server reads and queues commands as they arrive. It executes commands from the queue one after the other. Commands executed out-of-band jump the queue: the command get executed right away, possibly overtaking prior in-band commands. The client may therefore @@ -129,8 +135,8 @@ receive such a command's response before responses from= prior in-band commands. =20 To be able to match responses back to their commands, the client needs -to pass "id" with out-of-band commands. Passing it with all commands -is recommended for clients that accept capability "oob". +to pass ``id`` with out-of-band commands. Passing it with all commands +is recommended for clients that accept capability ``oob``. =20 If the client sends in-band commands faster than the server can execute them, the server will stop reading requests until the request @@ -140,57 +146,61 @@ To ensure commands to be executed out-of-band get rea= d and executed, the client should have at most eight in-band commands in flight. =20 Only a few commands support out-of-band execution. The ones that do -have "allow-oob": true in output of query-qmp-schema. +have ``"allow-oob": true`` in the output of ``query-qmp-schema``. =20 -2.4 Commands Responses ----------------------- +Commands Responses +------------------ =20 There are two possible responses which the Server will issue as the result of a command execution: success or error. =20 -As long as the commands were issued with a proper "id" field, then the -same "id" field will be attached in the corresponding response message +As long as the commands were issued with a proper ``id`` field, then the +same ``id`` field will be attached in the corresponding response message so that requests and responses can match. Clients should drop all the -responses that have an unknown "id" field. +responses that have an unknown ``id`` field. =20 -2.4.1 success -------------- +Success +------- =20 The format of a success response is: =20 -{ "return": json-value, "id": json-value } +.. code-block:: =20 - Where, + { "return": json-value, "id": json-value } =20 -- The "return" member contains the data returned by the command, which +Where: + +- The ``return`` member contains the data returned by the command, which is defined on a per-command basis (usually a json-object or json-array of json-objects, but sometimes a json-number, json-string, or json-array of json-strings); it is an empty json-object if the command does not return data -- The "id" member contains the transaction identification associated +- The ``id`` member contains the transaction identification associated with the command execution if issued by the Client =20 -2.4.2 error ------------ +Error +----- =20 The format of an error response is: =20 -{ "error": { "class": json-string, "desc": json-string }, "id": json-value= } +.. code-block:: =20 - Where, + { "error": { "class": json-string, "desc": json-string }, "id": json-val= ue } =20 -- The "class" member contains the error class name (eg. "GenericError") -- The "desc" member is a human-readable error message. Clients should +Where: + +- The ``class`` member contains the error class name (eg. ``"GenericError"= ``) +- The ``desc`` member is a human-readable error message. Clients should not attempt to parse this message. -- The "id" member contains the transaction identification associated with +- The ``id`` member contains the transaction identification associated with the command execution if issued by the Client =20 -NOTE: Some errors can occur before the Server is able to read the "id" mem= ber, -in these cases the "id" member will not be part of the error response, even +NOTE: Some errors can occur before the Server is able to read the ``id`` m= ember; +in these cases the ``id`` member will not be part of the error response, e= ven if provided by the client. =20 -2.5 Asynchronous events ------------------------ +Asynchronous events +------------------- =20 As a result of state changes, the Server may send messages unilaterally to the Client at any time, when not in the middle of any other @@ -198,44 +208,45 @@ response. They are called "asynchronous events". =20 The format of asynchronous events is: =20 -{ "event": json-string, "data": json-object, - "timestamp": { "seconds": json-number, "microseconds": json-number } } +.. code-block:: =20 - Where, + { "event": json-string, "data": json-object, + "timestamp": { "seconds": json-number, "microseconds": json-number } } =20 -- The "event" member contains the event's name -- The "data" member contains event specific data, which is defined in a - per-event basis, it is optional -- The "timestamp" member contains the exact time of when the event +Where: + +- The ``event`` member contains the event's name +- The ``data`` member contains event specific data, which is defined in a + per-event basis. It is optional +- The ``timestamp`` member contains the exact time of when the event occurred in the Server. It is a fixed json-object with time in seconds and microseconds relative to the Unix Epoch (1 Jan 1970); if there is a failure to retrieve host time, both members of the timestamp will be set to -1. =20 -The actual asynchronous events are documented in the QEMU QMP -reference manual docs/interop/qemu-qmp-ref.{7,html,info,pdf,txt}. +The actual asynchronous events are documented in the :doc:`qemu-qmp-ref`. =20 Some events are rate-limited to at most one per second. If additional "similar" events arrive within one second, all but the last one are dropped, and the last one is delayed. "Similar" normally means same event type. =20 -2.6 Forcing the JSON parser into known-good state -------------------------------------------------- +Forcing the JSON parser into known-good state +--------------------------------------------- =20 Incomplete or invalid input can leave the server's JSON parser in a state where it can't parse additional commands. To get it back into known-good state, the client should provoke a lexical error. =20 The cleanest way to do that is sending an ASCII control character -other than '\t' (horizontal tab), '\r' (carriage return), or '\n' (new -line). +other than ``\t`` (horizontal tab), ``\r`` (carriage return), or +``\n`` (new line). =20 Sadly, older versions of QEMU can fail to flag this as an error. If a client needs to deal with them, it should send a 0xFF byte. =20 -2.7 QGA Synchronization ------------------------ +QGA Synchronization +------------------- =20 When a client connects to QGA over a transport lacking proper connection semantics such as virtio-serial, QGA may have read partial @@ -243,86 +254,106 @@ input from a previous client. The client needs to f= orce QGA's parser into known-good state using the previous section's technique. Moreover, the client may receive output a previous client didn't read. To help with skipping that output, QGA provides the -'guest-sync-delimited' command. Refer to its documentation for +``guest-sync-delimited`` command. Refer to its documentation for details. =20 =20 -3. QMP Examples -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +QMP Examples +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 This section provides some examples of real QMP usage, in all of them -"C" stands for "Client" and "S" stands for "Server". +``->`` marks text sent by the Client and ``<-`` marks replies by the Serve= r. =20 -3.1 Server greeting -------------------- +.. admonition:: Example =20 -S: { "QMP": {"version": {"qemu": {"micro": 0, "minor": 0, "major": 3}, - "package": "v3.0.0"}, "capabilities": ["oob"] } } + Server greeting =20 -3.2 Capabilities negotiation ----------------------------- + .. code-block:: QMP =20 -C: { "execute": "qmp_capabilities", "arguments": { "enable": ["oob"] } } -S: { "return": {}} + <- { "QMP": {"version": {"qemu": {"micro": 0, "minor": 0, "major": 3}, + "package": "v3.0.0"}, "capabilities": ["oob"] } } =20 -3.3 Simple 'stop' execution ---------------------------- +.. admonition:: Example =20 -C: { "execute": "stop" } -S: { "return": {} } + Capabilities negotiation =20 -3.4 KVM information -------------------- + .. code-block:: QMP =20 -C: { "execute": "query-kvm", "id": "example" } -S: { "return": { "enabled": true, "present": true }, "id": "example"} + -> { "execute": "qmp_capabilities", "arguments": { "enable": ["oob"] }= } + <- { "return": {}} =20 -3.5 Parsing error ------------------- +.. admonition:: Example =20 -C: { "execute": } -S: { "error": { "class": "GenericError", "desc": "Invalid JSON syntax" } } + Simple 'stop' execution =20 -3.6 Powerdown event -------------------- + .. code-block:: QMP =20 -S: { "timestamp": { "seconds": 1258551470, "microseconds": 802384 }, - "event": "POWERDOWN" } + -> { "execute": "stop" } + <- { "return": {} } =20 -3.7 Out-of-band execution -------------------------- +.. admonition:: Example =20 -C: { "exec-oob": "migrate-pause", "id": 42 } -S: { "id": 42, - "error": { "class": "GenericError", - "desc": "migrate-pause is currently only supported during postcopy-a= ctive state" } } + KVM information + + .. code-block:: QMP + + -> { "execute": "query-kvm", "id": "example" } + <- { "return": { "enabled": true, "present": true }, "id": "example"} + +.. admonition:: Example + + Parsing error + + .. code-block:: QMP + + -> { "execute": } + <- { "error": { "class": "GenericError", "desc": "Invalid JSON syntax"= } } + +.. admonition:: Example + + Powerdown event + + .. code-block:: QMP + + <- { "timestamp": { "seconds": 1258551470, "microseconds": 802384 }, + "event": "POWERDOWN" } + +.. admonition:: Example + + Out-of-band execution + + .. code-block:: QMP + + -> { "exec-oob": "migrate-pause", "id": 42 } + <- { "id": 42, + "error": { "class": "GenericError", + "desc": "migrate-pause is currently only supported during postco= py-active state" } } =20 =20 -4. Capabilities Negotiation -=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 +Capabilities Negotiation +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 When a Client successfully establishes a connection, the Server is in Capabilities Negotiation mode. =20 -In this mode only the qmp_capabilities command is allowed to run, all -other commands will return the CommandNotFound error. Asynchronous +In this mode only the ``qmp_capabilities`` command is allowed to run; all +other commands will return the ``CommandNotFound`` error. Asynchronous messages are not delivered either. =20 -Clients should use the qmp_capabilities command to enable capabilities -advertised in the Server's greeting (section '2.2 Server Greeting') they -support. +Clients should use the ``qmp_capabilities`` command to enable capabilities +advertised in the `Server Greeting`_ which they support. =20 -When the qmp_capabilities command is issued, and if it does not return an -error, the Server enters in Command mode where capabilities changes take -effect, all commands (except qmp_capabilities) are allowed and asynchronous +When the ``qmp_capabilities`` command is issued, and if it does not return= an +error, the Server enters Command mode where capabilities changes take +effect, all commands (except ``qmp_capabilities``) are allowed and asynchr= onous messages are delivered. =20 -5 Compatibility Considerations -=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 +Compatibility Considerations +=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 =20 All protocol changes or new features which modify the protocol format in an incompatible way are disabled by default and will be advertised by the -capabilities array (section '2.2 Server Greeting'). Thus, Clients can check +capabilities array (in the `Server Greeting`_). Thus, Clients can check that array and enable the capabilities they support. =20 The QMP Server performs a type check on the arguments to a command. It @@ -342,7 +373,7 @@ However, Clients must not assume any particular: - Amount of errors generated by a command, that is, new errors can be added to any existing command in newer versions of the Server =20 -Any command or member name beginning with "x-" is deemed experimental, +Any command or member name beginning with ``x-`` is deemed experimental, and may be withdrawn or changed in an incompatible manner in a future release. =20 @@ -350,8 +381,8 @@ Of course, the Server does guarantee to send valid JSON= . But apart from this, a Client should be "conservative in what they send, and liberal in what they accept". =20 -6. Downstream extension of QMP -=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 +Downstream extension of QMP +=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 =20 We recommend that downstream consumers of QEMU do *not* modify QMP. Management tools should be able to support both upstream and downstream @@ -363,23 +394,25 @@ avoid modifying QMP. Both upstream and downstream ne= ed to take care to preserve long-term compatibility and interoperability. =20 To help with that, QMP reserves JSON object member names beginning with -'__' (double underscore) for downstream use ("downstream names"). This +``__`` (double underscore) for downstream use ("downstream names"). This means upstream will never use any downstream names for its commands, arguments, errors, asynchronous events, and so forth. =20 -Any new names downstream wishes to add must begin with '__'. To +Any new names downstream wishes to add must begin with ``__``. To ensure compatibility with other downstreams, it is strongly -recommended that you prefix your downstream names with '__RFQDN_' where +recommended that you prefix your downstream names with ``__RFQDN_`` where RFQDN is a valid, reverse fully qualified domain name which you control. For example, a qemu-kvm specific monitor command would be: =20 +.. code-block:: + (qemu) __org.linux-kvm_enable_irqchip =20 -Downstream must not change the server greeting (section 2.2) other than +Downstream must not change the `server greeting`_ other than to offer additional capabilities. But see below for why even that is discouraged. =20 -Section '5 Compatibility Considerations' applies to downstream as well +The section `Compatibility Considerations`_ applies to downstream as well as to upstream, obviously. It follows that downstream must behave exactly like upstream for any input not containing members with downstream names ("downstream members"), except it may add members --=20 2.34.1 From nobody Fri May 10 12:47:34 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; 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=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1682003266; cv=none; d=zohomail.com; s=zohoarc; b=P+Rt0P6MXZpV8Jl6rv26OawnuF2brE3gnqbIKe7+8cjAejC63uUQnx8+o000GFDf3CsQ3tNxiF+Zga1Ug2y9lv7HNJY6lC7xdq5NlAV07tlnZQTbeQ2QQFp83l52cOL9SYjdWxGKE9iCAMo9r53vyE99YoZV90fpPYU/x+2wzS8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1682003266; h=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=ZbSk7BG+pPYbXSNkcmisOU5yI5C0OADLfXQ8nDPotNk=; b=AJ8px9iDwyslDN2LyuUPLAcxkTopScN7+TMIYqeeGq83tsFVS01R++qe+DN9VAIkMf9Z2DVmQ9HnLMLynkqBrVWHd0OKdatnj3H0uPYYsVIuroDJ8p7yv6mYNtBCEzLkfNBJF/cnxM9HG/33AxWEw4+UCJfywUgqGapcf+eFZMI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; 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=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1682003266863995.1883669761461; Thu, 20 Apr 2023 08:07:46 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppVpW-0004bo-MR; Thu, 20 Apr 2023 11:04:14 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppVpU-0004TN-K7 for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:04:12 -0400 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppVpF-0004zW-1v for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:04:12 -0400 Received: by mail-wm1-x32c.google.com with SMTP id l31-20020a05600c1d1f00b003f1718d89b2so3256278wms.0 for ; Thu, 20 Apr 2023 08:03:56 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [2001:8b0:1d0::2]) by smtp.gmail.com with ESMTPSA id y32-20020a05600c342000b003f173956a82sm5542458wmp.21.2023.04.20.08.03.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:03:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682003035; x=1684595035; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=ZbSk7BG+pPYbXSNkcmisOU5yI5C0OADLfXQ8nDPotNk=; b=VCErB2+5xXmL9LiIHMfwC96mWIP478/dwHuQuaM3M9w9UTZYR38koKuottg9UpvEuA I9ChBgBflxx2HBSLcfuMX2Q5ihIGM9XU1rhZO+Vijqmoug+eEBi46vfzhxhLa0Ds3Sqp L2Ub3fpS8qZoGN6geLAmgkEBdYYNp1QjIqOuv5kSkGnq88LodF5cUFYa8DFy/d9GB76/ 2gfWFBqnAcFxfIieK6CFCQGxsOdzdnV4wI5ifuTvxxZd68InGnVTPgyeFOYjWHBZcxbo ZhafLstX6tZnebulCP2fRF0CjqquWqabgk7WG/OnO3pN9GeMN2gP4NXgfq3bMqMW6I18 SNPg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682003035; x=1684595035; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=ZbSk7BG+pPYbXSNkcmisOU5yI5C0OADLfXQ8nDPotNk=; b=WfLlahrSx+UhreP/wohEDjGAfyJKbsjRJ0INonrjDCqcAV5g1jNLfYJ65bx2agEh2H zouMDkLPc5GcJ83S1VJXYij5vNC1dP+c0EVOWgh8mSCT/gC4oMXAcWB22z6g3yzsvLom kN9AK6Nw09EA2L7NRRS1jkzsid3ZOLAc/mTwqb59IAceTFxig1PyzIkUWR3Bh9rPqXHO XRglI0S/FHS20Cv1yWU9NF0wXXlGAIwm8FjOHLb5+PcdpTxEP74IBSuGSJxHLNV3SXXK r/E9+/+J82tlBtwUrX2ITFzR0wWEq5p0FcEco+VE3ZiVHc6sB87+6BxhGK1GqiZZN2OH 7/7A== X-Gm-Message-State: AAQBX9cLMhNb23MWLAHMI8Lz/Jwa3cYP1VPQ0gl0JPhpX3/JQSx/EYLa fzQ+LHIGn5f2IE/H6IxOFfSvLRIJwY8JjzS3V5U= X-Google-Smtp-Source: AKy350YwjylXLzJNyETVcqed0zragRGbRrODW7FlyoFNX4UFTI6JvfqXvYHOGfPSi9A+eJDyWfJZFw== X-Received: by 2002:a1c:7712:0:b0:3f1:70d5:1be8 with SMTP id t18-20020a1c7712000000b003f170d51be8mr1669549wmi.15.1682003035494; Thu, 20 Apr 2023 08:03:55 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Cc: Markus Armbruster Subject: [PATCH 2/2] docs/interop: Delete qmp-intro.txt Date: Thu, 20 Apr 2023 16:03:52 +0100 Message-Id: <20230420150352.1039408-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230420150352.1039408-1-peter.maydell@linaro.org> References: <20230420150352.1039408-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::32c; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32c.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, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1682003267574100002 Content-Type: text/plain; charset="utf-8" qmp-intro.txt is quite small and provides very little information that isn't already in the documentation elsewhere. Fold the example command lines into qemu-options.hx, and delete the now-unneeded plain text document. While we're touching the qemu-options.hx documentation text, wordsmith it a little bit and improve the rST formatting. Signed-off-by: Peter Maydell Reviewed-by: Eric Blake --- docs/interop/qmp-intro.txt | 88 -------------------------------------- qemu-options.hx | 26 ++++++++--- 2 files changed, 21 insertions(+), 93 deletions(-) delete mode 100644 docs/interop/qmp-intro.txt diff --git a/docs/interop/qmp-intro.txt b/docs/interop/qmp-intro.txt deleted file mode 100644 index 1c745a7af04..00000000000 --- a/docs/interop/qmp-intro.txt +++ /dev/null @@ -1,88 +0,0 @@ - QEMU Machine Protocol - =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D - -Introduction ------------- - -The QEMU Machine Protocol (QMP) allows applications to operate a -QEMU instance. - -QMP is JSON[1] based and features the following: - -- Lightweight, text-based, easy to parse data format -- Asynchronous messages support (ie. events) -- Capabilities Negotiation - -For detailed information on QMP's usage, please, refer to the following fi= les: - -o qmp-spec.txt QEMU Machine Protocol current specification -o qemu-qmp-ref.html QEMU QMP commands and events (auto-generated at build-= time) - -[1] https://www.json.org - -Usage ------ - -You can use the -qmp option to enable QMP. For example, the following -makes QMP available on localhost port 4444: - -$ qemu [...] -qmp tcp:localhost:4444,server=3Don,wait=3Doff - -However, for more flexibility and to make use of more options, the -mon -command-line option should be used. For instance, the following example -creates one HMP instance (human monitor) on stdio and one QMP instance -on localhost port 4444: - -$ qemu [...] -chardev stdio,id=3Dmon0 -mon chardev=3Dmon0,mode=3Dreadline \ - -chardev socket,id=3Dmon1,host=3Dlocalhost,port=3D4444,server= =3Don,wait=3Doff \ - -mon chardev=3Dmon1,mode=3Dcontrol,pretty=3Don - -Please, refer to QEMU's manpage for more information. - -Simple Testing --------------- - -To manually test QMP one can connect with telnet and issue commands by han= d: - -$ telnet localhost 4444 -Trying 127.0.0.1... -Connected to localhost. -Escape character is '^]'. -{ - "QMP": { - "version": { - "qemu": { - "micro": 0, - "minor": 0, - "major": 3 - }, - "package": "v3.0.0" - }, - "capabilities": [ - "oob" - ] - } -} - -{ "execute": "qmp_capabilities" } -{ - "return": { - } -} - -{ "execute": "query-status" } -{ - "return": { - "status": "prelaunch",=20 - "singlestep": false,=20 - "running": false - } -} - -Please refer to docs/interop/qemu-qmp-ref.* for a complete command -reference, generated from qapi/qapi-schema.json. - -QMP wiki page -------------- - -https://wiki.qemu.org/QMP diff --git a/qemu-options.hx b/qemu-options.hx index 59bdf67a2c5..2974de2c3ab 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -4109,26 +4109,42 @@ DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ QEMU_ARCH_ALL) SRST ``-qmp dev`` - Like -monitor but opens in 'control' mode. + Like ``-monitor`` but opens in 'control' mode. For example, to make + QMP available on localhost port 4444:: + + -qmp tcp:localhost:4444,server=3Don,wait=3Doff + + Not all options are configurable via this syntax; for maximum + flexibility use the ``-mon`` option and an accompanying ``-chardev``. + ERST DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", QEMU_ARCH_ALL) SRST ``-qmp-pretty dev`` - Like -qmp but uses pretty JSON formatting. + Like ``-qmp`` but uses pretty JSON formatting. ERST =20 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ "-mon [chardev=3D]name[,mode=3Dreadline|control][,pretty[=3Don|off]]\n= ", QEMU_ARCH_ALL) SRST ``-mon [chardev=3D]name[,mode=3Dreadline|control][,pretty[=3Don|off]]`` - Setup monitor on chardev name. ``mode=3Dcontrol`` configures=20 - a QMP monitor (a JSON RPC-style protocol) and it is not the - same as HMP, the human monitor that has a "(qemu)" prompt. + Set up a monitor connected to the chardev ``name``. + QEMU supports two monitors: the Human Monitor Protocol + (HMP; for human interaction), and the QEMU Monitor Protocol + (QMP; a JSON RPC-style protocol). + The default is HMP; ``mode=3Dcontrol`` selects QMP instead. ``pretty`` is only valid when ``mode=3Dcontrol``,=20 turning on JSON pretty printing to ease human reading and debugging. + + For example:: + + -chardev socket,id=3Dmon1,host=3Dlocalhost,port=3D4444,server=3Don,w= ait=3Doff \ + -mon chardev=3Dmon1,mode=3Dcontrol,pretty=3Don + + enables the QMP monitor on localhost port 4444 with pretty-printing. ERST =20 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ --=20 2.34.1