Skip to content

monitor: Split monitor.c in core/HMP/QMP/misc

Kevin Wolf qemu-devel 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest15 patches 23 repliesIn review
  2. v211 patches 30 repliesSuperseded
  3. v1 RFC10 patches 18 repliesSuperseded

Changes in v3 from the cover letter

- Assert monitor_is_qmp() before casting to MonitorQMP in two places
- Added note that HMP doesn't currently use iothread to the documentation of MonitorHMP
- Removed unnecessary memset() in monitor_data_init()
- Removed Monitor.cmd_table instead of moving it to MonitorHMP. Renamed the tables to have an hmp_ prefix.
- monitor_int.h of v2 becomes monitor-internal.h now
- Cleaned up #include directives in new files
- Moved some more functions between files
- Removed monitor_init() in favour of public monitor_init_hmp/qmp()
- Deprecate -mon control=readline,pretty=on|off
- Improved several commit messages

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/15monitor: Remove unused password prompting fieldsmonitor.c+0 -20 replies
2/15monitor: Split monitor_init in HMP and QMP functionmonitor.c+52 -371 reply
3/15monitor: Make MonitorQMP a child class of Monitormonitor.c+124 -961 reply
4/15monitor: Create MonitorHMP with readline statehmp.c include/monitor/monitor.h monitor.c+79 -591 reply
5/15monitor: Remove Monitor.cmd_table indirectionmonitor.c+3 -61 reply
6/15monitor: Rename HMP command type and tableshmp-commands.hx monitor.c+35 -352 replies
7/15Move monitor.c to monitor/misc.cMAINTAINERS Makefile.objs Makefile.target +5 more+19 -152 replies
8/15monitor: Move {hmp, qmp}.c to monitor/{hmp, qmp}-cmds.cMAINTAINERS Makefile.objs docs/devel/writing-qmp-commands.txt +3 more+12 -90 replies
9/15monitor: Create monitor-internal.h with common definitionsMAINTAINERS monitor/misc.c monitor/monitor-internal.h+151 -1092 replies
10/15monitor: Split out monitor/qmp.cMakefile.objs monitor/Makefile.objs monitor/misc.c +3 more+448 -3891 reply
11/15monitor: Split out monitor/hmp.cmonitor/Makefile.objs monitor/hmp.c monitor/misc.c +2 more+1443 -13482 replies
12/15monitor: Split out monitor/monitor.cMAINTAINERS include/monitor/monitor.h monitor/Makefile.objs +4 more+644 -6001 reply
13/15monitor: Split Monitor.flags into separate boolsmonitor/hmp.c monitor/misc.c monitor/monitor-internal.h +2 more+22 -151 reply
14/15monitor: Replace monitor_init() with monitor_init_{hmp, qmp}()chardev/char.c gdbstub.c include/monitor/monitor.h +7 more+27 -361 reply
15/15vl: Deprecate -mon pretty=... for HMP monitorsqemu-deprecated.texi vl.c+15 -13 replies

Reviews trailers per patch

All 15 patches have a Reviewed-by or Acked-by.

PatchDr. David Alan GilbertMarkus Armbruster
1/15R-b R-b
2/15R-b R-b
3/15R-b R-b
4/15R-b R-b
5/15R-b
6/15R-b
7/15R-b R-b
8/15R-b R-b
9/15R-b R-b
10/15R-b R-b
11/15R-b
12/15R-b
13/15R-b
14/15R-b
15/15R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v3 thread

Cover letter [Qemu-devel] [PATCH v3 00/15] monitor: Split monitor.c in core/HMP/QMP/misc

monitor.c mixes a lot of different things in a single file: The core monitor infrastructure, HMP infrastrcture, QMP infrastructure, and the implementation of several HMP and QMP commands. Almost worse, struct Monitor mixes state for HMP, for QMP, and state actually shared between all monitors. monitor.c must be linked with a system emulator and even requires per-target compilation because some of the commands it implements access system emulator state.

The reason why I care about this is that I'm working on a protoype for a storage daemon, which wants to use QMP (but probably not HMP) and obviously doesn't have any system emulator state. So I'm interested in some core monitor parts that can be linked to non-system-emulator tools.

