[Qemu-devel] [PATCH v2 0/2]: QMP: instability warnings

[Qemu-devel] [PATCH v2 0/2]: QMP: instability warnings

[Luiz Capitulino]

This is good for 0.13, please check individual patches for details.

Thanks.

[Qemu-devel] [PATCH 1/2] QMP: Update README file

[Luiz Capitulino]

A number of changes I prefer to do in one shot:

- Add a note about instability
- Add multiple monitors example
- Add 'Development Process' section
- Small clarifications

Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 QMP/README |   67 +++++++++++++++++++++++++++++++++++++++++------------------
 1 files changed, 46 insertions(+), 21 deletions(-)

diff --git a/QMP/README b/QMP/README
index 35a80c7..8618c6f 100644
--- a/QMP/README
+++ b/QMP/README
@@ -5,44 +5,52 @@ Introduction
 -------------
 
 The QEMU Monitor Protocol (QMP) allows applications to communicate with
-QEMU's Monitor.
+QEMU's Monitor the right way.
 
-QMP is JSON[1] based and has the following features:
+QMP is JSON[1] based and currently has the following features:
 
 - Lightweight, text-based, easy to parse data format
-- Asynchronous events support 
-- Stability
+- Asynchronous messages support (ie. events)
+- Capabilities Negotiation
 
-For more information, please, refer to the following files:
+However, QMP is still under heavy development and is considered an unstable
+protocol. This means that its interface is going to have incompatible changes
+between QEMU releases. We plan to make QMP stable as soon as possible.
+
+For detailed information on QMP's usage, please, refer to the following files:
 
 o qmp-spec.txt      QEMU Monitor Protocol current specification
-o qmp-commands.txt  QMP supported commands
+o qmp-commands.txt  QMP supported commands (auto-generated at build-time)
 o qmp-events.txt    List of available asynchronous events
 
 There are also two simple Python scripts available:
 
-o qmp-shell       A shell
-o vm-info         Show some information about the Virtual Machine
+o qmp-shell  A shell
+o vm-info    Show some information about the Virtual Machine
 
 [1] http://www.json.org
 
 Usage
 -----
 
-To enable QMP, QEMU has to be started in "control mode". There are
-two ways of doing this, the simplest one is using the the '-qmp'
-command-line option.
+To enable QMP, you need a QEMU monitor instance in "control mode". There are
+two ways of doing this.
+
+The simplest one is using the '-qmp' command-line option. The following
+example makes QMP available on localhost port 4444:
 
-For example:
+  $ qemu [...] -qmp tcp:localhost:4444,server
 
-$ qemu [...] -qmp tcp:localhost:4444,server
+However, in order to have more complex combinations, like multiple monitors,
+the '-mon' command-line option should be used with the '-chardev' one. For
+instance, the following example creates one user monitor on stdio and one
+QMP monitor on localhost port 4444.
 
-Will start QEMU in control mode, waiting for a client TCP connection
-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
 
-It is also possible to use the '-mon' command-line option to have
-more complex combinations. Please, refer to the QEMU's manpage for
-more information.
+Please, refer to QEMU's manpage for more information.
 
 Simple Testing
 --------------
@@ -59,8 +67,25 @@ Escape character is '^]'.
 { "execute": "query-version" }
 {"return": {"qemu": "0.12.50", "package": ""}}
 
-Contact
--------
+Development Process
+-------------------
+
+When changing QMP's interface (by adding new commands, events or modifying
+existing ones) it's mandatory to update the relevant documention, 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. It's very likely that the interface will change during review, updating
+     the code at the same time might be a big waste of time
+
+* The qmp-commands.txt file is generated from the qemu-monitor.hx one, which
+  is the file that should be edited.
+
+Homepage
+--------
 
 http://www.linux-kvm.org/page/MonitorProtocol
-Luiz Fernando N. Capitulino <lcapitulino@redhat.com>
-- 
1.7.2.rc3.43.g24e7a

[Qemu-devel] [PATCH 2/2] QMP: Add a warning to the greeting message

[Luiz Capitulino]

This commit add the following new key to QMP's greeting message:

  "warning": "QMP is unstable, it will change soon!"

The goal is to go beyond document warnings with regard to QMP's
current state.

Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 QMP/README |    2 +-
 monitor.c  |    3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/QMP/README b/QMP/README
index 8618c6f..cf158d2 100644
--- a/QMP/README
+++ b/QMP/README
@@ -61,7 +61,7 @@ $ telnet localhost 4444
 Trying 127.0.0.1...
 Connected to localhost.
 Escape character is '^]'.
