[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 06/14] simpletrace: improved error handling on struct unpack
From: |
Stefan Hajnoczi |
Subject: |
[PULL 06/14] simpletrace: improved error handling on struct unpack |
Date: |
Thu, 28 Sep 2023 09:43:59 -0400 |
From: Mads Ynddal <m.ynddal@samsung.com>
A failed call to `read_header` wouldn't be handled the same for the two
different code paths (one path would try to use `None` as a list).
Changed to raise exception to be handled centrally. This also allows for
easier unpacking, as errors has been filtered out.
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Mads Ynddal <m.ynddal@samsung.com>
Message-id: 20230926103436.25700-7-mads@ynddal.dk
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
scripts/simpletrace.py | 39 +++++++++++++++------------------------
1 file changed, 15 insertions(+), 24 deletions(-)
diff --git a/scripts/simpletrace.py b/scripts/simpletrace.py
index 971b2a0f6a..8aea0d169b 100755
--- a/scripts/simpletrace.py
+++ b/scripts/simpletrace.py
@@ -37,26 +37,24 @@ def read_header(fobj, hfmt):
hlen = struct.calcsize(hfmt)
hdr = fobj.read(hlen)
if len(hdr) != hlen:
- return None
+ raise ValueError('Error reading header. Wrong filetype provided?')
return struct.unpack(hfmt, hdr)
def get_record(event_mapping, event_id_to_name, rechdr, fobj):
"""Deserialize a trace record from a file into a tuple
(name, timestamp, pid, arg1, ..., arg6)."""
- if rechdr is None:
- return None
- if rechdr[0] != dropped_event_id:
- event_id = rechdr[0]
+ event_id, timestamp_ns, length, pid = rechdr
+ if event_id != dropped_event_id:
name = event_id_to_name[event_id]
- rec = (name, rechdr[1], rechdr[3])
try:
event = event_mapping[name]
except KeyError as e:
- sys.stderr.write('%s event is logged but is not declared ' \
+ sys.stderr.write(f'{e} event is logged but is not declared ' \
'in the trace events file, try using ' \
- 'trace-events-all instead.\n' % str(e))
+ 'trace-events-all instead.\n')
sys.exit(1)
+ rec = (name, timestamp_ns, pid)
for type, name in event.args:
if is_string(type):
l = fobj.read(4)
@@ -67,9 +65,8 @@ def get_record(event_mapping, event_id_to_name, rechdr, fobj):
(value,) = struct.unpack('=Q', fobj.read(8))
rec = rec + (value,)
else:
- rec = ("dropped", rechdr[1], rechdr[3])
- (value,) = struct.unpack('=Q', fobj.read(8))
- rec = rec + (value,)
+ (dropped_count,) = struct.unpack('=Q', fobj.read(8))
+ rec = ("dropped", timestamp_ns, pid, dropped_count)
return rec
def get_mapping(fobj):
@@ -86,22 +83,16 @@ def read_record(event_mapping, event_id_to_name, fobj):
def read_trace_header(fobj):
"""Read and verify trace file header"""
- header = read_header(fobj, log_header_fmt)
- if header is None:
- raise ValueError('Not a valid trace file!')
- if header[0] != header_event_id:
- raise ValueError('Not a valid trace file, header id %d != %d' %
- (header[0], header_event_id))
- if header[1] != header_magic:
- raise ValueError('Not a valid trace file, header magic %d != %d' %
- (header[1], header_magic))
+ _header_event_id, _header_magic, log_version = read_header(fobj,
log_header_fmt)
+ if _header_event_id != header_event_id:
+ raise ValueError(f'Not a valid trace file, header id
{_header_event_id} != {header_event_id}')
+ if _header_magic != header_magic:
+ raise ValueError(f'Not a valid trace file, header magic
{_header_magic} != {header_magic}')
- log_version = header[2]
if log_version not in [0, 2, 3, 4]:
- raise ValueError('Unknown version of tracelog format!')
+ raise ValueError(f'Unknown version {log_version} of tracelog format!')
if log_version != 4:
- raise ValueError('Log format %d not supported with this QEMU release!'
- % log_version)
+ raise ValueError(f'Log format {log_version} not supported with this
QEMU release!')
def read_trace_records(event_mapping, event_id_to_name, fobj):
"""Deserialize trace records from a file, yielding record tuples
(event_num, timestamp, pid, arg1, ..., arg6).
--
2.41.0
- [PULL 00/14] Tracing patches, Stefan Hajnoczi, 2023/09/28
- [PULL 02/14] simpletrace: annotate magic constants from QEMU code, Stefan Hajnoczi, 2023/09/28
- [PULL 03/14] simpletrace: improve parsing of sys.argv; fix files never closed., Stefan Hajnoczi, 2023/09/28
- [PULL 05/14] simpletrace: update code for Python 3.11, Stefan Hajnoczi, 2023/09/28
- [PULL 06/14] simpletrace: improved error handling on struct unpack,
Stefan Hajnoczi <=
- [PULL 08/14] simpletrace: made Analyzer into context-manager, Stefan Hajnoczi, 2023/09/28
- [PULL 01/14] simpletrace: add __all__ to define public interface, Stefan Hajnoczi, 2023/09/28
- [PULL 07/14] simpletrace: define exception and add handling, Stefan Hajnoczi, 2023/09/28
- [PULL 11/14] simpletrace: move event processing to Analyzer class, Stefan Hajnoczi, 2023/09/28
- [PULL 10/14] simpletrace: move logic of process into internal function, Stefan Hajnoczi, 2023/09/28
- [PULL 09/14] simpletrace: refactor to separate responsibilities, Stefan Hajnoczi, 2023/09/28
- [PULL 04/14] simpletrace: changed naming of edict and idtoname to improve readability, Stefan Hajnoczi, 2023/09/28
- [PULL 13/14] MAINTAINERS: add maintainer of simpletrace.py, Stefan Hajnoczi, 2023/09/28
- [PULL 12/14] simpletrace: added simplified Analyzer2 class, Stefan Hajnoczi, 2023/09/28
- [PULL 14/14] scripts/analyse-locks-simpletrace.py: changed iteritems() to items(), Stefan Hajnoczi, 2023/09/28