This series first creates separate structs MonitorQMP and MonitorHMP which inherit from Monitor, and then moves the associated infrastructure code into separate source files.

While the split is probably not perfect, I think it's an improvement of the current state even for QEMU proper, and it's good enough so I can link my storage daemon against just monitor/core.o and monitor/qmp.o and get a useless QMP monitor that parses the JSON input and rejects everything as an unknown command.

Next I'll try to teach it a subset of QMP commands that can actually be supported in a tool, but while there will be a few follow-up patches to achieve this, I don't expect that this work will bring up much that needs to be changed in the splitting process done in this series.

v3:
- Assert monitor_is_qmp() before casting to MonitorQMP in two places
- Added note that HMP doesn't currently use iothread to the documentation of MonitorHMP
- Removed unnecessary memset() in monitor_data_init()
- Removed Monitor.cmd_table instead of moving it to MonitorHMP. Renamed the tables to have an hmp_ prefix.
- monitor_int.h of v2 becomes monitor-internal.h now
- Cleaned up #include directives in new files
- Moved some more functions between files
- Removed monitor_init() in favour of public monitor_init_hmp/qmp()
- Deprecate -mon control=readline,pretty=on|off
- Improved several commit messages

v2:
- Fix coding style while moving files to make checkpatch happier
- Updated file name references in docs/devel/writing-qmp-commands.txt
- Updated MAINTAINERS for moved and newly created files
- Created monitor/trace-events instead of using the root directory one
- Move {hmp,qmp}.c to monitor/{hmp,qmp}-cmds.c

Kevin Wolf (15):
monitor: Remove unused password prompting fields
monitor: Split monitor_init in HMP and QMP function
monitor: Make MonitorQMP a child class of Monitor
monitor: Create MonitorHMP with readline state
monitor: Remove Monitor.cmd_table indirection
monitor: Rename HMP command type and tables
Move monitor.c to monitor/misc.c
monitor: Move {hmp,qmp}.c to monitor/{hmp,qmp}-cmds.c
monitor: Create monitor-internal.h with common definitions
monitor: Split out monitor/qmp.c
monitor: Split out monitor/hmp.c
monitor: Split out monitor/monitor.c
monitor: Split Monitor.flags into separate bools
monitor: Replace monitor_init() with monitor_init_{hmp,qmp}()
vl: Deprecate -mon pretty=... for HMP monitors

 docs/devel/writing-qmp-commands.txt |   11 +-
 include/monitor/monitor.h           |   15 +-
 monitor/monitor-internal.h          |  187 ++
 chardev/char.c                      |    2 +-
 gdbstub.c                           |    2 +-
 monitor.c                           | 4729 ---------------------------
 hmp.c => monitor/hmp-cmds.c         |    6 +-
 monitor/hmp.c                       | 1415 ++++++++
 monitor/misc.c                      | 2368 ++++++++++++++
 monitor/monitor.c                   |  632 ++++
 qmp.c => monitor/qmp-cmds.c         |    2 +-
 monitor/qmp.c                       |  403 +++
 stubs/monitor.c                     |    6 +-
 tests/test-util-sockets.c           |    3 +-
 vl.c                                |   28 +-
 MAINTAINERS                         |   13 +-
 Makefile.objs                       |    4 +-
 Makefile.target                     |    3 +-
 hmp-commands.hx                     |    2 +-
 monitor/Makefile.objs               |    3 +
 monitor/trace-events                |   15 +
 qemu-deprecated.texi                |    6 +
 trace-events                        |   10 -
 23 files changed, 5091 insertions(+), 4774 deletions(-)
 create mode 100644 monitor/monitor-internal.h
 delete mode 100644 monitor.c
 rename hmp.c => monitor/hmp-cmds.c (99%)
 create mode 100644 monitor/hmp.c
 create mode 100644 monitor/misc.c
 create mode 100644 monitor/monitor.c
 rename qmp.c => monitor/qmp-cmds.c (99%)
 create mode 100644 monitor/qmp.c
 create mode 100644 monitor/Makefile.objs
 create mode 100644 monitor/trace-events
Signature · 1 line
2.20.1