|
|
(63 intermediate revisions by 4 users not shown) |
Line 1: |
Line 1: |
| = QEMU Monitor Protocol = | | = PAGE MOVED!! = |
|
| |
|
| The QEMU Monitor Protocol (QMP) allows applications to communicate with QEMU's Monitor.
| | This page has moved to: http://wiki.qemu.org/QMP |
| | |
| QMP is [http://www.json.org/ JSON]-based, its main features are:
| |
| | |
| * Lightweight, text-based, easy to parse data format
| |
| * Asynchronous events support
| |
| | |
| Its full specification can be found [http://git.savannah.gnu.org/cgit/qemu.git/tree/QMP/qmp-spec.txt here] and the [http://git.savannah.gnu.org/cgit/qemu.git/tree/QMP/README README] file explains how to use it.
| |
| | |
| == General Status ==
| |
| | |
| QMP is available in QEMU since version 0.13.
| |
| | |
| However, it is still under development and not all Monitor commands are currently available.
| |
| | |
| == Examples ==
| |
| | |
| In the following examples, 'C' stands for 'Client' and 'S' stands for 'Server'.
| |
| | |
| === Server Greeting ===
| |
| | |
| S: {"QMP": {"capabilities": []}}
| |
| | |
| === Query version ===
| |
| | |
| C: { "execute": "query-version" }
| |
| S: {"return": {"qemu": "0.11.50", "package": ""}}
| |
| | |
| === Eject a device ===
| |
| | |
| C: { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
| |
| S: {"return": "OK"}
| |
| | |
| == Development ==
| |
| | |
| Primary contact is [mailto:lcapitulino@redhat.com Luiz Capitulino], but most QMP-related discussions happen on the [http://lists.nongnu.org/mailman/listinfo/qemu-devel qemu-devel] mailing list.
| |
| | |
| Next features, hot fixes and other patches are stored in the QMP unstable repository:
| |
| | |
| http://repo.or.cz/w/qemu/qmp-unstable.git
| |
| | |
| '''NOTE''': all branches in this repository are constantly ''rebased''.
| |
| | |
| == TODO ==
| |
| | |
| * High-level documentation
| |
| * Convert all commands
| |
| * Proper error handling support
| |
| * Asynchronous commands
| |
| * Libqmp
| |
| | |
| == Conversion status (2009-12-07) ==
| |
| | |
| {| border="1"
| |
| |
| |
| |Command
| |
| |Info
| |
| |-
| |
| |Handlers
| |
| |61
| |
| |36
| |
| |-
| |
| |Fully Converted
| |
| |7
| |
| |15
| |
| |-
| |
| |Percentage
| |
| |11%
| |
| |41%
| |
| |-
| |
| |}
| |
| | |
| The following tables have a per-function status. There is one table for ''command'' handlers and another one for ''info'' handlers.
| |
| | |
| Status can be:
| |
| | |
| * merged: already merged upstream
| |
| * converted: converted but not merged yet
| |
| * never fails: does not need error handling
| |
| | |
| '''NOTE:''' Handlers used by [http://libvirt.org Libvirt] are marked with yellow.
| |
| | |
| ==== Command handlers ====
| |
| | |
| {| border="1"
| |
| |'''Handler name'''
| |
| |'''Output in QObject'''
| |
| |'''Error handling'''
| |
| |'''Comments'''
| |
| |-
| |
| |do_acl_add()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_acl_policy()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_acl_remove()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_acl_reset()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_acl_show()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_balloon()
| |
| |merged
| |
| |never fails
| |
| |
| |
| |-
| |
| |do_boot_set()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_change()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_closefd()
| |
| |merged
| |
| |
| |
| |
| |
| |-
| |
| |do_commit()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_cont()
| |
| |merged
| |
| |never fails
| |
| |TODO: encrypted images
| |
| |-
| |
| |do_cpu_set()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_delvm()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_device_add()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_device_del()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_eject()
| |
| |merged
| |
| |
| |
| |
| |
| |-
| |
| |do_gdbserver()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_getfd()
| |
| |merged
| |
| |
| |
| |
| |
| |-
| |
| |do_help_cmd()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info()
| |
| |merged
| |
| |
| |
| |
| |
| |-
| |
| |do_inject_mce()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_inject_nmi()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_ioport_read()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_ioport_write()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_loadvm()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_log()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_logfile()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_memory_dump()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_memory_save()
| |
| |merged
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_migrate()
| |
| |merged
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_migrate_cancel()
| |
| |merged
| |
| |never fails
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_migrate_set_downtime()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_migrate_set_speed()
| |
| |merged
| |
| |never fails
| |
| |
| |
| |-
| |
| |do_mouse_button()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_mouse_move()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_mouse_set()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_pci_device_hot_remove()
| |
| |merged
| |
| |
| |
| |
| |
| |-
| |
| |do_physical_memory_dump()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_physical_memory_save()
| |
| |merged
| |
| |
| |
| |
| |
| |-
| |
| |do_print()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_quit()
| |
| |merged
| |
| |
| |
| |
| |
| |-
| |
| |do_savevm()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_screen_dump()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_sendkey()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_set_link()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_singlestep()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_stop()
| |
| |merged
| |
| |never fails
| |
| |
| |
| |-
| |
| |do_stop_capture()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_sum()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_system_powerdown()
| |
| |merged
| |
| |nerver fails
| |
| |
| |
| |-
| |
| |do_system_reset()
| |
| |merged
| |
| |never fails
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_usb_add()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_usb_del()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_watchdog_action()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_wav_capture()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |drive_hot_add()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |net_host_device_add()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |net_host_device_remove()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |net_slirp_hostfwd_add()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |net_slirp_hostfwd_remove()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |pci_device_hot_add()
| |
| |converted
| |
| |
| |
| |
| |
| |-
| |
| |}
| |
| | |
| ==== Info handlers ====
| |
| | |
| {| border="1"
| |
| |'''Handler name'''
| |
| |'''Status'''
| |
| |'''Version'''
| |
| |'''Comments'''
| |
| |- style="background-color:yellow;"
| |
| |bdrv_info()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |bdrv_info_stats()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_info_balloon()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_capture()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_info_cpus()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_cpu_stats()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_history()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_hpet()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_jit()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_kvm()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_mice()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |do_info_migrate()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_name()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_network()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_numa()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_profile()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_qdm()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_qtree()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_registers()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_roms()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_snapshots()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_status()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_usernet()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |do_info_uuid()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_version()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |do_info_vnc()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |irq_info()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |mem_info()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |pci_info()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |pcmcia_info()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |pic_info()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |qemu_chr_info()
| |
| |merged
| |
| |0.13
| |
| |
| |
| |-
| |
| |tlb_info()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |usb_host_info()
| |
| |
| |
| |
| |
| |
| |
| |- style="background-color:yellow;"
| |
| |usb_info()
| |
| |
| |
| |
| |
| |
| |
| |-
| |
| |}
| |
| | |
| == History ==
| |
| | |
| This was the fourth proposal for a 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
| |