scripts/replay-dump.py: replay log dumper
This script is a debugging tool for looking through the contents of a replay log file. It is incomplete but should fail gracefully at events it doesn't understand. It currently understands two different log formats as the audio record/replay support was merged during since MTTCG. It was written to help debug what has caused the BQL changes to break replay support. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Message-Id: <20180227095310.1060.14500.stgit@pasha-VirtualBox> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
Alex Bennée
Paolo Bonzini
parent
66eb7825d0
commit
821c113033
308
scripts/replay-dump.py
Executable file
308
scripts/replay-dump.py
Executable file
@ -0,0 +1,308 @@
|
||||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Dump the contents of a recorded execution stream
|
||||
#
|
||||
# Copyright (c) 2017 Alex Bennée <alex.bennee@linaro.org>
|
||||
#
|
||||
# This library is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU Lesser General Public
|
||||
# License as published by the Free Software Foundation; either
|
||||
# version 2 of the License, or (at your option) any later version.
|
||||
#
|
||||
# This library is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
# Lesser General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public
|
||||
# License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
import argparse
|
||||
import struct
|
||||
from collections import namedtuple
|
||||
|
||||
# This mirrors some of the global replay state which some of the
|
||||
# stream loading refers to. Some decoders may read the next event so
|
||||
# we need handle that case. Calling reuse_event will ensure the next
|
||||
# event is read from the cache rather than advancing the file.
|
||||
|
||||
class ReplayState(object):
|
||||
def __init__(self):
|
||||
self.event = -1
|
||||
self.event_count = 0
|
||||
self.already_read = False
|
||||
self.current_checkpoint = 0
|
||||
self.checkpoint = 0
|
||||
|
||||
def set_event(self, ev):
|
||||
self.event = ev
|
||||
self.event_count += 1
|
||||
|
||||
def get_event(self):
|
||||
self.already_read = False
|
||||
return self.event
|
||||
|
||||
def reuse_event(self, ev):
|
||||
self.event = ev
|
||||
self.already_read = True
|
||||
|
||||
def set_checkpoint(self):
|
||||
self.checkpoint = self.event - self.checkpoint_start
|
||||
|
||||
def get_checkpoint(self):
|
||||
return self.checkpoint
|
||||
|
||||
replay_state = ReplayState()
|
||||
|
||||
# Simple read functions that mirror replay-internal.c
|
||||
# The file-stream is big-endian and manually written out a byte at a time.
|
||||
|
||||
def read_byte(fin):
|
||||
"Read a single byte"
|
||||
return struct.unpack('>B', fin.read(1))[0]
|
||||
|
||||
def read_event(fin):
|
||||
"Read a single byte event, but save some state"
|
||||
if replay_state.already_read:
|
||||
return replay_state.get_event()
|
||||
else:
|
||||
replay_state.set_event(read_byte(fin))
|
||||
return replay_state.event
|
||||
|
||||
def read_word(fin):
|
||||
"Read a 16 bit word"
|
||||
return struct.unpack('>H', fin.read(2))[0]
|
||||
|
||||
def read_dword(fin):
|
||||
"Read a 32 bit word"
|
||||
return struct.unpack('>I', fin.read(4))[0]
|
||||
|
||||
def read_qword(fin):
|
||||
"Read a 64 bit word"
|
||||
return struct.unpack('>Q', fin.read(8))[0]
|
||||
|
||||
# Generic decoder structure
|
||||
Decoder = namedtuple("Decoder", "eid name fn")
|
||||
|
||||
def call_decode(table, index, dumpfile):
|
||||
"Search decode table for next step"
|
||||
decoder = next((d for d in table if d.eid == index), None)
|
||||
if not decoder:
|
||||
print "Could not decode index: %d" % (index)
|
||||
print "Entry is: %s" % (decoder)
|
||||
print "Decode Table is:\n%s" % (table)
|
||||
return False
|
||||
else:
|
||||
return decoder.fn(decoder.eid, decoder.name, dumpfile)
|
||||
|
||||
# Print event
|
||||
def print_event(eid, name, string=None, event_count=None):
|
||||
"Print event with count"
|
||||
if not event_count:
|
||||
event_count = replay_state.event_count
|
||||
|
||||
if string:
|
||||
print "%d:%s(%d) %s" % (event_count, name, eid, string)
|
||||
else:
|
||||
print "%d:%s(%d)" % (event_count, name, eid)
|
||||
|
||||
|
||||
# Decoders for each event type
|
||||
|
||||
def decode_unimp(eid, name, _unused_dumpfile):
|
||||
"Unimplimented decoder, will trigger exit"
|
||||
print "%s not handled - will now stop" % (name)
|
||||
return False
|
||||
|
||||
# Checkpoint decoder
|
||||
def swallow_async_qword(eid, name, dumpfile):
|
||||
"Swallow a qword of data without looking at it"
|
||||
step_id = read_qword(dumpfile)
|
||||
print " %s(%d) @ %d" % (name, eid, step_id)
|
||||
return True
|
||||
|
||||
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),
|
||||
Decoder(3, "REPLAY_ASYNC_CHAR_READ", decode_unimp),
|
||||
Decoder(4, "REPLAY_ASYNC_EVENT_BLOCK", decode_unimp),
|
||||
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"""
|
||||
|
||||
print_event(eid, name)
|
||||
|
||||
async_event_kind = read_byte(dumpfile)
|
||||
async_event_checkpoint = read_byte(dumpfile)
|
||||
|
||||
if async_event_checkpoint != replay_state.current_checkpoint:
|
||||
print " mismatch between checkpoint %d and async data %d" % (
|
||||
replay_state.current_checkpoint, async_event_checkpoint)
|
||||
return True
|
||||
|
||||
return call_decode(async_decode_table, async_event_kind, dumpfile)
|
||||
|
||||
|
||||
def decode_instruction(eid, name, dumpfile):
|
||||
ins_diff = read_dword(dumpfile)
|
||||
print_event(eid, name, "0x%x" % (ins_diff))
|
||||
return True
|
||||
|
||||
def decode_audio_out(eid, name, dumpfile):
|
||||
audio_data = read_dword(dumpfile)
|
||||
print_event(eid, name, "%d" % (audio_data))
|
||||
return True
|
||||
|
||||
def decode_checkpoint(eid, name, dumpfile):
|
||||
"""Decode a checkpoint.
|
||||
|
||||
Checkpoints contain a series of async events with their own specific data.
|
||||
"""
|
||||
replay_state.set_checkpoint()
|
||||
# save event count as we peek ahead
|
||||
event_number = replay_state.event_count
|
||||
next_event = read_event(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:
|
||||
print_event(eid, name, "more data follows", event_number)
|
||||
|
||||
replay_state.reuse_event(next_event)
|
||||
return True
|
||||
|
||||
def decode_checkpoint_init(eid, name, dumpfile):
|
||||
print_event(eid, name)
|
||||
return True
|
||||
|
||||
def decode_interrupt(eid, name, dumpfile):
|
||||
print_event(eid, name)
|
||||
return True
|
||||
|
||||
def decode_clock(eid, name, dumpfile):
|
||||
clock_data = read_qword(dumpfile)
|
||||
print_event(eid, name, "0x%x" % (clock_data))
|
||||
return True
|
||||
|
||||
|
||||
# pre-MTTCG merge
|
||||
v5_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(4, "EVENT_SHUTDOWN", decode_unimp),
|
||||
Decoder(5, "EVENT_CHAR_WRITE", decode_unimp),
|
||||
Decoder(6, "EVENT_CHAR_READ_ALL", decode_unimp),
|
||||
Decoder(7, "EVENT_CHAR_READ_ALL_ERROR", decode_unimp),
|
||||
Decoder(8, "EVENT_CLOCK_HOST", decode_clock),
|
||||
Decoder(9, "EVENT_CLOCK_VIRTUAL_RT", decode_clock),
|
||||
Decoder(10, "EVENT_CP_CLOCK_WARP_START", decode_checkpoint),
|
||||
Decoder(11, "EVENT_CP_CLOCK_WARP_ACCOUNT", decode_checkpoint),
|
||||
Decoder(12, "EVENT_CP_RESET_REQUESTED", decode_checkpoint),
|
||||
Decoder(13, "EVENT_CP_SUSPEND_REQUESTED", decode_checkpoint),
|
||||
Decoder(14, "EVENT_CP_CLOCK_VIRTUAL", decode_checkpoint),
|
||||
Decoder(15, "EVENT_CP_CLOCK_HOST", decode_checkpoint),
|
||||
Decoder(16, "EVENT_CP_CLOCK_VIRTUAL_RT", decode_checkpoint),
|
||||
Decoder(17, "EVENT_CP_INIT", decode_checkpoint_init),
|
||||
Decoder(18, "EVENT_CP_RESET", decode_checkpoint),
|
||||
]
|
||||
|
||||
# post-MTTCG merge, AUDIO support added
|
||||
v6_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(4, "EVENT_SHUTDOWN", decode_unimp),
|
||||
Decoder(5, "EVENT_CHAR_WRITE", decode_unimp),
|
||||
Decoder(6, "EVENT_CHAR_READ_ALL", decode_unimp),
|
||||
Decoder(7, "EVENT_CHAR_READ_ALL_ERROR", decode_unimp),
|
||||
Decoder(8, "EVENT_AUDIO_OUT", decode_audio_out),
|
||||
Decoder(9, "EVENT_AUDIO_IN", decode_unimp),
|
||||
Decoder(10, "EVENT_CLOCK_HOST", decode_clock),
|
||||
Decoder(11, "EVENT_CLOCK_VIRTUAL_RT", decode_clock),
|
||||
Decoder(12, "EVENT_CP_CLOCK_WARP_START", decode_checkpoint),
|
||||
Decoder(13, "EVENT_CP_CLOCK_WARP_ACCOUNT", decode_checkpoint),
|
||||
Decoder(14, "EVENT_CP_RESET_REQUESTED", decode_checkpoint),
|
||||
Decoder(15, "EVENT_CP_SUSPEND_REQUESTED", decode_checkpoint),
|
||||
Decoder(16, "EVENT_CP_CLOCK_VIRTUAL", decode_checkpoint),
|
||||
Decoder(17, "EVENT_CP_CLOCK_HOST", decode_checkpoint),
|
||||
Decoder(18, "EVENT_CP_CLOCK_VIRTUAL_RT", decode_checkpoint),
|
||||
Decoder(19, "EVENT_CP_INIT", decode_checkpoint_init),
|
||||
Decoder(20, "EVENT_CP_RESET", decode_checkpoint),
|
||||
]
|
||||
|
||||
# Shutdown cause added
|
||||
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(4, "EVENT_SHUTDOWN", decode_unimp),
|
||||
Decoder(5, "EVENT_SHUTDOWN_HOST_ERR", decode_unimp),
|
||||
Decoder(6, "EVENT_SHUTDOWN_HOST_QMP", decode_unimp),
|
||||
Decoder(7, "EVENT_SHUTDOWN_HOST_SIGNAL", decode_unimp),
|
||||
Decoder(8, "EVENT_SHUTDOWN_HOST_UI", decode_unimp),
|
||||
Decoder(9, "EVENT_SHUTDOWN_GUEST_SHUTDOWN", decode_unimp),
|
||||
Decoder(10, "EVENT_SHUTDOWN_GUEST_RESET", decode_unimp),
|
||||
Decoder(11, "EVENT_SHUTDOWN_GUEST_PANIC", decode_unimp),
|
||||
Decoder(12, "EVENT_SHUTDOWN___MAX", decode_unimp),
|
||||
Decoder(13, "EVENT_CHAR_WRITE", decode_unimp),
|
||||
Decoder(14, "EVENT_CHAR_READ_ALL", decode_unimp),
|
||||
Decoder(15, "EVENT_CHAR_READ_ALL_ERROR", decode_unimp),
|
||||
Decoder(16, "EVENT_AUDIO_OUT", decode_audio_out),
|
||||
Decoder(17, "EVENT_AUDIO_IN", decode_unimp),
|
||||
Decoder(18, "EVENT_CLOCK_HOST", decode_clock),
|
||||
Decoder(19, "EVENT_CLOCK_VIRTUAL_RT", decode_clock),
|
||||
Decoder(20, "EVENT_CP_CLOCK_WARP_START", decode_checkpoint),
|
||||
Decoder(21, "EVENT_CP_CLOCK_WARP_ACCOUNT", decode_checkpoint),
|
||||
Decoder(22, "EVENT_CP_RESET_REQUESTED", decode_checkpoint),
|
||||
Decoder(23, "EVENT_CP_SUSPEND_REQUESTED", decode_checkpoint),
|
||||
Decoder(24, "EVENT_CP_CLOCK_VIRTUAL", decode_checkpoint),
|
||||
Decoder(25, "EVENT_CP_CLOCK_HOST", decode_checkpoint),
|
||||
Decoder(26, "EVENT_CP_CLOCK_VIRTUAL_RT", decode_checkpoint),
|
||||
Decoder(27, "EVENT_CP_INIT", decode_checkpoint_init),
|
||||
Decoder(28, "EVENT_CP_RESET", decode_checkpoint),
|
||||
]
|
||||
|
||||
def parse_arguments():
|
||||
"Grab arguments for script"
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("-f", "--file", help='record/replay dump to read from',
|
||||
required=True)
|
||||
return parser.parse_args()
|
||||
|
||||
def decode_file(filename):
|
||||
"Decode a record/replay dump"
|
||||
dumpfile = open(filename, "rb")
|
||||
|
||||
# read and throwaway the header
|
||||
version = read_dword(dumpfile)
|
||||
junk = read_qword(dumpfile)
|
||||
|
||||
print "HEADER: version 0x%x" % (version)
|
||||
|
||||
if version == 0xe02007:
|
||||
event_decode_table = v7_event_table
|
||||
replay_state.checkpoint_start = 12
|
||||
elif version == 0xe02006:
|
||||
event_decode_table = v6_event_table
|
||||
replay_state.checkpoint_start = 12
|
||||
else:
|
||||
event_decode_table = v5_event_table
|
||||
replay_state.checkpoint_start = 10
|
||||
|
||||
try:
|
||||
decode_ok = True
|
||||
while decode_ok:
|
||||
event = read_event(dumpfile)
|
||||
decode_ok = call_decode(event_decode_table, event, dumpfile)
|
||||
finally:
|
||||
dumpfile.close()
|
||||
|
||||
if __name__ == "__main__":
|
||||
args = parse_arguments()
|
||||
decode_file(args.file)
|
||||
Loading…
Reference in New Issue
Block a user