From nobody Mon May 6 22:14:37 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; 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; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1642500202569481.0047319381122; Tue, 18 Jan 2022 02:03:22 -0800 (PST) Received: from localhost ([::1]:45140 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n9lKj-0002oY-F1 for importer@patchew.org; Tue, 18 Jan 2022 05:03:21 -0500 Received: from eggs.gnu.org ([209.51.188.92]:52048) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n9lJJ-0001OZ-2C for qemu-devel@nongnu.org; Tue, 18 Jan 2022 05:01:53 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:51083) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n9lJH-0003cf-4s for qemu-devel@nongnu.org; Tue, 18 Jan 2022 05:01:52 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-88-NB4Jzo4qNe-MuIgKZcCNQw-1; Tue, 18 Jan 2022 05:01:49 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id A031A84BA44; Tue, 18 Jan 2022 10:01:46 +0000 (UTC) Received: from localhost.localdomain.com (unknown [10.39.195.32]) by smtp.corp.redhat.com (Postfix) with ESMTP id ECFE5752AF; Tue, 18 Jan 2022 10:01:44 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1642500110; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=rXnXdC1zwm1UiplPGJpQHfIzgsa6JempxzT98DY6IH0=; b=M53q9fB15OXfryLvJ4jyrQlGGeySjuCoXK3hMfpqXKo6hp/BRk1vLV1jGw8qRpVBiRFLej TKbQ3WMtL9Cg9IHJvtypDqr/LIYMzry5fu01PA5BGCDqxiMtY3ZANpc1gUhvLXR/F4RnDv U19uW+1DuD26xBHNV5WmrfUsJ/2UdkY= X-MC-Unique: NB4Jzo4qNe-MuIgKZcCNQw-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Subject: [PATCH v2 1/2] python: introduce qmp-shell-wrap convenience tool Date: Tue, 18 Jan 2022 10:01:39 +0000 Message-Id: <20220118100140.252920-2-berrange@redhat.com> In-Reply-To: <20220118100140.252920-1-berrange@redhat.com> References: <20220118100140.252920-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=berrange@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable 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=170.10.133.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.7, 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_H3=0.001, RCVD_IN_MSPIKE_WL=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: , Cc: Eduardo Habkost , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , John Snow , Markus Armbruster , Cleber Rosa Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1642500203837100002 With the current 'qmp-shell' tool developers must first spawn QEMU with a suitable -qmp arg and then spawn qmp-shell in a separate terminal pointing to the right socket. With 'qmp-shell-wrap' developers can ignore QMP sockets entirely and just pass the QEMU command and arguments they want. The program will listen on a UNIX socket and tell QEMU to connect QMP to that. For example, this: # qmp-shell-wrap -- qemu-system-x86_64 -display none Is roughly equivalent of running: # qemu-system-x86_64 -display none -qmp qmp-shell-1234 & # qmp-shell qmp-shell-1234 Except that 'qmp-shell-wrap' switches the socket peers around so that it is the UNIX socket server and QEMU is the socket client. This makes QEMU reliably go away when qmp-shell-wrap exits, closing the server socket. Signed-off-by: Daniel P. Berrang=C3=A9 --- python/qemu/qmp/qmp_shell.py | 67 +++++++++++++++++++++++++++++++++--- scripts/qmp/qmp-shell-wrap | 11 ++++++ 2 files changed, 74 insertions(+), 4 deletions(-) create mode 100755 scripts/qmp/qmp-shell-wrap diff --git a/python/qemu/qmp/qmp_shell.py b/python/qemu/qmp/qmp_shell.py index e7d7eb18f1..fb9e7701af 100644 --- a/python/qemu/qmp/qmp_shell.py +++ b/python/qemu/qmp/qmp_shell.py @@ -86,6 +86,7 @@ import os import re import readline +from subprocess import Popen import sys from typing import ( Iterator, @@ -162,8 +163,10 @@ class QMPShell(qmp.QEMUMonitorProtocol): :param verbose: Echo outgoing QMP messages to console. """ def __init__(self, address: qmp.SocketAddrT, - pretty: bool =3D False, verbose: bool =3D False): - super().__init__(address) + pretty: bool =3D False, + verbose: bool =3D False, + server: bool =3D False): + super().__init__(address, server=3Dserver) self._greeting: Optional[QMPMessage] =3D None self._completer =3D QMPCompleter() self._transmode =3D False @@ -404,8 +407,10 @@ class HMPShell(QMPShell): :param verbose: Echo outgoing QMP messages to console. """ def __init__(self, address: qmp.SocketAddrT, - pretty: bool =3D False, verbose: bool =3D False): - super().__init__(address, pretty, verbose) + pretty: bool =3D False, + verbose: bool =3D False, + server: bool =3D False): + super().__init__(address, pretty, verbose, server) self._cpu_index =3D 0 =20 def _cmd_completion(self) -> None: @@ -530,5 +535,59 @@ def main() -> None: pass =20 =20 +def main_wrap() -> None: + """ + qmp-shell-wrap entry point: parse command line arguments and + start the REPL. + """ + parser =3D argparse.ArgumentParser() + parser.add_argument('-H', '--hmp', action=3D'store_true', + help=3D'Use HMP interface') + parser.add_argument('-v', '--verbose', action=3D'store_true', + help=3D'Verbose (echo commands sent and received)') + parser.add_argument('-p', '--pretty', action=3D'store_true', + help=3D'Pretty-print JSON') + + parser.add_argument('command', nargs=3Dargparse.REMAINDER, + help=3D'QEMU command line to invoke') + + args =3D parser.parse_args() + + cmd =3D args.command + if len(cmd) !=3D 0 and cmd[0] =3D=3D '--': + cmd =3D cmd[1:] + if len(cmd) =3D=3D 0: + cmd =3D ["qemu-system-x86_64"] + + sockpath =3D "qmp-shell-wrap-%d" % os.getpid() + cmd +=3D ["-qmp", "unix:%s" % sockpath] + + shell_class =3D HMPShell if args.hmp else QMPShell + + try: + address =3D shell_class.parse_address(sockpath) + except qmp.QMPBadPortError: + parser.error(f"Bad port number: {sockpath}") + return # pycharm doesn't know error() is noreturn + + try: + with shell_class(address, args.pretty, args.verbose, True) as qemu: + with Popen(cmd): + + try: + qemu.accept() + except qmp.QMPConnectError: + die("Didn't get QMP greeting message") + except qmp.QMPCapabilitiesError: + die("Couldn't negotiate capabilities") + except OSError as err: + die(f"Couldn't connect to {sockpath}: {err!s}") + + for _ in qemu.repl(): + pass + finally: + os.unlink(sockpath) + + if __name__ =3D=3D '__main__': main() diff --git a/scripts/qmp/qmp-shell-wrap b/scripts/qmp/qmp-shell-wrap new file mode 100755 index 0000000000..9e94da114f --- /dev/null +++ b/scripts/qmp/qmp-shell-wrap @@ -0,0 +1,11 @@ +#!/usr/bin/env python3 + +import os +import sys + +sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'pytho= n')) +from qemu.qmp import qmp_shell + + +if __name__ =3D=3D '__main__': + qmp_shell.main_wrap() --=20 2.33.1 From nobody Mon May 6 22:14:37 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; 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; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1642500394333673.4733713962381; Tue, 18 Jan 2022 02:06:34 -0800 (PST) Received: from localhost ([::1]:48574 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n9lNo-0005GS-T4 for importer@patchew.org; Tue, 18 Jan 2022 05:06:32 -0500 Received: from eggs.gnu.org ([209.51.188.92]:52064) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n9lJK-0001RY-VA for qemu-devel@nongnu.org; Tue, 18 Jan 2022 05:01:54 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:23831) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n9lJJ-0003e1-4i for qemu-devel@nongnu.org; Tue, 18 Jan 2022 05:01:54 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-655-eecB9D5zMzS7TQnP0oChCA-1; Tue, 18 Jan 2022 05:01:49 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 7254F8143EB; Tue, 18 Jan 2022 10:01:48 +0000 (UTC) Received: from localhost.localdomain.com (unknown [10.39.195.32]) by smtp.corp.redhat.com (Postfix) with ESMTP id EB41F752B0; Tue, 18 Jan 2022 10:01:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1642500112; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=vg7wtdNl7EHdOs1pzdEMmalySNr2Ja7mGOZjXy4QXjM=; b=ImK9JQtzxgtOrck9K6k22c8vHZj/0EcueqDa8oWSR2TLxbGy8MbiW1OSlEgIBNRhXn/2L2 aHwyJDJC985TcNXh10i6qGSd1f0iQveVrqiZNaucnYaGIqQwypfPcHnapTStyxB1fZslA8 bAZrKoV4DdPp+4nBrF/ohwiXESyjCVg= X-MC-Unique: eecB9D5zMzS7TQnP0oChCA-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Subject: [PATCH v2 2/2] python: support recording QMP session to a file Date: Tue, 18 Jan 2022 10:01:40 +0000 Message-Id: <20220118100140.252920-3-berrange@redhat.com> In-Reply-To: <20220118100140.252920-1-berrange@redhat.com> References: <20220118100140.252920-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=berrange@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable 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=170.10.129.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.7, 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_H3=0.001, RCVD_IN_MSPIKE_WL=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: , Cc: Eduardo Habkost , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , John Snow , Markus Armbruster , Cleber Rosa Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1642500395334100001 When running QMP commands with very large response payloads, it is often not easy to spot the info you want. If we can save the response to a file then tools like 'grep' or 'jq' can be used to extract information. For convenience of processing, we merge the QMP command and response dictionaries together: { "arguments": {}, "execute": "query-kvm", "return": { "enabled": false, "present": true } } Example usage $ ./scripts/qmp/qmp-shell-wrap -l q.log -p -- ./build/qemu-system-x86_64 = -display none Welcome to the QMP low-level shell! Connected (QEMU) query-kvm { "return": { "enabled": false, "present": true } } (QEMU) query-mice { "return": [ { "absolute": false, "current": true, "index": 2, "name": "QEMU PS/2 Mouse" } ] } $ jq --slurp '. | to_entries[] | select(.value.execute =3D=3D "query-kvm")= | .value.return.enabled' < q.log false Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- python/qemu/qmp/qmp_shell.py | 29 ++++++++++++++++++++++------- python/setup.cfg | 3 +++ 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/python/qemu/qmp/qmp_shell.py b/python/qemu/qmp/qmp_shell.py index fb9e7701af..2b54114bd2 100644 --- a/python/qemu/qmp/qmp_shell.py +++ b/python/qemu/qmp/qmp_shell.py @@ -89,6 +89,7 @@ from subprocess import Popen import sys from typing import ( + IO, Iterator, List, NoReturn, @@ -165,7 +166,8 @@ class QMPShell(qmp.QEMUMonitorProtocol): def __init__(self, address: qmp.SocketAddrT, pretty: bool =3D False, verbose: bool =3D False, - server: bool =3D False): + server: bool =3D False, + logfile: Optional[str] =3D None): super().__init__(address, server=3Dserver) self._greeting: Optional[QMPMessage] =3D None self._completer =3D QMPCompleter() @@ -175,6 +177,10 @@ def __init__(self, address: qmp.SocketAddrT, '.qmp-shell_history') self.pretty =3D pretty self.verbose =3D verbose + self.logfile =3D None + + if logfile is not None: + self.logfile =3D open(logfile, "w", encoding=3D'utf-8') =20 def close(self) -> None: # Hook into context manager of parent to save shell history. @@ -315,11 +321,11 @@ def _build_cmd(self, cmdline: str) -> Optional[QMPMes= sage]: self._cli_expr(cmdargs[1:], qmpcmd['arguments']) return qmpcmd =20 - def _print(self, qmp_message: object) -> None: + def _print(self, qmp_message: object, fh: IO[str] =3D sys.stdout) -> N= one: jsobj =3D json.dumps(qmp_message, indent=3D4 if self.pretty else None, sort_keys=3Dself.pretty) - print(str(jsobj)) + print(str(jsobj), file=3Dfh) =20 def _execute_cmd(self, cmdline: str) -> bool: try: @@ -342,6 +348,9 @@ def _execute_cmd(self, cmdline: str) -> bool: print('Disconnected') return False self._print(resp) + if self.logfile is not None: + cmd =3D {**qmpcmd, **resp} + self._print(cmd, fh=3Dself.logfile) return True =20 def connect(self, negotiate: bool =3D True) -> None: @@ -409,8 +418,9 @@ class HMPShell(QMPShell): def __init__(self, address: qmp.SocketAddrT, pretty: bool =3D False, verbose: bool =3D False, - server: bool =3D False): - super().__init__(address, pretty, verbose, server) + server: bool =3D False, + logfile: Optional[str] =3D None): + super().__init__(address, pretty, verbose, server, logfile) self._cpu_index =3D 0 =20 def _cmd_completion(self) -> None: @@ -503,6 +513,8 @@ def main() -> None: help=3D'Verbose (echo commands sent and received)') parser.add_argument('-p', '--pretty', action=3D'store_true', help=3D'Pretty-print JSON') + parser.add_argument('-l', '--logfile', + help=3D'Save log of all QMP messages to PATH') =20 default_server =3D os.environ.get('QMP_SOCKET') parser.add_argument('qmp_server', action=3D'store', @@ -521,7 +533,7 @@ def main() -> None: parser.error(f"Bad port number: {args.qmp_server}") return # pycharm doesn't know error() is noreturn =20 - with shell_class(address, args.pretty, args.verbose) as qemu: + with shell_class(address, args.pretty, args.verbose, args.logfile) as = qemu: try: qemu.connect(negotiate=3Dnot args.skip_negotiation) except qmp.QMPConnectError: @@ -547,6 +559,8 @@ def main_wrap() -> None: help=3D'Verbose (echo commands sent and received)') parser.add_argument('-p', '--pretty', action=3D'store_true', help=3D'Pretty-print JSON') + parser.add_argument('-l', '--logfile', + help=3D'Save log of all QMP messages to PATH') =20 parser.add_argument('command', nargs=3Dargparse.REMAINDER, help=3D'QEMU command line to invoke') @@ -571,7 +585,8 @@ def main_wrap() -> None: return # pycharm doesn't know error() is noreturn =20 try: - with shell_class(address, args.pretty, args.verbose, True) as qemu: + with shell_class(address, args.pretty, args.verbose, + True, args.logfile) as qemu: with Popen(cmd): =20 try: diff --git a/python/setup.cfg b/python/setup.cfg index 417e937839..a909321d00 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -113,7 +113,10 @@ ignore_missing_imports =3D True # no Warning level messages displayed, use "--disable=3Dall --enable=3Dcla= sses # --disable=3DW". disable=3Dconsider-using-f-string, + consider-using-with, + too-many-arguments, too-many-function-args, # mypy handles this with less false posit= ives. + too-many-instance-attributes, no-member, # mypy also handles this better. =20 [pylint.basic] --=20 2.33.1