qapi/replay.json

   1 # -*- Mode: Python -*-
   2 # vim: filetype=python
   3 #
   4
   5 ##
   6 # = Record/replay
   7 ##
   8
   9 { 'include': 'common.json' }
  10
  11 ##
  12 # @ReplayMode:
  13 #
  14 # Mode of the replay subsystem.
  15 #
  16 # @none: normal execution mode. Replay or record are not enabled.
  17 #
  18 # @record: record mode. All non-deterministic data is written into the
  19 #          replay log.
  20 #
  21 # @play: replay mode. Non-deterministic data required for system execution
  22 #        is read from the log.
  23 #
  24 # Since: 2.5
  25 ##
  26 { 'enum': 'ReplayMode',
  27   'data': [ 'none', 'record', 'play' ] }
  28
  29 ##
  30 # @ReplayInfo:
  31 #
  32 # Record/replay information.
  33 #
  34 # @mode: current mode.
  35 #
  36 # @filename: name of the record/replay log file.
  37 #            It is present only in record or replay modes, when the log
  38 #            is recorded or replayed.
  39 #
  40 # @icount: current number of executed instructions.
  41 #
  42 # Since: 5.2
  43 ##
  44 { 'struct': 'ReplayInfo',
  45   'data': { 'mode': 'ReplayMode', '*filename': 'str', 'icount': 'int' } }
  46
  47 ##
  48 # @query-replay:
  49 #
  50 # Retrieve the record/replay information.
  51 # It includes current instruction count which may be used for
  52 # @replay-break and @replay-seek commands.
  53 #
  54 # Returns: record/replay information.
  55 #
  56 # Since: 5.2
  57 #
  58 # Example:
  59 #
  60 # -> { "execute": "query-replay" }
  61 # <- { "return": { "mode": "play", "filename": "log.rr", "icount": 220414 } }
  62 #
  63 ##
  64 { 'command': 'query-replay',
  65   'returns': 'ReplayInfo' }
  66
  67 ##
  68 # @replay-break:
  69 #
  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.
  76 #
  77 # @icount: instruction count to stop at
  78 #
  79 # Since: 5.2
  80 #
  81 # Example:
  82 #
  83 # -> { "execute": "replay-break", "arguments": { "icount": 220414 } }
  84 # <- { "return": {} }
  85 #
  86 ##
  87 { 'command': 'replay-break', 'data': { 'icount': 'int' } }
  88
  89 ##
  90 # @replay-delete-break:
  91 #
  92 # Remove replay breakpoint which was set with @replay-break.
  93 # The command is ignored when there are no replay breakpoints.
  94 #
  95 # Since: 5.2
  96 #
  97 # Example:
  98 #
  99 # -> { "execute": "replay-delete-break" }
 100 # <- { "return": {} }
 101 #
 102 ##
 103 { 'command': 'replay-delete-break' }
 104
 105 ##
 106 # @replay-seek:
 107 #
 108 # Automatically proceed to the instruction count @icount, when
 109 # replaying the execution. The command automatically loads nearest
 110 # snapshot and replays the execution to find the desired instruction.
 111 # When there is no preceding snapshot or the execution is not replayed,
 112 # then the command fails.
 113 # icount for the reference may be obtained with @query-replay command.
 114 #
 115 # @icount: target instruction count
 116 #
 117 # Since: 5.2
 118 #
 119 # Example:
 120 #
 121 # -> { "execute": "replay-seek", "arguments": { "icount": 220414 } }
 122 # <- { "return": {} }
 123 ##
 124 { 'command': 'replay-seek', 'data': { 'icount': 'int' } }