On Thu, Jan 25, 2024 at 11:09 AM Nicholas Piggin <npig...@gmail.com> wrote:
>
> The v12 format support for replay-dump has a few issues still. This
> fixes async decoding; adds event, shutdown, and end decoding; fixes
> audio in / out events, fixes checkpoint checking of following async
> events.
>
> Signed-off-by: Nicholas Piggin <npig...@gmail.com>
> ---
> scripts/replay-dump.py | 132 ++++++++++++++++++++++++++++++-----------
> 1 file changed, 98 insertions(+), 34 deletions(-)
>
> diff --git a/scripts/replay-dump.py b/scripts/replay-dump.py
> index d668193e79..35732da08f 100755
> --- a/scripts/replay-dump.py
> +++ b/scripts/replay-dump.py
> @@ -20,6 +20,7 @@
>
> import argparse
> import struct
> +import os
> from collections import namedtuple
> from os import path
>
> @@ -63,6 +64,10 @@ def read_byte(fin):
> "Read a single byte"
> return struct.unpack('>B', fin.read(1))[0]
>
> +def read_bytes(fin, nr):
> + "Read a nr bytes"
Existing problem in this file, but please use """triple quotes""" for
docstrings.
> + return fin.read(nr)
> +
Does it really save a lot of typing to alias fin.read(1) to
read_bytes(fin, 1) ...?
> def read_event(fin):
> "Read a single byte event, but save some state"
> if replay_state.already_read:
> @@ -134,6 +139,18 @@ def swallow_async_qword(eid, name, dumpfile):
> print(" %s(%d) @ %d" % (name, eid, step_id))
> return True
>
> +def swallow_bytes(eid, name, dumpfile, nr):
> + "Swallow nr bytes of data without looking at it"
> + dumpfile.seek(nr, os.SEEK_CUR)
> + return True
> +
Why bother returning a bool if it's not based on any condition? Add an
error check or just drop the return value.
> +def decode_exception(eid, name, dumpfile):
> + print_event(eid, name)
> + return True
> +
I suppose in this case, the return is to fit a common signature.
> +# v12 does away with the additional event byte and encodes it in the main
> type
> +# Between v8 and v9, REPLAY_ASYNC_BH_ONESHOT was added, but we don't decode
> +# those versions so leave it out.
> async_decode_table = [ Decoder(0, "REPLAY_ASYNC_EVENT_BH",
> swallow_async_qword),
> Decoder(1, "REPLAY_ASYNC_INPUT", decode_unimp),
> Decoder(2, "REPLAY_ASYNC_INPUT_SYNC", decode_unimp),
> @@ -142,8 +159,8 @@ def swallow_async_qword(eid, name, dumpfile):
> Decoder(5, "REPLAY_ASYNC_EVENT_NET", decode_unimp),
> ]
> # See replay_read_events/replay_read_event
> -def decode_async(eid, name, dumpfile):
> - """Decode an ASYNC event"""
> +def decode_async_old(eid, name, dumpfile):
> + """Decode an ASYNC event (pre-v8)"""
>
> print_event(eid, name)
>
> @@ -157,6 +174,35 @@ def decode_async(eid, name, dumpfile):
>
> return call_decode(async_decode_table, async_event_kind, dumpfile)
>
> +def decode_async_bh(eid, name, dumpfile):
> + op_id = read_qword(dumpfile)
> + print_event(eid, name)
> + return True
> +
> +def decode_async_bh_oneshot(eid, name, dumpfile):
> + op_id = read_qword(dumpfile)
> + print_event(eid, name)
> + return True
> +
> +def decode_async_char_read(eid, name, dumpfile):
> + char_id = read_byte(dumpfile)
> + size = read_dword(dumpfile)
> + print_event(eid, name, "device:%x chars:%s" % (char_id,
> read_bytes(dumpfile, size)))
> + return True
> +
> +def decode_async_block(eid, name, dumpfile):
> + op_id = read_qword(dumpfile)
> + print_event(eid, name)
> + return True
> +
> +def decode_async_net(eid, name, dumpfile):
> + net_id = read_byte(dumpfile)
> + flags = read_dword(dumpfile)
> + size = read_dword(dumpfile)
> + swallow_bytes(eid, name, dumpfile, size)
> + print_event(eid, name, "net:%x flags:%x bytes:%d" % (net_id, flags,
> size))
> + return True
> +
> total_insns = 0
>
> def decode_instruction(eid, name, dumpfile):
> @@ -166,6 +212,10 @@ def decode_instruction(eid, name, dumpfile):
> print_event(eid, name, "+ %d -> %d" % (ins_diff, total_insns))
> return True
>
> +def decode_shutdown(eid, name, dumpfile):
> + print_event(eid, name)
> + return True
> +
> def decode_char_write(eid, name, dumpfile):
> res = read_dword(dumpfile)
> offset = read_dword(dumpfile)
> @@ -177,7 +227,7 @@ def decode_audio_out(eid, name, dumpfile):
> print_event(eid, name, "%d" % (audio_data))
> return True
>
> -def decode_checkpoint(eid, name, dumpfile):
> +def __decode_checkpoint(eid, name, dumpfile, old):
> """Decode a checkpoint.
>
> Checkpoints contain a series of async events with their own specific
> data.
> @@ -189,14 +239,20 @@ def decode_checkpoint(eid, name, dumpfile):
>
> # if the next event is EVENT_ASYNC there are a bunch of
> # async events to read, otherwise we are done
> - if next_event != 3:
> - print_event(eid, name, "no additional data", event_number)
> - else:
> + if (old and next_event == 3) or (not old and next_event >= 3 and
> next_event <= 9):
> print_event(eid, name, "more data follows", event_number)
> + else:
> + print_event(eid, name, "no additional data", event_number)
>
> replay_state.reuse_event(next_event)
> return True
>
> +def decode_checkpoint_old(eid, name, dumpfile):
> + return __decode_checkpoint(eid, name, dumpfile, False)
> +
> +def decode_checkpoint(eid, name, dumpfile):
> + return __decode_checkpoint(eid, name, dumpfile, True)
> +
> def decode_checkpoint_init(eid, name, dumpfile):
> print_event(eid, name)
> return True
> @@ -212,15 +268,23 @@ def decode_clock(eid, name, dumpfile):
>
> def decode_random(eid, name, dumpfile):
> ret = read_dword(dumpfile)
> - data = read_array(dumpfile)
> - print_event(eid, "%d bytes of random data" % len(data))
> + size = read_dword(dumpfile)
> + swallow_bytes(eid, name, dumpfile, size)
> + if (ret):
> + print_event(eid, name, "%d bytes (getrandom failed)" % (size))
> + else:
> + print_event(eid, name, "%d bytes" % (size))
> return True
>
> +def decode_end(eid, name, dumpfile):
> + print_event(eid, name)
> + return False
> +
> # pre-MTTCG merge
> v5_event_table = [Decoder(0, "EVENT_INSTRUCTION", decode_instruction),
> Decoder(1, "EVENT_INTERRUPT", decode_interrupt),
> Decoder(2, "EVENT_EXCEPTION", decode_plain),
> - Decoder(3, "EVENT_ASYNC", decode_async),
> + Decoder(3, "EVENT_ASYNC", decode_async_old),
> Decoder(4, "EVENT_SHUTDOWN", decode_unimp),
> Decoder(5, "EVENT_CHAR_WRITE", decode_char_write),
> Decoder(6, "EVENT_CHAR_READ_ALL", decode_unimp),
> @@ -242,7 +306,7 @@ def decode_random(eid, name, dumpfile):
> v6_event_table = [Decoder(0, "EVENT_INSTRUCTION", decode_instruction),
> Decoder(1, "EVENT_INTERRUPT", decode_interrupt),
> Decoder(2, "EVENT_EXCEPTION", decode_plain),
> - Decoder(3, "EVENT_ASYNC", decode_async),
> + Decoder(3, "EVENT_ASYNC", decode_async_old),
> Decoder(4, "EVENT_SHUTDOWN", decode_unimp),
> Decoder(5, "EVENT_CHAR_WRITE", decode_char_write),
> Decoder(6, "EVENT_CHAR_READ_ALL", decode_unimp),
> @@ -266,7 +330,7 @@ def decode_random(eid, name, dumpfile):
> v7_event_table = [Decoder(0, "EVENT_INSTRUCTION", decode_instruction),
> Decoder(1, "EVENT_INTERRUPT", decode_interrupt),
> Decoder(2, "EVENT_EXCEPTION", decode_unimp),
> - Decoder(3, "EVENT_ASYNC", decode_async),
> + Decoder(3, "EVENT_ASYNC", decode_async_old),
> Decoder(4, "EVENT_SHUTDOWN", decode_unimp),
> Decoder(5, "EVENT_SHUTDOWN_HOST_ERR", decode_unimp),
> Decoder(6, "EVENT_SHUTDOWN_HOST_QMP", decode_unimp),
> @@ -296,32 +360,31 @@ def decode_random(eid, name, dumpfile):
>
> v12_event_table = [Decoder(0, "EVENT_INSTRUCTION", decode_instruction),
> Decoder(1, "EVENT_INTERRUPT", decode_interrupt),
> - Decoder(2, "EVENT_EXCEPTION", decode_plain),
> - Decoder(3, "EVENT_ASYNC", decode_async),
> - Decoder(4, "EVENT_ASYNC", decode_async),
> - Decoder(5, "EVENT_ASYNC", decode_async),
> - Decoder(6, "EVENT_ASYNC", decode_async),
> - Decoder(6, "EVENT_ASYNC", decode_async),
> - Decoder(8, "EVENT_ASYNC", decode_async),
> - Decoder(9, "EVENT_ASYNC", decode_async),
> - Decoder(10, "EVENT_ASYNC", decode_async),
> - Decoder(11, "EVENT_SHUTDOWN", decode_unimp),
> - Decoder(12, "EVENT_SHUTDOWN_HOST_ERR", decode_unimp),
> - Decoder(13, "EVENT_SHUTDOWN_HOST_QMP_QUIT", decode_unimp),
> - Decoder(14, "EVENT_SHUTDOWN_HOST_QMP_RESET", decode_unimp),
> - Decoder(14, "EVENT_SHUTDOWN_HOST_SIGNAL", decode_unimp),
> - Decoder(15, "EVENT_SHUTDOWN_HOST_UI", decode_unimp),
> - Decoder(16, "EVENT_SHUTDOWN_GUEST_SHUTDOWN", decode_unimp),
> - Decoder(17, "EVENT_SHUTDOWN_GUEST_RESET", decode_unimp),
> - Decoder(18, "EVENT_SHUTDOWN_GUEST_PANIC", decode_unimp),
> - Decoder(19, "EVENT_SHUTDOWN_GUEST_SUBSYSTEM_RESET",
> decode_unimp),
> - Decoder(20, "EVENT_SHUTDOWN_GUEST_SNAPSHOT_LOAD",
> decode_unimp),
> - Decoder(21, "EVENT_SHUTDOWN___MAX", decode_unimp),
> + Decoder(2, "EVENT_EXCEPTION", decode_exception),
> + Decoder(3, "EVENT_ASYNC_BH", decode_async_bh),
> + Decoder(4, "EVENT_ASYNC_BH_ONESHOT",
> decode_async_bh_oneshot),
> + Decoder(5, "EVENT_ASYNC_INPUT", decode_unimp),
> + Decoder(6, "EVENT_ASYNC_INPUT_SYNC", decode_unimp),
> + Decoder(7, "EVENT_ASYNC_CHAR_READ",
> decode_async_char_read),
> + Decoder(8, "EVENT_ASYNC_BLOCK", decode_async_block),
> + Decoder(9, "EVENT_ASYNC_NET", decode_async_net),
> + Decoder(10, "EVENT_SHUTDOWN", decode_shutdown),
> + Decoder(11, "EVENT_SHUTDOWN_HOST_ERR", decode_shutdown),
> + Decoder(12, "EVENT_SHUTDOWN_HOST_QMP_QUIT",
> decode_shutdown),
> + Decoder(13, "EVENT_SHUTDOWN_HOST_QMP_RESET",
> decode_shutdown),
> + Decoder(14, "EVENT_SHUTDOWN_HOST_SIGNAL", decode_shutdown),
> + Decoder(15, "EVENT_SHUTDOWN_HOST_UI", decode_shutdown),
> + Decoder(16, "EVENT_SHUTDOWN_GUEST_SHUTDOWN",
> decode_shutdown),
> + Decoder(17, "EVENT_SHUTDOWN_GUEST_RESET", decode_shutdown),
> + Decoder(18, "EVENT_SHUTDOWN_GUEST_PANIC", decode_shutdown),
> + Decoder(19, "EVENT_SHUTDOWN_SUBSYS_RESET",
> decode_shutdown),
> + Decoder(20, "EVENT_SHUTDOWN_SNAPSHOT_LOAD",
> decode_shutdown),
> + Decoder(21, "EVENT_SHUTDOWN___MAX", decode_shutdown),
> Decoder(22, "EVENT_CHAR_WRITE", decode_char_write),
> Decoder(23, "EVENT_CHAR_READ_ALL", decode_unimp),
> Decoder(24, "EVENT_CHAR_READ_ALL_ERROR", decode_unimp),
> - Decoder(25, "EVENT_AUDIO_IN", decode_unimp),
> - Decoder(26, "EVENT_AUDIO_OUT", decode_audio_out),
> + Decoder(25, "EVENT_AUDIO_OUT", decode_audio_out),
> + Decoder(26, "EVENT_AUDIO_IN", decode_unimp),
> Decoder(27, "EVENT_RANDOM", decode_random),
> Decoder(28, "EVENT_CLOCK_HOST", decode_clock),
> Decoder(29, "EVENT_CLOCK_VIRTUAL_RT", decode_clock),
> @@ -334,6 +397,7 @@ def decode_random(eid, name, dumpfile):
> Decoder(36, "EVENT_CP_CLOCK_VIRTUAL_RT",
> decode_checkpoint),
> Decoder(37, "EVENT_CP_INIT", decode_checkpoint_init),
> Decoder(38, "EVENT_CP_RESET", decode_checkpoint),
> + Decoder(39, "EVENT_END", decode_end),
> ]
>
> def parse_arguments():
> --
> 2.42.0
>
I'll leave the rest alone for now.
--js
