QEMU monitor 与QMP

发表于 | 分类于 | 阅读次数

由于QEMU版本不同可能会导致具体的内容不同，因此本文只介绍QEMU monitor和QMP的概念与使用，详细的命令建议查阅相应版本的指导手册。

1、QEMU monitor

当用户启动一个QEMU进程之后，QEMU进程会为用户提供一个monitor用于交互。通过使用一些命令，用户可以监控正在运行的guestOS，更改可移除的媒体设备和USB设备，截图或者捕获音频，甚至控制虚拟机。

1.1、运行一个板级设备，不对monitor做任何设置

1
$ ./qemu-system-arm -M tms570-ls3137 -kernel /mnt/hgfs/code/ccs/tms570/Debug/tms570.out

弹出monitor：

点开Machine和View，可以看到更多选项。当前界面为compact monitor0窗口，点击View下拉框，可选择serial0，这里是串口的监控窗口，通过该窗口可查看串口输入输出信息。

或者你也可以勾选show tabs将所有可查看窗口显示出来。

1.2 、将monitor重定向到标准输入输出

1
$ ./qemu-system-arm -M tms570-ls3137 -kernel /mnt/hgfs/code/ccs/tms570/Debug/tms570.out -monitor stdio

将monitor重定向到标准输入输出后，依旧有QEMU弹窗，但是这个弹窗中只有serial0，而compact monitor0窗口重定向到当前的命令行窗口下了。(如果想要去除QEMU弹窗，可以添加参数-vnc :53，这样弹窗会被转到vnc的53端口，使用工具连接时需要5900+53端口)

1.3、将monitor重定向到网络设备

按照前面的思路同样可以将monitor重定向到telnet中

1
$ ./qemu-system-arm -M tms570-ls3137 -kernel /mnt/hgfs/code/ccs/tms570/Debug/tms570.out -monitor telnet:localhost:9000,server

1.4、QEMU monitor命令

使用QEMU monitor的目的是为了在VM运行后控制VM，控制VM的命令有许多，同样也有很多快捷键，在monitor界面使用help命令就可以查看了。同时WIKIBOOKS中也有详细的解析，我就不复制粘贴，制造信息垃圾了。

2、QMP (QEMU monitor protocol)

在许多情况下，我们希望在外部将控制命令输入到QEMU monitor中，但是原有的机制太麻烦（需要重定向等绕圈子的操作），幸而QEMU为我们提供了一个叫QMP的东西。

QMP全称QEMU monitor protocol顾名思义就是用于QEMU monitor的协议啦。QEMU协议以JSON格式传输命令与返回信息，许多基于qemu的应用都使用了这个功能，比如著名的虚拟化中间件libvirt，它在对QEMU虚拟机做操作时，就是使用的QMP。

2.1、通过telnet启用QMP

启用QMP使用-qmp或-qmp-pretty，两者都可配置qmp连接，但-qmp-pretty配置的连接使得输出格式更友好。将qmp通过tcp定向到本地9000端口，并且不等待连接。

1
$ ./qemu-system-arm -M tms570-ls3137 -kernel /mnt/hgfs/code/ccs/tms570/Debug/tms570.out -qmp-pretty tcp:localhost:9000,server,nowait -serial telnet:localhost:9001,server

开启连接

1
$ telnet localhost 9000

开启telnet连接后，可以看到telnet窗口如下输出：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
{
    "QMP": {
        "version": {
            "qemu": {
                "micro": 1,
                "minor": 7,
                "major": 2
            },
            "package": " (-dirty)"
        },
        "capabilities": [
        ]
    }
}

表示连接成功。想要进入QMP命令模式需要先发送一个qmp_capabilities，进入到命令模式。

1
{ "execute": "qmp_capabilities" }

如果return为空则命令运行成功

1
2
3
4
{
    "return": {
    }
}

现在你就可以开心地通过telnet控制VM了，之后要怎么做就任君发挥了。在这里可以找到更多最新的命令和使用方法。

2.2、通过qmp-shell script使用qmp

在QEMU的源码目录下的script/qmp目录下有一个qmp-shell脚本，你也可以使用这个脚本来使用qmp，它可以用来做自动测试，因为它可以为你组合一些命令。

1
$ qemu [...] -qmp unix:./qmp-sock,server,nowait

运行脚本

1
$ qmp-shell ./qmp-sock

2.3、配置文件运行

创建配置文件

1
2
3
4
5
6
7
8
9
10
[chardev "qmp"]
  backend = "socket"
  port = "9000"
  host = "localhost"
  server = "on"
  wait = "on"
[mon "qmp"]
  mode = "control"
  chardev = "qmp"
  pretty = "on"

等价于

1
-chardev socket,id=qmp,port=9000,host=localhost,server -mon chardev=qmp,mode=control,pretty=on

或者通过本地socket连接

1
2
3
4
5
6
7
8
9
[chardev "qmp"]
  backend = "socket"
  path = "/root/qemu-install/bin/qmp-sock"
  server = "on"
  wait = "on"
[mon "qmp"]
  mode = "control"
  chardev = "qmp"
  pretty = "on"

连接socket

1
2
$ apt-get install rlwrap socat
$ rlwrap -C qmp socat STDIO UNIX:qmp-sock

3、自定义QMP协议

3.1、在qapi-schema.json文件下声明命令

1
{ 'command': 'hello qemu'}

3.2、qmp.c中添加命令函数

1
2
3
4
void qmp_hello_qemu(Error **errp)
{
	printf("hello qemu\n");
}

3.3、修改qmp-commands.hx

1
2
3
4
5
{
    .name  = "hello qemu",
    .args_type  = "",
    .mhandler.cmd_new = qmp_marshal_input_hello_world,
},

更多内容可以查看官网教程

4、Human Monitor Interface（HMP）

https://blog.csdn.net/dobell/article/details/8271140

hmp即monitor界面使用的命令

4.1、修改hmp-commands.hx

1
2
3
4
5
6
7
8
9
10
11
12
13

    {
        .name       = "hello qemu",
        .args_type  = "",
        .params     = "",
        .help       = "print hello qemu",
        .mhandler.cmd = hmp_input_hello_world,
    },

STEXI
@item hello_qemu
print hello qemu.
ETEXI

注意：args_type中参数值不可使用下划线

4.2、hmp.c中添加命令函数

1
2
3
4
5
6
void hmp_input_hello_world(Monitor *mon, const QDict *qdict)
{
    Error *err = NULL;

    qmp_hello_qemu(&err);
}

4.3、hmp.h中添加声明

1
void hmp_input_hello_world(Monitor *mon, const QDict *qdict);