Merge tag 'v6.2.0-rc4'
[qemu/ar7.git] / qapi / replay.json
blobbfd83d7591446363468dbf61cc8b6fb445f0d2fb
1 # -*- Mode: Python -*-
4 ##
5 # = Record/replay
6 ##
8 { 'include': 'common.json' }
11 # @ReplayMode:
13 # Mode of the replay subsystem.
15 # @none: normal execution mode. Replay or record are not enabled.
17 # @record: record mode. All non-deterministic data is written into the
18 #          replay log.
20 # @play: replay mode. Non-deterministic data required for system execution
21 #        is read from the log.
23 # Since: 2.5
25 { 'enum': 'ReplayMode',
26   'data': [ 'none', 'record', 'play' ] }
29 # @ReplayInfo:
31 # Record/replay information.
33 # @mode: current mode.
35 # @filename: name of the record/replay log file.
36 #            It is present only in record or replay modes, when the log
37 #            is recorded or replayed.
39 # @icount: current number of executed instructions.
41 # Since: 5.2
44 { 'struct': 'ReplayInfo',
45   'data': { 'mode': 'ReplayMode', '*filename': 'str', 'icount': 'int' } }
48 # @query-replay:
50 # Retrieve the record/replay information.
51 # It includes current instruction count which may be used for
52 # @replay-break and @replay-seek commands.
54 # Returns: record/replay information.
56 # Since: 5.2
58 # Example:
60 # -> { "execute": "query-replay" }
61 # <- { "return": { "mode": "play", "filename": "log.rr", "icount": 220414 } }
64 { 'command': 'query-replay',
65   'returns': 'ReplayInfo' }
68 # @replay-break:
70 # Set replay breakpoint at instruction count @icount.
71 # Execution stops when the specified instruction is reached.
72 # There can be at most one breakpoint. When breakpoint is set, any prior
73 # one is removed.  The breakpoint may be set only in replay mode and only
74 # "in the future", i.e. at instruction counts greater than the current one.
75 # The current instruction count can be observed with @query-replay.
77 # @icount: instruction count to stop at
79 # Since: 5.2
81 # Example:
83 # -> { "execute": "replay-break", "data": { "icount": 220414 } }
86 { 'command': 'replay-break', 'data': { 'icount': 'int' } }
89 # @replay-delete-break:
91 # Remove replay breakpoint which was set with @replay-break.
92 # The command is ignored when there are no replay breakpoints.
94 # Since: 5.2
96 # Example:
98 # -> { "execute": "replay-delete-break" }
101 { 'command': 'replay-delete-break' }
104 # @replay-seek:
106 # Automatically proceed to the instruction count @icount, when
107 # replaying the execution. The command automatically loads nearest
108 # snapshot and replays the execution to find the desired instruction.
109 # When there is no preceding snapshot or the execution is not replayed,
110 # then the command fails.
111 # icount for the reference may be obtained with @query-replay command.
113 # @icount: target instruction count
115 # Since: 5.2
117 # Example:
119 # -> { "execute": "replay-seek", "data": { "icount": 220414 } }
121 { 'command': 'replay-seek', 'data': { 'icount': 'int' } }