From nobody Sun Sep 28 17:05:18 2025 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; dmarc=pass(p=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1758040027; cv=none; d=zohomail.com; s=zohoarc; b=RJfShfe7Zd/RjHy0DPyW4JAZy28ik/cPpdEWsc2xUJYYEAsqLs28sebMm4/qpAIFA35ZkkqUZjSt82/aBZrnIsL4+sORpf7Fwq0FAJry9yFTbNcx06Qqj8BiyFpeH1wGY8+RZiZqPYnLtXc9b+QxiNW2tAwcuDQucSGUNANnDVw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1758040027; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=XOMg8kgYrfmdVNNCbkZMQMfrzHrC31mR6Ng+5Wq9LW4=; b=C6czOuTHeO6xlPnGdXCFGl8r2MJmxzqfkDQh6VIMvJ7KIQO8pac6H9KLtYhQiurH60oUUU25V3a9LLgBfrdt4MKxGxSO5PbAPZ9wEhUYBhQDemITjexQgIIWoon+Q656Y0vUJwI+K1NodODR2UrLs5xCHh4qS0UQqsJy+k+kGsI= 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; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1758040027002429.7404361829289; Tue, 16 Sep 2025 09:27:07 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uyYU3-0003k5-42; Tue, 16 Sep 2025 12:24:47 -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 1uyYU0-0003hf-6x for qemu-devel@nongnu.org; Tue, 16 Sep 2025 12:24:44 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1uyYTy-0002q0-CT for qemu-devel@nongnu.org; Tue, 16 Sep 2025 12:24:43 -0400 Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-616-wxTw5aXYMpax2b-NjS9QSQ-1; Tue, 16 Sep 2025 12:24:38 -0400 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 19A731955F6A; Tue, 16 Sep 2025 16:24:37 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.80.221]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id E560E19560B8; Tue, 16 Sep 2025 16:24:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1758039881; 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=XOMg8kgYrfmdVNNCbkZMQMfrzHrC31mR6Ng+5Wq9LW4=; b=a0Fezc94/zc6Rquq0psl63IdPfiWDlMsDQ9N8rRrxUtoSBG8HmT/2YUEuZ2ny5vzRHQCst ZmM+8IaU/qovDaMW6c47xQYKkuD5bOvimgsuneUJnEihiB6gTCMfQTbGkEdoo4kk5Bo+3+ f84FPXV7g7nbH0r5UVjSsgr2zcwa+Pk= X-MC-Unique: wxTw5aXYMpax2b-NjS9QSQ-1 X-Mimecast-MFC-AGG-ID: wxTw5aXYMpax2b-NjS9QSQ_1758039877 From: John Snow To: qemu-devel@nongnu.org Cc: Kevin Wolf , Michael Roth , John Snow , Hanna Reitz , Peter Maydell , Cleber Rosa , qemu-block@nongnu.org, Markus Armbruster , Adam Dorsey , Adam Dorsey , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Subject: [PULL 08/19] python: backport 'feat: allow setting read buffer limit' Date: Tue, 16 Sep 2025 12:23:53 -0400 Message-ID: <20250916162404.9195-9-jsnow@redhat.com> In-Reply-To: <20250916162404.9195-1-jsnow@redhat.com> References: <20250916162404.9195-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com 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, DKIMWL_WL_HIGH=-0.009, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_PASS=-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 @redhat.com) X-ZM-MESSAGEID: 1758040029320116600 From: Adam Dorsey Expose the limit parameter of the underlying StreamReader and StreamWriter instances. This is helpful for the use case of transferring files in and out of a VM via the QEMU guest agent's guest-file-open, guest-file-read, guest-file-wri= te, and guest-file-close methods, as it allows pushing the buffer size up to the guest agent's limit of 48MB per transfer. Signed-off-by: Adam Dorsey cherry picked from commit python-qemu-qmp@9ba6a698344eb3b570fa4864e906c5404= 2824cd6 cherry picked from commit python-qemu-qmp@e4d0d3f835d82283ee0e48438d1b154e1= 8303491 [Squashed in linter fixups. --js] Signed-off-by: John Snow Reviewed-by: Daniel P. Berrang=C3=A9 --- python/qemu/qmp/protocol.py | 25 ++++++++++++++++--------- python/qemu/qmp/qmp_client.py | 18 ++++++++++++++---- 2 files changed, 30 insertions(+), 13 deletions(-) diff --git a/python/qemu/qmp/protocol.py b/python/qemu/qmp/protocol.py index 958aeca08ac..3d5eb553aad 100644 --- a/python/qemu/qmp/protocol.py +++ b/python/qemu/qmp/protocol.py @@ -53,6 +53,9 @@ UnixAddrT =3D str SocketAddrT =3D Union[UnixAddrT, InternetAddrT] =20 +# Maximum allowable size of read buffer, default +_DEFAULT_READBUFLEN =3D 64 * 1024 + =20 class Runstate(Enum): """Protocol session runstate.""" @@ -202,22 +205,26 @@ class AsyncProtocol(Generic[T]): will log to 'qemu.qmp.protocol', but each individual connection can be given its own logger by giving it a name; messages will then log to 'qemu.qmp.protocol.${name}'. + :param readbuflen: + The maximum read buffer length of the underlying StreamReader + instance. """ # pylint: disable=3Dtoo-many-instance-attributes =20 #: Logger object for debugging messages from this connection. logger =3D logging.getLogger(__name__) =20 - # Maximum allowable size of read buffer - _limit =3D 64 * 1024 - # ------------------------- # Section: Public interface # ------------------------- =20 - def __init__(self, name: Optional[str] =3D None) -> None: + def __init__( + self, name: Optional[str] =3D None, + readbuflen: int =3D _DEFAULT_READBUFLEN + ) -> None: self._name: Optional[str] self.name =3D name + self.readbuflen =3D readbuflen =20 # stream I/O self._reader: Optional[StreamReader] =3D None @@ -574,7 +581,7 @@ async def _do_start_server(self, address: SocketAddrT, port=3Daddress[1], ssl=3Dssl, backlog=3D1, - limit=3Dself._limit, + limit=3Dself.readbuflen, ) else: coro =3D asyncio.start_unix_server( @@ -582,7 +589,7 @@ async def _do_start_server(self, address: SocketAddrT, path=3Daddress, ssl=3Dssl, backlog=3D1, - limit=3Dself._limit, + limit=3Dself.readbuflen, ) =20 # Allow runstate watchers to witness 'CONNECTING' state; some @@ -637,7 +644,7 @@ async def _do_connect(self, address: Union[SocketAddrT,= socket.socket], "fd=3D%d, family=3D%r, type=3D%r", address.fileno(), address.family, address.ty= pe) connect =3D asyncio.open_connection( - limit=3Dself._limit, + limit=3Dself.readbuflen, ssl=3Dssl, sock=3Daddress, ) @@ -647,14 +654,14 @@ async def _do_connect(self, address: Union[SocketAddr= T, socket.socket], address[0], address[1], ssl=3Dssl, - limit=3Dself._limit, + limit=3Dself.readbuflen, ) else: self.logger.debug("Connecting to file://%s ...", address) connect =3D asyncio.open_unix_connection( path=3Daddress, ssl=3Dssl, - limit=3Dself._limit, + limit=3Dself.readbuflen, ) =20 self._reader, self._writer =3D await connect diff --git a/python/qemu/qmp/qmp_client.py b/python/qemu/qmp/qmp_client.py index a87fb565ab5..d826331b6d5 100644 --- a/python/qemu/qmp/qmp_client.py +++ b/python/qemu/qmp/qmp_client.py @@ -170,6 +170,12 @@ class QMPClient(AsyncProtocol[Message], Events): =20 :param name: Optional nickname for the connection, used for logging. =20 + :param readbuflen: + The maximum buffer length for reads and writes to and from the QMP + server, in bytes. Default is 10MB. If `QMPClient` is used to + connect to a guest agent to transfer files via ``guest-file-read``/ + ``guest-file-write``, increasing this value may be required. + Basic script-style usage looks like this:: =20 qmp =3D QMPClient('my_virtual_machine_name') @@ -203,14 +209,18 @@ async def run(self, address=3D'/tmp/qemu.socket'): #: Logger object used for debugging messages. logger =3D logging.getLogger(__name__) =20 - # Read buffer limit; 10MB like libvirt default - _limit =3D 10 * 1024 * 1024 + # Read buffer default limit; 10MB like libvirt default + _readbuflen =3D 10 * 1024 * 1024 =20 # Type alias for pending execute() result items _PendingT =3D Union[Message, ExecInterruptedError] =20 - def __init__(self, name: Optional[str] =3D None) -> None: - super().__init__(name) + def __init__( + self, + name: Optional[str] =3D None, + readbuflen: int =3D _readbuflen + ) -> None: + super().__init__(name, readbuflen) Events.__init__(self) =20 #: Whether or not to await a greeting after establishing a connect= ion. --=20 2.51.0