{"id":2013891,"url":"http://patchwork.ozlabs.org/api/patches/2013891/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20241121154218.1423005-18-berrange@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20241121154218.1423005-18-berrange@redhat.com>","list_archive_url":null,"date":"2024-11-21T15:42:17","name":"[v2,17/18] tests/functional: add a QMP backdoor for debugging stalled tests","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"5d9203bf50de93a0c36cdf0cd4769ce4a305c8b1","submitter":{"id":2694,"url":"http://patchwork.ozlabs.org/api/people/2694/?format=json","name":"Daniel P. Berrangé","email":"berrange@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20241121154218.1423005-18-berrange@redhat.com/mbox/","series":[{"id":433720,"url":"http://patchwork.ozlabs.org/api/series/433720/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=433720","date":"2024-11-21T15:42:05","name":"test/functional: improve functional test debugging & fix tuxrun","version":2,"mbox":"http://patchwork.ozlabs.org/series/433720/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/2013891/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/2013891/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@legolas.ozlabs.org","Authentication-Results":["legolas.ozlabs.org;\n\tdkim=pass (1024-bit key;\n unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256\n header.s=mimecast20190719 header.b=XQY6tPxm;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org\n (client-ip=209.51.188.17; helo=lists.gnu.org;\n envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n receiver=patchwork.ozlabs.org)"],"Received":["from lists.gnu.org (lists.gnu.org [209.51.188.17])\n\t(using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits))\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4XvMx82LrDz1xyG\n\tfor ; Fri, 22 Nov 2024 02:44:44 +1100 (AEDT)","from localhost ([::1] helo=lists1p.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.90_1)\n\t(envelope-from )\n\tid 1tE9M0-0002fd-2i; Thu, 21 Nov 2024 10:44:24 -0500","from eggs.gnu.org ([2001:470:142:3::10])\n by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from )\n id 1tE9Lx-0002bP-5V\n for qemu-devel@nongnu.org; Thu, 21 Nov 2024 10:44:21 -0500","from us-smtp-delivery-124.mimecast.com ([170.10.133.124])\n by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from )\n id 1tE9Lv-00015c-K7\n for qemu-devel@nongnu.org; Thu, 21 Nov 2024 10:44:20 -0500","from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com\n (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by\n relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n cipher=TLS_AES_256_GCM_SHA384) id us-mta-584-PTtEFarwO6e5dqT1A9266Q-1; Thu,\n 21 Nov 2024 10:44:15 -0500","from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com\n (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest\n SHA256)\n (No client certificate requested)\n by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS\n id 20B7C1956095; Thu, 21 Nov 2024 15:44:14 +0000 (UTC)","from toolbox.redhat.com (unknown [10.42.28.5])\n by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP\n id C68191956086; Thu, 21 Nov 2024 15:44:07 +0000 (UTC)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n s=mimecast20190719; t=1732203858;\n h=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n to:to:cc:cc:mime-version:mime-version:content-type:content-type:\n content-transfer-encoding:content-transfer-encoding:\n in-reply-to:in-reply-to:references:references;\n bh=0txKiQWpxyguRebXD1DZVJACnLLYk3HWNLZCDAk2wrg=;\n b=XQY6tPxmR8ZFU+UIssbHFCdscqDtdX6lf3jfXVgcmNuPvzgiYTOaSRdByFwIX0Qjhl9fDO\n RQXAkahULljFMQhTv8ZfiMPRksB9inR5dKVGGWtE+2gG0Ohw/CySAGg+NbnrW/MRaeNavx\n qwVWh+l4cL/zQIPfGMEJASIKXNGsO0o=","X-MC-Unique":"PTtEFarwO6e5dqT1A9266Q-1","X-Mimecast-MFC-AGG-ID":"PTtEFarwO6e5dqT1A9266Q","From":"=?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= ","To":"qemu-devel@nongnu.org","Cc":"Thomas Huth , Ani Sinha ,\n\t=?utf-8?q?Alex_Benn=C3=A9e?= ,\n Peter Maydell , =?utf-8?q?Philippe_Mathieu-Daud?=\n\t=?utf-8?q?=C3=A9?= ,\n =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= ","Subject":"[PATCH v2 17/18] tests/functional: add a QMP backdoor for debugging\n stalled tests","Date":"Thu, 21 Nov 2024 15:42:17 +0000","Message-ID":"<20241121154218.1423005-18-berrange@redhat.com>","In-Reply-To":"<20241121154218.1423005-1-berrange@redhat.com>","References":"<20241121154218.1423005-1-berrange@redhat.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","X-Scanned-By":"MIMEDefang 3.0 on 10.30.177.15","Received-SPF":"pass client-ip=170.10.133.124;\n envelope-from=berrange@redhat.com;\n helo=us-smtp-delivery-124.mimecast.com","X-Spam_score_int":"-21","X-Spam_score":"-2.2","X-Spam_bar":"--","X-Spam_report":"(-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.14,\n DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,\n RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001,\n RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001,\n 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":",\n ","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n ","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org"},"content":"Support the QEMU_TEST_QMP_BACKDOOR=backdoor.sock env variable as a\nway to get a QMP backdoor for debugging a stalled QEMU test. Most\ntypically this would be used if running the tests directly:\n\n $ QEMU_TEST_QMP_BACKDOOR=backdoor.sock \\\n QEMU_TEST_QEMU_BINARY=./build/qemu-system-arm \\\n PYTHONPATH=./python \\\n ./tests/functional/test_arm_tuxrun.py\n\nAnd then, when the test stalls, in a second shell run:\n\n $ ./scripts/qmp/qmp-shell backdoor.sock\n\nSigned-off-by: Daniel P. Berrangé \n---\n docs/devel/testing/functional.rst | 10 ++++++++++\n tests/functional/qemu_test/testcase.py | 7 +++++++\n 2 files changed, 17 insertions(+)","diff":"diff --git a/docs/devel/testing/functional.rst b/docs/devel/testing/functional.rst\nindex 6b5d0c5b98..b8ad7b0bf7 100644\n--- a/docs/devel/testing/functional.rst\n+++ b/docs/devel/testing/functional.rst\n@@ -176,6 +176,16 @@ primarily depend on the value of the ``qemu_bin`` class attribute.\n If it is not explicitly set by the test code, its default value will\n be the result the QEMU_TEST_QEMU_BINARY environment variable.\n \n+Debugging hung QEMU\n+^^^^^^^^^^^^^^^^^^^\n+\n+When test cases go wrong it may be helpful to debug a stalled QEMU\n+process. While the QEMUMachine class owns the primary QMP monitor\n+socket, it is possible to request a second QMP monitor be created\n+by setting the ``QEMU_TEST_QMP_BACKDOOR`` env variable to refer\n+to a UNIX socket name. The ``qmp-shell`` command can then be\n+attached to the stalled QEMU to examine its live state.\n+\n Attribute reference\n -------------------\n \ndiff --git a/tests/functional/qemu_test/testcase.py b/tests/functional/qemu_test/testcase.py\nindex e2a329c3e5..fceafb32b0 100644\n--- a/tests/functional/qemu_test/testcase.py\n+++ b/tests/functional/qemu_test/testcase.py\n@@ -175,6 +175,13 @@ def _new_vm(self, name, *args):\n log_dir=self.logdir)\n self.log.debug('QEMUMachine \"%s\" created', name)\n self.log.debug('QEMUMachine \"%s\" temp_dir: %s', name, vm.temp_dir)\n+\n+ sockpath = os.environ.get(\"QEMU_TEST_QMP_BACKDOOR\", None)\n+ if sockpath is not None:\n+ vm.add_args(\"-chardev\",\n+ f\"socket,id=backdoor,path={sockpath},server=on,wait=off\",\n+ \"-mon\", \"chardev=backdoor,mode=control\")\n+\n if args:\n vm.add_args(*args)\n return vm\n","prefixes":["v2","17/18"]}