940cc30d0d
Qemu has a number of commands that can operate asynchronously (savevm, migrate, etc) and it will be getting more. For these commands, the user monitor needs to be suspended, but QMP monitors could continue to to accept other commands. This patch introduces a new command API that isolates the details of handling different monitor types from the actual command execution. A monitor command can use this API by implementing the mhandler.cmd_async handler (or info_async if appropriate). This function is responsible for submitting the command and does not return any data although it may raise errors. When the command completes, the QMPCompletion callback should be invoked with its opaque data and the command result. The process for submitting and completing an asynchronous command is different for QMP and user monitors. A user monitor must be suspended at submit time and resumed at completion time. The user_print() function must be passed to the QMPCompletion callback so the result can be displayed properly. QMP monitors are simpler. No submit time setup is required. When the command completes, monitor_protocol_emitter() writes the result in JSON format. This API can also be used to implement synchronous commands. In this case, the cmd_async handler should immediately call the QMPCompletion callback. It is my hope that this new interface will work for all commands, leading to a drastically simplified monitor.c once all commands are ported. Signed-off-by: Adam Litke <agl@us.ibm.com> Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
50 lines
1.3 KiB
C
50 lines
1.3 KiB
C
#ifndef MONITOR_H
|
|
#define MONITOR_H
|
|
|
|
#include "qemu-common.h"
|
|
#include "qemu-char.h"
|
|
#include "qdict.h"
|
|
#include "block.h"
|
|
|
|
extern Monitor *cur_mon;
|
|
|
|
/* flags for monitor_init */
|
|
#define MONITOR_IS_DEFAULT 0x01
|
|
#define MONITOR_USE_READLINE 0x02
|
|
#define MONITOR_USE_CONTROL 0x04
|
|
|
|
/* QMP events */
|
|
typedef enum MonitorEvent {
|
|
QEVENT_DEBUG,
|
|
QEVENT_SHUTDOWN,
|
|
QEVENT_RESET,
|
|
QEVENT_POWERDOWN,
|
|
QEVENT_STOP,
|
|
QEVENT_VNC_CONNECTED,
|
|
QEVENT_VNC_INITIALIZED,
|
|
QEVENT_VNC_DISCONNECTED,
|
|
QEVENT_MAX,
|
|
} MonitorEvent;
|
|
|
|
void monitor_protocol_event(MonitorEvent event, QObject *data);
|
|
void monitor_init(CharDriverState *chr, int flags);
|
|
|
|
int monitor_suspend(Monitor *mon);
|
|
void monitor_resume(Monitor *mon);
|
|
|
|
void monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
|
|
BlockDriverCompletionFunc *completion_cb,
|
|
void *opaque);
|
|
|
|
int monitor_get_fd(Monitor *mon, const char *fdname);
|
|
|
|
void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap);
|
|
void monitor_printf(Monitor *mon, const char *fmt, ...)
|
|
__attribute__ ((__format__ (__printf__, 2, 3)));
|
|
void monitor_print_filename(Monitor *mon, const char *filename);
|
|
void monitor_flush(Monitor *mon);
|
|
|
|
typedef void (MonitorCompletion)(void *opaque, QObject *ret_data);
|
|
|
|
#endif /* !MONITOR_H */
|