-{"QMP": {"version": {"qemu": "0.12.50", "package": ""}, "capabilities": []}}
+{"QMP": {"version": {"qemu": "0.12.50", "package": ""}, "capabilities": [], "warning": "QMP is unstable, it will change soon!"}}
 { "execute": "qmp_capabilities" }
 {"return": {}}
 { "execute": "query-version" }
diff --git a/monitor.c b/monitor.c
index 45fd482..c259b28 100644
--- a/monitor.c
+++ b/monitor.c
@@ -4384,7 +4384,8 @@ static QObject *get_qmp_greeting(void)
     QObject *ver;
 
     do_info_version(NULL, &ver);
-    return qobject_from_jsonf("{'QMP':{'version': %p,'capabilities': []}}",ver);
+    return qobject_from_jsonf("{ 'QMP': { 'version': %p, 'capabilities': [], "
+            "'warning': 'QMP is unstable, it will change soon!' } }", ver);
 }
 
 /**
-- 
1.7.2.rc3.43.g24e7a

Re: [Qemu-devel] [PATCH v2 0/2]: QMP: instability warnings

[Markus Armbruster]

Luiz Capitulino <lcapitulino@redhat.com> writes:

> This is good for 0.13, please check individual patches for details.

Looks good to me.

[Qemu-devel] [PATCH 0/2]: QMP: ensure we will break unstable clients

[Luiz Capitulino]

First patch is a small README update, important change is in second patch.

Thanks.

[Qemu-devel] [PATCH 1/2] QMP: Update README file

[Luiz Capitulino]

A number of small changes I prefer to do in one shot:

- Add a note about instability
- Add multiple monitors example
- Small clarifications

Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
 QMP/README |   36 +++++++++++++++++++++++-------------
 1 files changed, 23 insertions(+), 13 deletions(-)

diff --git a/QMP/README b/QMP/README
index 35a80c7..30a283b 100644
--- a/QMP/README
+++ b/QMP/README
@@ -7,13 +7,17 @@ Introduction
 The QEMU Monitor Protocol (QMP) allows applications to communicate with
 QEMU's Monitor.
 
-QMP is JSON[1] based and has the following features:
+QMP is JSON[1] based and currently has the following features:
 
 - Lightweight, text-based, easy to parse data format
-- Asynchronous events support 
-- Stability
+- Asynchronous messages support (ie. events)
+- Capabilities Negotiation
 
-For more information, please, refer to the following files:
+However, QMP is still under heavy development and is considered an unstable
+protocol. This means that its interface is going to have incompatible changes
+between QEMU releases. We plan to make QMP stable as soon as possible.
+
+For more information on QMP's usage, please, refer to the following files:
 
 o qmp-spec.txt      QEMU Monitor Protocol current specification
 o qmp-commands.txt  QMP supported commands
@@ -29,9 +33,8 @@ o vm-info         Show some information about the Virtual Machine
 Usage
 -----
 
-To enable QMP, QEMU has to be started in "control mode". There are
-two ways of doing this, the simplest one is using the the '-qmp'
-command-line option.
+To enable QMP, QEMU has to be started in "control mode". There are two ways of
+doing this, the simplest one is using the the '-qmp' command-line option.
 
 For example:
 
@@ -40,9 +43,17 @@ $ qemu [...] -qmp tcp:localhost:4444,server
 Will start QEMU in control mode, waiting for a client TCP connection
 on localhost port 4444.
 
-It is also possible to use the '-mon' command-line option to have
-more complex combinations. Please, refer to the QEMU's manpage for
-more information.
+To have more complex combinations, like multiple monitors, the '-mon'
+command-line option should be used with the '-chardev' one. For instance, the
+following command-line creates one user monitor on stdio and one QMP monitor
+on localhost port 4444.
+
+$ qemu [...] -chardev stdio,id=mon0 -mon chardev=mon0,mode=readline \
+             -mon chardev=mon0,mode=readline \
+             -chardev socket,id=mon1,host=localhost,port=4444,server \
+             -mon chardev=mon1,mode=control
+
+Please, refer to QEMU's manpage for more information.
 
 Simple Testing
 --------------
@@ -59,8 +70,7 @@ Escape character is '^]'.
 { "execute": "query-version" }
 {"return": {"qemu": "0.12.50", "package": ""}}
 
-Contact
--------
+Homepage
+--------
 
 http://www.linux-kvm.org/page/MonitorProtocol
-Luiz Fernando N. Capitulino <lcapitulino@redhat.com>
-- 
1.7.2.rc0

Re: [Qemu-devel] [PATCH 1/2] QMP: Update README file

[Markus Armbruster]

Luiz Capitulino <lcapitulino@redhat.com> writes:

> A number of small changes I prefer to do in one shot:
>
> - Add a note about instability
> - Add multiple monitors example
> - Small clarifications

ACK for .13