From nobody Thu Nov 28 13:32:34 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org ARC-Seal: i=1; a=rsa-sha256; t=1692780903; cv=none; d=zohomail.com; s=zohoarc; b=U70wMKIB2FgGIsKB48mBfG2OzYvtHnflvXgzWihxbgwjDsF7E6dvVVTFNOs5Tj9JDeDqFzFMBZ2IWBoO+EH6R83sV3KFMrtNJWJoB+JgegXEAs9vBH9+9CB78u3J0UCQTY3EdojHoQZMjt9pjjWo7/50CV+06bDcpaMsbPVrrwA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1692780903; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=tRX60fqCDLTAh6rk1c2F28puMh0+hQQ2UdFppuN+qzw=; b=b/YY9FLZ/5NqmGRgFXuZ0NEKg8wQPP11zNfOFt2pNdxPCQHtYz+6dYnzylQgA/XKZ9Mlim/APoePzsJwvQdWAz7CC4J43OWTzvzrZf6qQxjWAmTI4fI0r+KKPTFjoeDCxwg1mrNK3YkubuQyHhOd7cVqv8TG+K2E9sa54pose4s= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1692780903087329.0080187898078; Wed, 23 Aug 2023 01:55:03 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qYjdY-0003sb-R9; Wed, 23 Aug 2023 04:54:48 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qYjdW-0003ri-9r for qemu-devel@nongnu.org; Wed, 23 Aug 2023 04:54:46 -0400 Received: from pv50p00im-tydg10021701.me.com ([17.58.6.54]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qYjdU-00089n-H9 for qemu-devel@nongnu.org; Wed, 23 Aug 2023 04:54:46 -0400 Received: from localhost.localdomain (pv50p00im-dlb-asmtp-mailmevip.me.com [17.56.9.10]) by pv50p00im-tydg10021701.me.com (Postfix) with ESMTPSA id 1FDE73A09FD; Wed, 23 Aug 2023 08:54:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ynddal.dk; s=sig1; t=1692780883; bh=tRX60fqCDLTAh6rk1c2F28puMh0+hQQ2UdFppuN+qzw=; h=From:To:Subject:Date:Message-Id:MIME-Version; b=hujTVxBYx8DOG5HkgEcZxDVloLGfRlEcWef5gehQHRcc5VQCK6mRUTwPbjA/i7zD4 0S3k0N/P8SC0/9PO7AFyKN+r0hZIw74SHeAQi8LtshGQMD60kzhXRiYl1Qx5NaIez2 DcANC+A8+UpTgJxmwnDOz9HPhFqexJ9sYIaW5m28M6J1wxq5dqsSIYV4xG0XnpvFmp ustb3GyMAwxwdBkcnBVg+QJjwJCEbJ5m/R3fw83jZgzV7Lv4GVVP320QpJp1NUyoOU XHp2BwQZXBnOyFmW+LqG57GdKrtf2Q7k7jcBN2DfmkEoyUkkLkW0c5kiS/0Tv+kglY fct23OdvJfDiA== From: Mads Ynddal To: qemu-devel@nongnu.org Cc: John Snow , Mads Ynddal , Stefan Hajnoczi , Cleber Rosa , Mads Ynddal Subject: [PATCH v4 03/14] simpletrace: improve parsing of sys.argv; fix files never closed. Date: Wed, 23 Aug 2023 10:54:18 +0200 Message-Id: <20230823085429.20519-4-mads@ynddal.dk> X-Mailer: git-send-email 2.38.1 In-Reply-To: <20230823085429.20519-1-mads@ynddal.dk> References: <20230823085429.20519-1-mads@ynddal.dk> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Proofpoint-ORIG-GUID: iMe5a3eH0NtAnc3b2_trxUtkugqKIUub X-Proofpoint-GUID: iMe5a3eH0NtAnc3b2_trxUtkugqKIUub X-Proofpoint-Virus-Version: =?UTF-8?Q?vendor=3Dfsecure_engine=3D1.1.170-22c6f66c430a71ce266a39bfe25bc?= =?UTF-8?Q?2903e8d5c8f:6.0.517,18.0.883,17.11.64.514.0000000_definitions?= =?UTF-8?Q?=3D2022-06-21=5F08:2022-06-21=5F01,2022-06-21=5F08,2022-02-23?= =?UTF-8?Q?=5F01_signatures=3D0?= X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 spamscore=0 mlxlogscore=697 clxscore=1030 bulkscore=0 adultscore=0 phishscore=0 suspectscore=0 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2212070000 definitions=main-2308230080 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=17.58.6.54; envelope-from=mads@ynddal.dk; helo=pv50p00im-tydg10021701.me.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @ynddal.dk) X-ZM-MESSAGEID: 1692780904585100001 Content-Type: text/plain; charset="utf-8" From: Mads Ynddal The arguments extracted from `sys.argv` named and unpacked to make it clear what the arguments are and what they're used for. The two input files were opened, but never explicitly closed. File usage changed to use `with` statement to take care of this. At the same time, ownership of the file-object is moved up to `run` function. Added option to process to support file-like objects. Signed-off-by: Mads Ynddal Reviewed-by: Stefan Hajnoczi --- scripts/simpletrace.py | 50 ++++++++++++++++++++++++++++-------------- 1 file changed, 34 insertions(+), 16 deletions(-) diff --git a/scripts/simpletrace.py b/scripts/simpletrace.py index 5c230a1b74..283b5918a1 100755 --- a/scripts/simpletrace.py +++ b/scripts/simpletrace.py @@ -9,6 +9,7 @@ # # For help see docs/devel/tracing.rst =20 +import sys import struct import inspect from tracetool import read_events, Event @@ -51,7 +52,6 @@ def get_record(edict, idtoname, rechdr, fobj): try: event =3D edict[name] except KeyError as e: - import sys sys.stderr.write('%s event is logged but is not declared ' \ 'in the trace events file, try using ' \ 'trace-events-all instead.\n' % str(e)) @@ -172,11 +172,28 @@ def end(self): pass =20 def process(events, log, analyzer, read_header=3DTrue): - """Invoke an analyzer on each event in a log.""" + """Invoke an analyzer on each event in a log. + Args: + events (file-object or list or str): events list or file-like obje= ct or file path as str to read event data from + log (file-object or str): file-like object or file path as str to = read log data from + analyzer (Analyzer): Instance of Analyzer to interpret the event d= ata + read_header (bool, optional): Whether to read header data from the= log data. Defaults to True. + """ + if isinstance(events, str): - events =3D read_events(open(events, 'r'), events) + with open(events, 'r') as f: + events_list =3D read_events(f, events) + elif isinstance(events, list): + # Treat as a list of events already produced by tracetool.read_eve= nts + events_list =3D events + else: + # Treat as an already opened file-object + events_list =3D read_events(events, events.name) + + close_log =3D False if isinstance(log, str): log =3D open(log, 'rb') + close_log =3D True =20 if read_header: read_trace_header(log) @@ -187,12 +204,12 @@ def process(events, log, analyzer, read_header=3DTrue= ): edict =3D {"dropped": dropped_event} idtoname =3D {dropped_event_id: "dropped"} =20 - for event in events: + for event in events_list: edict[event.name] =3D event =20 # If there is no header assume event ID mapping matches events list if not read_header: - for event_id, event in enumerate(events): + for event_id, event in enumerate(events_list): idtoname[event_id] =3D event.name =20 def build_fn(analyzer, event): @@ -225,24 +242,25 @@ def build_fn(analyzer, event): fn_cache[event_num](event, rec) analyzer.end() =20 + if close_log: + log.close() + def run(analyzer): """Execute an analyzer on a trace file given on the command-line. =20 This function is useful as a driver for simple analysis scripts. More advanced scripts will want to call process() instead.""" - import sys - - read_header =3D True - if len(sys.argv) =3D=3D 4 and sys.argv[1] =3D=3D '--no-header': - read_header =3D False - del sys.argv[1] - elif len(sys.argv) !=3D 3: - sys.stderr.write('usage: %s [--no-header] ' \ - '\n' % sys.argv[0]) + + try: + # NOTE: See built-in `argparse` module for a more robust cli inter= face + *no_header, trace_event_path, trace_file_path =3D sys.argv[1:] + assert no_header =3D=3D [] or no_header =3D=3D ['--no-header'], 'I= nvalid no-header argument' + except (AssertionError, ValueError): + sys.stderr.write(f'usage: {sys.argv[0]} [--no-header] \n') sys.exit(1) =20 - events =3D read_events(open(sys.argv[1], 'r'), sys.argv[1]) - process(events, sys.argv[2], analyzer, read_header=3Dread_header) + with open(trace_event_path, 'r') as events_fobj, open(trace_file_path,= 'rb') as log_fobj: + process(events_fobj, log_fobj, analyzer, read_header=3Dnot no_head= er) =20 if __name__ =3D=3D '__main__': class Formatter(Analyzer): --=20 2.38.1