MonitorProtocol

Monitor Protocol

This is the page of the Monitor Protocol project, which aims to implement a JSON based protocol for QEMU.

Problem

QEMU does not provide a way for applications to control it at the "machine level", that is, the current existing interface (called Monitor) was designed for human interaction only.

This is very problematic for applications, for the following reasons:

• It is needed to parse output meant to be read by humans
• It is not reliable, because it is not always possible to know whether a command has been successfully executed or not
• It lacks support for asynchronous events

Solution

Improve QEMU's Monitor to support a JSON based protocol.

Project status (2009-10-20)

Most of the infrastructure has been merged, JSON encoder/decoder should be merged in the next days. The only important missing part is error handling.

Some conversions are taking place in parallel, but some depend on not merged work.

Main building blocks

• QObject Layer (merged)
• QObject Monitor infrastructure (merged)
• JSON encoder/decoder (under review)
• Error handling (under discussion)

Command handlers Conversion work

• Input through QDict (merged)
• Output in QObject style (in progress)
• Error handling (not started)

Development

Most of the development takes place in the QMP unstable tree:

http://repo.or.cz/w/qemu/qmp-unstable.git

All branches in this repository are constantly rebased, the master one contains a functional QMP implementation for emission only (includes asynchronous messages).

The current protocol specification draft and other documentation can be found in the QMP directory of the master branch.

History

This is the fourth proposal for a QEMU Monitor Protocol, past discussions can be found in the following links:

• http://www.mail-archive.com/qemu-devel@nongnu.org/msg14593.html
• http://lists.gnu.org/archive/html/qemu-devel/2009-01/msg00655.html
• http://lists.gnu.org/archive/html/qemu-devel/2009-06/msg01584.html