xref: /qemu/include/monitor/monitor.h (revision 83c9089e73b81c69dc1ecdf859fa84d2c500fb5f)
1376253ecSaliguori #ifndef MONITOR_H
2376253ecSaliguori #define MONITOR_H
3376253ecSaliguori 
4376253ecSaliguori #include "qemu-common.h"
57b1b5d19SPaolo Bonzini #include "qapi/qmp/qerror.h"
67b1b5d19SPaolo Bonzini #include "qapi/qmp/qdict.h"
7737e150eSPaolo Bonzini #include "block/block.h"
8*83c9089eSPaolo Bonzini #include "monitor/readline.h"
9376253ecSaliguori 
10376253ecSaliguori extern Monitor *cur_mon;
118631b608SMarkus Armbruster extern Monitor *default_mon;
12376253ecSaliguori 
13731b0364Saliguori /* flags for monitor_init */
14731b0364Saliguori #define MONITOR_IS_DEFAULT    0x01
15cde76ee1Saliguori #define MONITOR_USE_READLINE  0x02
16418173c7SLuiz Capitulino #define MONITOR_USE_CONTROL   0x04
1739eaab9aSDaniel P. Berrange #define MONITOR_USE_PRETTY    0x08
18731b0364Saliguori 
198ac470c1SJan Kiszka /* flags for monitor commands */
208ac470c1SJan Kiszka #define MONITOR_CMD_ASYNC       0x0001
218ac470c1SJan Kiszka 
220d1ea871SLuiz Capitulino /* QMP events */
230d1ea871SLuiz Capitulino typedef enum MonitorEvent {
24242cd003SBlue Swirl     QEVENT_SHUTDOWN,
25242cd003SBlue Swirl     QEVENT_RESET,
26242cd003SBlue Swirl     QEVENT_POWERDOWN,
27242cd003SBlue Swirl     QEVENT_STOP,
286ed2c484SLuiz Capitulino     QEVENT_RESUME,
29586153d9SLuiz Capitulino     QEVENT_VNC_CONNECTED,
300d2ed46aSLuiz Capitulino     QEVENT_VNC_INITIALIZED,
310d72f3d3SLuiz Capitulino     QEVENT_VNC_DISCONNECTED,
32aa1db6edSLuiz Capitulino     QEVENT_BLOCK_IO_ERROR,
3380cd3478SLuiz Capitulino     QEVENT_RTC_CHANGE,
349eedeb3bSLuiz Capitulino     QEVENT_WATCHDOG,
356f8c63fbSGerd Hoffmann     QEVENT_SPICE_CONNECTED,
366f8c63fbSGerd Hoffmann     QEVENT_SPICE_INITIALIZED,
376f8c63fbSGerd Hoffmann     QEVENT_SPICE_DISCONNECTED,
3812bd451fSStefan Hajnoczi     QEVENT_BLOCK_JOB_COMPLETED,
39370521a1SStefan Hajnoczi     QEVENT_BLOCK_JOB_CANCELLED,
4032c81a4aSPaolo Bonzini     QEVENT_BLOCK_JOB_ERROR,
41a66a2a36SPaolo Bonzini     QEVENT_BLOCK_JOB_READY,
426f382ed2SLuiz Capitulino     QEVENT_DEVICE_TRAY_MOVED,
4353370b78SGerd Hoffmann     QEVENT_SUSPEND,
4425df49f6SLuiz Capitulino     QEVENT_SUSPEND_DISK,
4553370b78SGerd Hoffmann     QEVENT_WAKEUP,
46973603a8SDaniel P. Berrange     QEVENT_BALLOON_CHANGE,
472fdd16e2SYonit Halperin     QEVENT_SPICE_MIGRATE_COMPLETED,
484860853dSDaniel P. Berrange 
494860853dSDaniel P. Berrange     /* Add to 'monitor_event_names' array in monitor.c when
504860853dSDaniel P. Berrange      * defining new events here */
514860853dSDaniel P. Berrange 
52242cd003SBlue Swirl     QEVENT_MAX,
530d1ea871SLuiz Capitulino } MonitorEvent;
540d1ea871SLuiz Capitulino 
556620d3ceSMarkus Armbruster int monitor_cur_is_qmp(void);
566620d3ceSMarkus Armbruster 
570d1ea871SLuiz Capitulino void monitor_protocol_event(MonitorEvent event, QObject *data);
58731b0364Saliguori void monitor_init(CharDriverState *chr, int flags);
59376253ecSaliguori 
60cde76ee1Saliguori int monitor_suspend(Monitor *mon);
61376253ecSaliguori void monitor_resume(Monitor *mon);
62376253ecSaliguori 
630bbc47bbSLuiz Capitulino int monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
64376253ecSaliguori                                 BlockDriverCompletionFunc *completion_cb,
65376253ecSaliguori                                 void *opaque);
66e42e818bSLuiz Capitulino int monitor_read_block_device_key(Monitor *mon, const char *device,
67e42e818bSLuiz Capitulino                                   BlockDriverCompletionFunc *completion_cb,
68e42e818bSLuiz Capitulino                                   void *opaque);
69376253ecSaliguori 
70a9940fc4SPaolo Bonzini int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp);
71a96ed02fSNicholas Bellinger int monitor_handle_fd_param(Monitor *mon, const char *fdname);
727768e04cSMark McLoughlin 
738b7968f7SStefan Weil void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
748b7968f7SStefan Weil     GCC_FMT_ATTR(2, 0);
75e5924d89SStefan Weil void monitor_printf(Monitor *mon, const char *fmt, ...) GCC_FMT_ATTR(2, 3);
76376253ecSaliguori void monitor_print_filename(Monitor *mon, const char *filename);
77376253ecSaliguori void monitor_flush(Monitor *mon);
78b025c8b4SLuiz Capitulino int monitor_set_cpu(int cpu_index);
7999b7796fSLuiz Capitulino int monitor_get_cpu_index(void);
80376253ecSaliguori 
81940cc30dSAdam Litke typedef void (MonitorCompletion)(void *opaque, QObject *ret_data);
82940cc30dSAdam Litke 
83d6f46833SMarkus Armbruster void monitor_set_error(Monitor *mon, QError *qerror);
847060b478SAnthony Liguori void monitor_read_command(Monitor *mon, int show_prompt);
857060b478SAnthony Liguori ReadLineState *monitor_get_rs(Monitor *mon);
867060b478SAnthony Liguori int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
877060b478SAnthony Liguori                           void *opaque);
88d6f46833SMarkus Armbruster 
89eb6e8ea5SAnthony Liguori int qmp_qom_set(Monitor *mon, const QDict *qdict, QObject **ret);
90eb6e8ea5SAnthony Liguori 
91eb6e8ea5SAnthony Liguori int qmp_qom_get(Monitor *mon, const QDict *qdict, QObject **ret);
92eb6e8ea5SAnthony Liguori 
93e446f70dSCorey Bryant AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
94e446f70dSCorey Bryant                                 bool has_opaque, const char *opaque,
95e446f70dSCorey Bryant                                 Error **errp);
96adb696f3SCorey Bryant int monitor_fdset_get_fd(int64_t fdset_id, int flags);
97adb696f3SCorey Bryant int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd);
98adb696f3SCorey Bryant int monitor_fdset_dup_fd_remove(int dup_fd);
99adb696f3SCorey Bryant int monitor_fdset_dup_fd_find(int dup_fd);
100adb696f3SCorey Bryant 
101376253ecSaliguori #endif /* !MONITOR_H */
102