From patchwork Wed Jul 15 20:48:14 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Robert Foley X-Patchwork-Id: 235621 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp209107ilg; Wed, 15 Jul 2020 13:53:34 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyJWsVIixX9FexvD9yZLyHzIV9VeWWc7+drNNykpt4MtXTZbvlQNyFaQpEy08c9jb/+hAhR X-Received: by 2002:a25:d046:: with SMTP id h67mr1326463ybg.458.1594846414900; Wed, 15 Jul 2020 13:53:34 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594846414; cv=none; d=google.com; s=arc-20160816; b=JiI8bi3TibvVOBG1gNEf+fGah8fY17Oie446moqYW9LH2qII6Otjn8RumDztzP1EvW r9Sj/yNub+epzTFap6M1fvpKiRbNvYcIQeH/8yw+BE7mtPMQAh+b99OnZzG3ZLwySE5L VmfOufyFDjtEg2Se3E6Vbn2YnetEBXv92E3SEexX6xZ/pHoRe0LeFjT2y7uW5idpD9cA 6JQhpRxzh0K8a6gME3kMa90UkHkFJrcs/EpkYHeI3n1pPUFXviXUFS8WVAuhuVsHoXcU cddPQGHARAxqaLA+gmY5YcNKmJfQMub7CdAFHPfqyZjs479blHVbLjtBKKK7nkKhmwl2 sSfw== 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:references:in-reply-to :message-id:date:subject:to:from:dkim-signature; bh=0tmOibHW1cTYy3j90QIcmaNdGmLO5nvsVb0UqPEV400=; b=sAQWoORXBaiBflLAvxeQimBAjQzAovX9RqB2W4BRxE+Z48K9qP80AsqyiqNhuwEQgZ YnaJ3+ducNbiXm+186H43BPaOUsD7fW++kgy3o/nPAsMmEGeh/H3XEGbN2QrR+XfAZqa +Xmo8Tv0NI60W5zQOrRz82pLeaAj729zCpgtzw/IRwmSQCLEWRzgntYhgcmg5dJcV0ry vI2pWVbqJXFCfgL1XDW6ICLaBlp+rn5zOpMp9SFE2AIsNp8CcguWwVUUZTcw2SWMdCWc lBizRY36ATt5YShijkxZ22Ra0qaeoZkfgOmUz70ncaQM/HaX64cm5jL5vLpYIc4BWX1F sRuw== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=TPkxPsWf; 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 i10si3931402ybh.214.2020.07.15.13.53.34 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 15 Jul 2020 13:53:34 -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=TPkxPsWf; 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]:39300 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jvoPG-0008SV-D6 for patch@linaro.org; Wed, 15 Jul 2020 16:53:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50214) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jvoNW-0006oQ-2h for qemu-devel@nongnu.org; Wed, 15 Jul 2020 16:51:46 -0400 Received: from mail-pg1-x52d.google.com ([2607:f8b0:4864:20::52d]:36992) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jvoNU-0007cT-6i for qemu-devel@nongnu.org; Wed, 15 Jul 2020 16:51:45 -0400 Received: by mail-pg1-x52d.google.com with SMTP id d4so3683610pgk.4 for ; Wed, 15 Jul 2020 13:51:43 -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; bh=0tmOibHW1cTYy3j90QIcmaNdGmLO5nvsVb0UqPEV400=; b=TPkxPsWfvZGgwJ7KzATi/OOZAYbHU/FSkWY053Bq62aGqU8S4a/YqzO+pQKXceYMyw /rcIG1Oav3dL2JR+MTH+f0D7fM9m5N8VeWd51T5E92kW939fBjzlcQTKU1arcld4kVS2 VXYfid0Yg5tXrIXNFcEam9COLeFPOY84EUA0/V0rkawoei39Zqo7SOKKt7IX2epH1I1I kJKTKOElvEnCLvPIGxPOK/Yp91xKBuiXpLxkbtF23vMrERrVfjraJkfLhiyXJhYhMb57 JpbgmJpodxqZh/dzAtxnp9N2F1Ko82s6zIOx3OAHSaf0R0q25ux5B4GtAo3ihYdNNMxL Ap0A== 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; bh=0tmOibHW1cTYy3j90QIcmaNdGmLO5nvsVb0UqPEV400=; b=gGgUmqPQ+UwcxEMWzzVQ+eqKi/spqfoyMxAQWEveo6vpe5HKC1VOe/QYvVqT0i1aTZ veGSWhe23XkKzREnsS/Ira43uqS9Vnmg3VtbtWI/2YCm4Ueo9yvMaZP8B+WWeGEsjqQL b2XxYPLDL0FBgMQ6r3i1CYKJr8xxPqGZ2i9y0h1DnbOUB0Ue0S7m5g9aS/Vw6jtTywwf QbhV+H43tIRZ8Sh+vLTtQc65PjkvDC92el0ZA84SEUM7LqDtZVZFZXyVhULU6m4/D5gH AuwnH8KsR3K0vfLeuGZdWGMV/q8ZS4w60DwlP5EJ+X3EPgfe4jrtgyU6rMODD1KTo2/q mFcg== X-Gm-Message-State: AOAM531GAxKeWvFjJeUWS7rjir2UO8VKOykJOshFbm2QtuPWyBBU6lLa 9cmtHR7Ue/xYERvfk0J8VcrWR42HA1yMgQ== X-Received: by 2002:a63:e556:: with SMTP id z22mr1359680pgj.130.1594846302164; Wed, 15 Jul 2020 13:51:42 -0700 (PDT) Received: from Rfoley-MA01.hsd1.ma.comcast.net (c-73-47-162-176.hsd1.ma.comcast.net. [73.47.162.176]) by smtp.gmail.com with ESMTPSA id 66sm2687690pfg.63.2020.07.15.13.51.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Jul 2020 13:51:41 -0700 (PDT) From: Robert Foley To: qemu-devel@nongnu.org Subject: [PATCH 2/2] python/qemu: Change ConsoleSocket to optionally drain socket. Date: Wed, 15 Jul 2020 16:48:14 -0400 Message-Id: <20200715204814.2630-3-robert.foley@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200715204814.2630-1-robert.foley@linaro.org> References: <20200715204814.2630-1-robert.foley@linaro.org> Received-SPF: pass client-ip=2607:f8b0:4864:20::52d; envelope-from=robert.foley@linaro.org; helo=mail-pg1-x52d.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: robert.foley@linaro.org, jsnow@redhat.com, Cleber Rosa , peter.puhov@linaro.org, alex.bennee@linaro.org, Eduardo Habkost Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" The primary purpose of this change is to clean up machine.py's console_socket property to return a single type, a ConsoleSocket. ConsoleSocket now derives from a socket, which means that in the default case (of not draining), machine.py will see the same behavior as it did prior to ConsoleSocket. Signed-off-by: Robert Foley --- python/qemu/console_socket.py | 81 +++++++++++++++++++++-------------- python/qemu/machine.py | 13 ++---- 2 files changed, 54 insertions(+), 40 deletions(-) -- 2.17.1 diff --git a/python/qemu/console_socket.py b/python/qemu/console_socket.py index 6a746c1dbf..475de5b101 100644 --- a/python/qemu/console_socket.py +++ b/python/qemu/console_socket.py @@ -13,68 +13,76 @@ which can drain a socket and optionally dump the bytes to file. # the COPYING file in the top-level directory. # -import asyncore import socket import threading from collections import deque import time -class ConsoleSocket(asyncore.dispatcher): +class ConsoleSocket(socket.socket): """ 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 (if drain==True), 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): + def __init__(self, address, file=None, drain=False): 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) - self._sock.connect(address) + self._drain_thread = None + socket.socket.__init__(self, socket.AF_UNIX, socket.SOCK_STREAM) + self.connect(address) + self._drain = drain self._logfile = None if file: self._logfile = open(file, "w") - asyncore.dispatcher.__init__(self, sock=self._sock) self._open = True - self._thread_start() + if drain: + self._thread_start() + + def _drain_fn(self): + """Drains the socket and runs while the socket is open.""" + while self._open: + try: + self._drain_socket() + except socket.timeout: + # The socket is expected to timeout since we set a + # short timeout to allow the thread to exit when + # self._open is set to False. + time.sleep(self._sleep_time) def _thread_start(self): - """Kick off a thread to wait on the asyncore.loop""" - if self._asyncore_thread is not None: + """Kick off a thread to drain the socket.""" + if self._drain_thread is not None: return - self._asyncore_thread = threading.Thread(target=asyncore.loop, - kwargs={'timeout':1}) - self._asyncore_thread.daemon = True - self._asyncore_thread.start() - - def handle_close(self): - """redirect close to base class""" - # Call the base class close, but not self.close() since - # handle_close() occurs in the context of the thread which - # self.close() attempts to join. - asyncore.dispatcher.close(self) + # Configure socket to not block and timeout. + # This allows our drain thread to not block + # on recieve and exit smoothly. + socket.socket.setblocking(self, 0) + socket.socket.settimeout(self, 1) + self._drain_thread = threading.Thread(target=self._drain_fn) + self._drain_thread.daemon = True + self._drain_thread.start() def close(self): """Close the base object and wait for the thread to terminate""" if self._open: self._open = False - asyncore.dispatcher.close(self) - if self._asyncore_thread is not None: - thread, self._asyncore_thread = self._asyncore_thread, None + if self._drain and self._drain_thread is not None: + thread, self._drain_thread = self._drain_thread, None thread.join() + socket.socket.close(self) if self._logfile: self._logfile.close() self._logfile = None - def handle_read(self): + def _drain_socket(self): """process arriving characters into in memory _buffer""" - data = asyncore.dispatcher.recv(self, 1) + data = socket.socket.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. @@ -89,6 +97,9 @@ class ConsoleSocket(asyncore.dispatcher): """Return chars from in memory buffer. Maintains the same API as socket.socket.recv. """ + if not self._drain: + # Not buffering the socket, pass thru to socket. + return socket.socket.recv(self, buffer_size) start_time = time.time() while len(self._buffer) < buffer_size: time.sleep(self._sleep_time) @@ -102,9 +113,17 @@ class ConsoleSocket(asyncore.dispatcher): # socket w/o our intervention. return chars.encode("latin1") - def set_blocking(self): - """Maintain compatibility with socket API""" + def setblocking(self, value): + """When not draining we pass thru to the socket, + since when draining we control socket blocking. + """ + if not self._drain: + socket.socket.setblocking(self, value) def settimeout(self, seconds): - """Set current timeout on recv""" + """When not draining we pass thru to the socket, + since when draining we control the timeout. + """ self._recv_timeout_sec = seconds + if not self._drain: + socket.socket.settimeout(self, seconds) diff --git a/python/qemu/machine.py b/python/qemu/machine.py index 6769359766..62709d86e4 100644 --- a/python/qemu/machine.py +++ b/python/qemu/machine.py @@ -22,7 +22,6 @@ import logging import os import subprocess import shutil -import socket import tempfile from typing import Optional, Type from types import TracebackType @@ -591,12 +590,8 @@ class QEMUMachine: Returns a socket connected to the console """ if self._console_socket is None: - if self._drain_console: - 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) - self._console_socket.connect(self._console_address) + self._console_socket = console_socket.ConsoleSocket( + self._console_address, + file=self._console_log_path, + drain=self._drain_console) return self._console_socket