xref: /openbmc/qemu/include/monitor/monitor.h (revision 3840f842)
1 #ifndef MONITOR_H
2 #define MONITOR_H
3 
4 #include "qemu-common.h"
5 #include "qapi/qmp/qerror.h"
6 #include "qapi/qmp/qdict.h"
7 #include "block/block.h"
8 #include "qemu/readline.h"
9 
10 extern Monitor *cur_mon;
11 extern Monitor *default_mon;
12 
13 /* flags for monitor_init */
14 #define MONITOR_IS_DEFAULT    0x01
15 #define MONITOR_USE_READLINE  0x02
16 #define MONITOR_USE_CONTROL   0x04
17 #define MONITOR_USE_PRETTY    0x08
18 
19 /* flags for monitor commands */
20 #define MONITOR_CMD_ASYNC       0x0001
21 
22 /* QMP events */
23 typedef enum MonitorEvent {
24     QEVENT_SHUTDOWN,
25     QEVENT_RESET,
26     QEVENT_POWERDOWN,
27     QEVENT_STOP,
28     QEVENT_RESUME,
29     QEVENT_VNC_CONNECTED,
30     QEVENT_VNC_INITIALIZED,
31     QEVENT_VNC_DISCONNECTED,
32     QEVENT_BLOCK_IO_ERROR,
33     QEVENT_RTC_CHANGE,
34     QEVENT_WATCHDOG,
35     QEVENT_SPICE_CONNECTED,
36     QEVENT_SPICE_INITIALIZED,
37     QEVENT_SPICE_DISCONNECTED,
38     QEVENT_BLOCK_JOB_COMPLETED,
39     QEVENT_BLOCK_JOB_CANCELLED,
40     QEVENT_BLOCK_JOB_ERROR,
41     QEVENT_BLOCK_JOB_READY,
42     QEVENT_DEVICE_DELETED,
43     QEVENT_DEVICE_TRAY_MOVED,
44     QEVENT_NIC_RX_FILTER_CHANGED,
45     QEVENT_SUSPEND,
46     QEVENT_SUSPEND_DISK,
47     QEVENT_WAKEUP,
48     QEVENT_BALLOON_CHANGE,
49     QEVENT_SPICE_MIGRATE_COMPLETED,
50     QEVENT_GUEST_PANICKED,
51     QEVENT_BLOCK_IMAGE_CORRUPTED,
52     QEVENT_QUORUM_FAILURE,
53     QEVENT_QUORUM_REPORT_BAD,
54     QEVENT_ACPI_OST,
55 
56     /* Add to 'monitor_event_names' array in monitor.c when
57      * defining new events here */
58 
59     QEVENT_MAX,
60 } MonitorEvent;
61 
62 int monitor_cur_is_qmp(void);
63 
64 void monitor_protocol_event(MonitorEvent event, QObject *data);
65 void monitor_init(CharDriverState *chr, int flags);
66 
67 int monitor_suspend(Monitor *mon);
68 void monitor_resume(Monitor *mon);
69 
70 int monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
71                                 BlockDriverCompletionFunc *completion_cb,
72                                 void *opaque);
73 int monitor_read_block_device_key(Monitor *mon, const char *device,
74                                   BlockDriverCompletionFunc *completion_cb,
75                                   void *opaque);
76 
77 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp);
78 int monitor_handle_fd_param(Monitor *mon, const char *fdname);
79 int monitor_handle_fd_param2(Monitor *mon, const char *fdname, Error **errp);
80 
81 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
82     GCC_FMT_ATTR(2, 0);
83 void monitor_printf(Monitor *mon, const char *fmt, ...) GCC_FMT_ATTR(2, 3);
84 void monitor_flush(Monitor *mon);
85 int monitor_set_cpu(int cpu_index);
86 int monitor_get_cpu_index(void);
87 
88 typedef void (MonitorCompletion)(void *opaque, QObject *ret_data);
89 
90 void monitor_set_error(Monitor *mon, QError *qerror);
91 void monitor_read_command(Monitor *mon, int show_prompt);
92 ReadLineState *monitor_get_rs(Monitor *mon);
93 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
94                           void *opaque);
95 
96 int qmp_qom_set(Monitor *mon, const QDict *qdict, QObject **ret);
97 
98 int qmp_qom_get(Monitor *mon, const QDict *qdict, QObject **ret);
99 int qmp_object_add(Monitor *mon, const QDict *qdict, QObject **ret);
100 void object_add(const char *type, const char *id, const QDict *qdict,
101                 Visitor *v, Error **errp);
102 
103 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
104                                 bool has_opaque, const char *opaque,
105                                 Error **errp);
106 int monitor_fdset_get_fd(int64_t fdset_id, int flags);
107 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd);
108 int monitor_fdset_dup_fd_remove(int dup_fd);
109 int monitor_fdset_dup_fd_find(int dup_fd);
110 
111 #endif /* !MONITOR_H */
112