From patchwork Fri Jul 24 06:45:07 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 247125 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp2187502ilg; Thu, 23 Jul 2020 23:54:01 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxV27mXzBc0kuWdwp16LcBkhVaU9iiAnmTI8GKEaTx4IrnYR+lTJrH3CVD5cp0D1BhwmSWi X-Received: by 2002:a25:ac66:: with SMTP id r38mr13242441ybd.105.1595573640964; Thu, 23 Jul 2020 23:54:00 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1595573640; cv=none; d=google.com; s=arc-20160816; b=r9Ri8VooSu+/nwEx/RxyM9NauLkNyHhIKvChykwd1Xp+AsDA82Lt2wO6qqX0vSArpZ nUpFNLBS8YQlLkYyWlHXXdgjkzks16RL2SImtrIn7RoQ9R5xW0OmmWZP5K+xjFXZqKPC k+qZrMnMuyNtucyhKZMK+F3ag4X22sIrEcVvNypMPzVvx5rYqtf778sK4zCx/0V8xP1h c/UT/MXCqsJ8uOyCnQPH9eFQPibDUg+Yk7xmUqKGlskEAtFtXNXhupB5m3Z1ONtudAdT UjqHfX+CmAIEAWg9aGFxHg0LYiK3olr2kjHW7KiaAQp8tVevAj2lzRB94YluDgNSTRZ1 Lkyw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=tbuf3a7z9rzul3Y2V8EPpXFJXL5dyVGH3TuBWvwpmx8=; b=LMojEYyvNn2b7e53pkt3err0OdRV/enq/h9/owO6juGDY1wLBYE4zMZhN9JHD9fMal X0TRn2ahxo+jn1qfdwWDqImJh2lRjcced0/BTdAfHDr7Arsu0e3V3cMQzw79S6UMeg9q 6edBAcehqL2mNVHSb1DwapeRN9FijpLjyP18LjLKlOLvlQVIdicBVIiqNle8R3dRZU8c xIjQG/3OlZhdRDQ8gsyuTpxnTW1/gXd8zWNQGifoiO2DAfJ61f9oCKjQ2mwrX3XhP9ol pp2t5Kx8h8MCBa71MtgYah7CE8QbabLQhUtNg7LxHdfwNUu3bikss3bfPYKc468zC6u9 3QYw== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=czH50u3r; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id g3si665292ybd.56.2020.07.23.23.54.00 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 23 Jul 2020 23:54:00 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=czH50u3r; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:45346 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jyrai-00017b-F6 for patch@linaro.org; Fri, 24 Jul 2020 02:54:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:38110) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jyrSZ-0004Qc-OD for qemu-devel@nongnu.org; Fri, 24 Jul 2020 02:45:35 -0400 Received: from mail-wr1-x42d.google.com ([2a00:1450:4864:20::42d]:38570) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jyrSV-0000M8-Dp for qemu-devel@nongnu.org; Fri, 24 Jul 2020 02:45:34 -0400 Received: by mail-wr1-x42d.google.com with SMTP id a14so7260674wra.5 for ; Thu, 23 Jul 2020 23:45:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=tbuf3a7z9rzul3Y2V8EPpXFJXL5dyVGH3TuBWvwpmx8=; b=czH50u3rdbRKcqYW6O5nHGT5vMnGOw9i0OwjLR9SQG4rOaIMI9u9Jv18+prPTSZikr qqeoY1yHgC/uiPjNtO/w+JlF3gLsXoZp+YJoMfsNjoPpuXCIwYvqZgBbnLuagimF90+q 7wXvzW2NktKCzk7QeleUf3bjBpSckUgzuySjJwzPGosKsQAqi0/MJSdrF9bK5dVytEOF cyUvKNdSswW+EROQEIqPf9TT/QBCAbAGgITpF1mzqB6vIDZc7P8aFWZSd2sWnbT8xCf1 7xdED4O5dDCDK19NxIGSALZdbeKVXjHIlTSaHQQiEoZKh4hMKs3AuQJHmk9YtgNqYksk 5sYg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=tbuf3a7z9rzul3Y2V8EPpXFJXL5dyVGH3TuBWvwpmx8=; b=tn6+9hptF+TCff8rn9itLIC1TtYZoRPKUQ/81v3//dp5PoiLUCkLxWUnwMdhpdwTbs /HSxUhmQ9vxU0WCQweWRsS2Qpgc7V23XaxHP/L3DQvVuIQ5YEJiefiq52c7VuNB51O6G 5se3Dz+bHxL0knoJRTajE1beXnmZFjFqRxl6fvcGQYdX2ZxkDY2LlSI7JkwUFBTCvJAe AiRiYMdvoCiePKRq6h3bHj109BlmmJuGKe5X6OYiuGH18XcCy/u7oyEofnX8n9RGJFDG lpiDtu512Wer6PFMfWUZLhHbvR9LCRgswGVlrUtwzkhtS27Ss7i0nBsfFEwMqfxT+hG0 8nNQ== X-Gm-Message-State: AOAM533iUtdjeRUF0X1QNnovR0kUo5faiz2QMzydFLTH1DTXqAHh/Lif qPwa3cXraCyuOAfNVzpDqZUi1w== X-Received: by 2002:a5d:69c8:: with SMTP id s8mr7001947wrw.405.1595573128712; Thu, 23 Jul 2020 23:45:28 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id 1sm5940977wmf.21.2020.07.23.23.45.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 23 Jul 2020 23:45:23 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 79DD81FF9D; Fri, 24 Jul 2020 07:45:10 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v3 14/16] python/qemu: Cleanup changes to ConsoleSocket Date: Fri, 24 Jul 2020 07:45:07 +0100 Message-Id: <20200724064509.331-15-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200724064509.331-1-alex.bennee@linaro.org> References: <20200724064509.331-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42d; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x42d.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: fam@euphon.net, berrange@redhat.com, Robert Foley , =?utf-8?q?Alex_Benn=C3=A9e?= , richard.henderson@linaro.org, f4bug@amsat.org, cota@braap.org, Cleber Rosa , aurelien@aurel32.net, Eduardo Habkost Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" From: Robert Foley The changes to console_socket.py and machine.py are to cleanup for pylint and flake8. Signed-off-by: Robert Foley Reviewed-by: Alex Bennée Signed-off-by: Alex Bennée Message-Id: <20200717203041.9867-2-robert.foley@linaro.org> --- python/qemu/console_socket.py | 57 ++++++++++++++++++----------------- python/qemu/machine.py | 7 +++-- python/qemu/pylintrc | 2 +- 3 files changed, 34 insertions(+), 32 deletions(-) -- 2.20.1 Reviewed-by: Philippe Mathieu-Daudé diff --git a/python/qemu/console_socket.py b/python/qemu/console_socket.py index 830cb7c6282..09986bc2152 100644 --- a/python/qemu/console_socket.py +++ b/python/qemu/console_socket.py @@ -1,12 +1,9 @@ -#!/usr/bin/env python3 -# -# This python module implements a ConsoleSocket object which is -# designed always drain the socket itself, and place -# the bytes into a in memory buffer for later processing. -# -# Optionally a file path can be passed in and we will also -# dump the characters to this file for debug. -# +""" +QEMU Console Socket Module: + +This python module implements a ConsoleSocket object, +which can drain a socket and optionally dump the bytes to file. +""" # Copyright 2020 Linaro # # Authors: @@ -15,20 +12,27 @@ # This code is licensed under the GPL version 2 or later. See # the COPYING file in the top-level directory. # + import asyncore import socket import threading -import io -import os -import sys from collections import deque import time -import traceback + class ConsoleSocket(asyncore.dispatcher): + """ + ConsoleSocket represents a socket attached to a char device. + Drains the socket and places the bytes into an in memory buffer + for later processing. + + Optionally a file path can be passed in and we will also + dump the characters to this file for debugging purposes. + """ def __init__(self, address, file=None): self._recv_timeout_sec = 300 + self._sleep_time = 0.5 self._buffer = deque() self._asyncore_thread = None self._sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) @@ -70,31 +74,28 @@ class ConsoleSocket(asyncore.dispatcher): def handle_read(self): """process arriving characters into in memory _buffer""" - try: - data = asyncore.dispatcher.recv(self, 1) - # latin1 is needed since there are some chars - # we are receiving that cannot be encoded to utf-8 - # such as 0xe2, 0x80, 0xA6. - string = data.decode("latin1") - except: - print("Exception seen.") - traceback.print_exc() - return + data = asyncore.dispatcher.recv(self, 1) + # latin1 is needed since there are some chars + # we are receiving that cannot be encoded to utf-8 + # such as 0xe2, 0x80, 0xA6. + string = data.decode("latin1") if self._logfile: self._logfile.write("{}".format(string)) self._logfile.flush() for c in string: self._buffer.extend(c) - def recv(self, n=1, sleep_delay_s=0.1): - """Return chars from in memory buffer""" + def recv(self, buffer_size=1): + """Return chars from in memory buffer. + Maintains the same API as socket.socket.recv. + """ start_time = time.time() - while len(self._buffer) < n: - time.sleep(sleep_delay_s) + while len(self._buffer) < buffer_size: + time.sleep(self._sleep_time) elapsed_sec = time.time() - start_time if elapsed_sec > self._recv_timeout_sec: raise socket.timeout - chars = ''.join([self._buffer.popleft() for i in range(n)]) + chars = ''.join([self._buffer.popleft() for i in range(buffer_size)]) # We choose to use latin1 to remain consistent with # handle_read() and give back the same data as the user would # receive if they were reading directly from the diff --git a/python/qemu/machine.py b/python/qemu/machine.py index 80c4d4a8b6e..9956360a792 100644 --- a/python/qemu/machine.py +++ b/python/qemu/machine.py @@ -27,7 +27,7 @@ import socket import tempfile from typing import Optional, Type from types import TracebackType -from qemu.console_socket import ConsoleSocket +from . import console_socket from . import qmp @@ -674,8 +674,9 @@ class QEMUMachine: """ if self._console_socket is None: if self._drain_console: - self._console_socket = ConsoleSocket(self._console_address, - file=self._console_log_path) + self._console_socket = console_socket.ConsoleSocket( + self._console_address, + file=self._console_log_path) else: self._console_socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) diff --git a/python/qemu/pylintrc b/python/qemu/pylintrc index 5d6ae7367d8..3f69205000d 100644 --- a/python/qemu/pylintrc +++ b/python/qemu/pylintrc @@ -33,7 +33,7 @@ good-names=i, Run, _, fd, - + c, [VARIABLES] [STRING]