From patchwork Fri Sep 13 18:11:16 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luiz Capitulino X-Patchwork-Id: 274836 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id AEB132C012F for ; Sat, 14 Sep 2013 04:12:21 +1000 (EST) Received: from localhost ([::1]:50578 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VKXqt-00036j-Gf for incoming@patchwork.ozlabs.org; Fri, 13 Sep 2013 14:12:19 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:39734) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VKXq5-0002Xj-HF for qemu-devel@nongnu.org; Fri, 13 Sep 2013 14:11:33 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VKXq0-0003ym-PF for qemu-devel@nongnu.org; Fri, 13 Sep 2013 14:11:29 -0400 Received: from mx1.redhat.com ([209.132.183.28]:55617) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VKXq0-0003yg-Hz for qemu-devel@nongnu.org; Fri, 13 Sep 2013 14:11:24 -0400 Received: from int-mx11.intmail.prod.int.phx2.redhat.com (int-mx11.intmail.prod.int.phx2.redhat.com [10.5.11.24]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id r8DIBOqM016391 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Fri, 13 Sep 2013 14:11:24 -0400 Received: from localhost (ovpn-113-103.phx2.redhat.com [10.3.113.103]) by int-mx11.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id r8DIBNMN025664; Fri, 13 Sep 2013 14:11:23 -0400 From: Luiz Capitulino To: qemu-devel@nongnu.org Date: Fri, 13 Sep 2013 14:11:16 -0400 Message-Id: <1379095878-21203-5-git-send-email-lcapitulino@redhat.com> In-Reply-To: <1379095878-21203-1-git-send-email-lcapitulino@redhat.com> References: <1379095878-21203-1-git-send-email-lcapitulino@redhat.com> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.24 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 209.132.183.28 Cc: armbru@redhat.com Subject: [Qemu-devel] [PATCH 4/6] QMP: Update README file X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Drop unneeded info, fix some of the examples and rename QEMU Monitor Protocol to QEMU Machine Protocol. Signed-off-by: Luiz Capitulino Reviewed-by: Eric Blake --- docs/qmp/README | 99 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 49 insertions(+), 50 deletions(-) diff --git a/docs/qmp/README b/docs/qmp/README index c95a08c..85c4bc1 100644 --- a/docs/qmp/README +++ b/docs/qmp/README @@ -1,13 +1,13 @@ - QEMU Monitor Protocol + QEMU Machine Protocol ===================== Introduction -------------- +------------ -The QEMU Monitor Protocol (QMP) allows applications to communicate with -QEMU's Monitor. +The QEMU Machine Protocol (QMP) allows applications to operate a +QEMU instance. -QMP is JSON[1] based and currently has the following features: +QMP is JSON[1] based and features the following: - Lightweight, text-based, easy to parse data format - Asynchronous messages support (ie. events) @@ -15,37 +15,28 @@ QMP is JSON[1] based and currently has the following features: For detailed information on QMP's usage, please, refer to the following files: -o qmp-spec.txt QEMU Monitor Protocol current specification +o qmp-spec.txt QEMU Machine Protocol current specification o qmp-commands.txt QMP supported commands (auto-generated at build-time) o qmp-events.txt List of available asynchronous events -There is also a simple Python script called 'qmp-shell' available. - -IMPORTANT: It's strongly recommended to read the 'Stability Considerations' -section in the qmp-commands.txt file before making any serious use of QMP. - - [1] http://www.json.org Usage ----- -To enable QMP, you need a QEMU monitor instance in "control mode". There are -two ways of doing this. +You can use the -qmp option to enable QMP. For example, the following +makes QMP available on localhost port 4444: -The simplest one is using the '-qmp' command-line option. The following -example makes QMP available on localhost port 4444: +$ qemu [...] -qmp tcp:localhost:4444,server,nowait - $ qemu [...] -qmp tcp:localhost:4444,server +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: -However, in order to have more complex combinations, like multiple monitors, -the '-mon' command-line option should be used along with the '-chardev' one. -For instance, the following example creates one user monitor on stdio and one -QMP monitor on localhost port 4444. - - $ qemu [...] -chardev stdio,id=mon0 -mon chardev=mon0,mode=readline \ - -chardev socket,id=mon1,host=localhost,port=4444,server \ - -mon chardev=mon1,mode=control +$ qemu [...] -chardev stdio,id=mon0 -mon chardev=mon0,mode=readline \ + -chardev socket,id=mon1,host=localhost,port=4444,server,nowait \ + -mon chardev=mon1,mode=control,pretty=on Please, refer to QEMU's manpage for more information. @@ -58,31 +49,39 @@ $ telnet localhost 4444 Trying 127.0.0.1... Connected to localhost. Escape character is '^]'. -{"QMP": {"version": {"qemu": {"micro": 50, "minor": 13, "major": 0}, "package": ""}, "capabilities": []}} -{ "execute": "qmp_capabilities" } -{"return": {}} -{ "execute": "query-version" } -{"return": {"qemu": {"micro": 50, "minor": 13, "major": 0}, "package": ""}} - -Development Process -------------------- +{ + "QMP": { + "version": { + "qemu": { + "micro": 50, + "minor": 6, + "major": 1 + }, + "package": "" + }, + "capabilities": [ + ] + } +} -When changing QMP's interface (by adding new commands, events or modifying -existing ones) it's mandatory to update the relevant documentation, which is -one (or more) of the files listed in the 'Introduction' section*. - -Also, it's strongly recommended to send the documentation patch first, before -doing any code change. This is so because: - - 1. Avoids the code dictating the interface - - 2. Review can improve your interface. Letting that happen before - you implement it can save you work. - -* The qmp-commands.txt file is generated from the qmp-commands.hx one, which - is the file that should be edited. - -Homepage --------- +{ "execute": "qmp_capabilities" } +{ + "return": { + } +} + +{ "execute": "query-status" } +{ + "return": { + "status": "prelaunch", + "singlestep": false, + "running": false + } +} + +Please, refer to the qapi-schema.json file for a complete command reference. + +QMP wiki page +------------- http://wiki.qemu.org/QMP