From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 495B3456A2; Wed, 24 Jul 2024 20:39:44 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B331A42E76; Wed, 24 Jul 2024 20:39:39 +0200 (CEST) Received: from mail-qv1-f100.google.com (mail-qv1-f100.google.com [209.85.219.100]) by mails.dpdk.org (Postfix) with ESMTP id DA2B040B97 for ; Wed, 24 Jul 2024 20:39:37 +0200 (CEST) Received: by mail-qv1-f100.google.com with SMTP id 6a1803df08f44-6b7a36f26f3so11311586d6.1 for ; Wed, 24 Jul 2024 11:39:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1721846377; x=1722451177; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=ap735j3cLYE3m1ei6abxO38EK1Sj/3VyuWAOmiZB5+8=; b=GczmPdQHYIS+eQP9bsDLw2Zc6i+z8VLGzuN7hivtEXg2Iwi34OXsLPB2QZ821nX1f9 1MpR+d06NGR71a3ksNJLgZ88svGCIWmAsuxxoN8QL2833LiO89BEWd6i9iEwkNJByGGZ qJIwiqeQ3WYe1Cc7SxminD0N0Uwc+rsaYTJfk= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721846377; x=1722451177; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=ap735j3cLYE3m1ei6abxO38EK1Sj/3VyuWAOmiZB5+8=; b=Cufs1RFUPkoCRgADbVG++YOrhPfTt1e+IpJEPs38+LnuRpjh4MKgLoQVQ46tRT5Ime YP5tqKxREj2D9zaBIPDWjPHM42XsdUSjBmIOhufFKhobLobhaZVq6iuElLOoLDgYPz/S QsY1BzvJn9bpmVgcIC1+P5O6qE+nIas9ssWL+XNAOiehhJHUuPFLLifbxvuVywK7kQUr gf8cueZmfSlVyp6NTDoJViA6l5uQFozY58D0nYFw5xjXMR45AKKH5A9AZUVZttFXCsny EBv1upq7/B8fagHWJb8Y3IsZ949x44BSQZLdOEsXOmhvFYrcGlRfhfbVXU/gyVrb37bd /7xg== X-Gm-Message-State: AOJu0YxFQojQGqOyDE73jUtP4wFWoLO1S9BIGl+6YqV26nVIIsg1csl7 gMOT41IcptMgyG2+HtpuywHPoM/oWh6rskqnGsGvhYqkWR/pmDhcIHAwXugouVCEkZx3Ecl4mik 0iCGba2yF1DowPpOWqascoTFH8YE/NjCb X-Google-Smtp-Source: AGHT+IGoXAuU/spIZg13V2qr5h9IxWF4jkDCupa/CKrH2HYaZ2UGtI3eC9/Urcf+FD0XUDzTvbSb99nUYybf X-Received: by 2002:a0c:fa52:0:b0:6b5:2aa3:3a7f with SMTP id 6a1803df08f44-6b99154d6c9mr44211076d6.20.1721846377160; Wed, 24 Jul 2024 11:39:37 -0700 (PDT) Received: from postal.iol.unh.edu (postal.iol.unh.edu. [132.177.123.84]) by smtp-relay.gmail.com with ESMTPS id 6a1803df08f44-6b96ce6ffd8sm4742646d6.24.2024.07.24.11.39.37 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 24 Jul 2024 11:39:37 -0700 (PDT) X-Relaying-Domain: iol.unh.edu Received: from iol.unh.edu (unknown [IPv6:2606:4100:3880:1257::1083]) by postal.iol.unh.edu (Postfix) with ESMTP id 520B2605C351; Wed, 24 Jul 2024 14:39:36 -0400 (EDT) From: jspewock@iol.unh.edu To: juraj.linkes@pantheon.tech, probb@iol.unh.edu, yoan.picchi@foss.arm.com, wathsala.vithanage@arm.com, Honnappa.Nagarahalli@arm.com, npratte@iol.unh.edu, paul.szczepanek@arm.com, thomas@monjalon.net, Luca.Vizzarro@arm.com Cc: dev@dpdk.org, Jeremy Spewock , Luca Vizzarro Subject: [PATCH v6 2/3] dts: Add missing docstring from XML-RPC server Date: Wed, 24 Jul 2024 14:39:13 -0400 Message-ID: <20240724183914.436188-3-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240724183914.436188-1-jspewock@iol.unh.edu> References: <20240501161623.26672-1-jspewock@iol.unh.edu> <20240724183914.436188-1-jspewock@iol.unh.edu> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Jeremy Spewock When this XML-RPC server implementation was added, the docstring had to be shortened in order to reduce the chances of this race condition being encountered. Now that this race condition issue is resolved, the full docstring can be restored. Signed-off-by: Jeremy Spewock Reviewed-by: Juraj Linkeš Reviewed-by: Luca Vizzarro Reviewed-by: Nicholas Pratte --- .../testbed_model/traffic_generator/scapy.py | 46 ++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py index 7f0cc2bc18..08e1f4ae7e 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/framework/testbed_model/traffic_generator/scapy.py @@ -128,9 +128,53 @@ def scapy_send_packets(xmlrpc_packets: list[xmlrpc.client.Binary], send_iface: s class QuittableXMLRPCServer(SimpleXMLRPCServer): - """Basic XML-RPC server. + r"""Basic XML-RPC server. The server may be augmented by functions serializable by the :mod:`marshal` module. + + Example: + :: + + def hello_world(): + # to be sent to the XML-RPC server + print("Hello World!") + + # start the XML-RPC server on the remote node + # this is done by starting a Python shell on the remote node + from framework.remote_session import PythonShell + # the example assumes you're already connected to a tg_node + session = tg_node.create_interactive_shell(PythonShell, timeout=5, privileged=True) + + # then importing the modules needed to run the server + # and the modules for any functions later added to the server + session.send_command("import xmlrpc") + session.send_command("from xmlrpc.server import SimpleXMLRPCServer") + + # sending the source code of this class to the Python shell + from xmlrpc.server import SimpleXMLRPCServer + src = inspect.getsource(QuittableXMLRPCServer) + src = "\n".join([l for l in src.splitlines() if not l.isspace() and l != ""]) + spacing = "\n" * 4 + session.send_command(spacing + src + spacing) + + # then starting the server with: + command = "s = QuittableXMLRPCServer(('0.0.0.0', {listen_port}));s.serve_forever()" + session.send_command(command, "XMLRPC OK") + + # now the server is running on the remote node and we can add functions to it + # first connect to the server from the execution node + import xmlrpc.client + server_url = f"http://{tg_node.config.hostname}:8000" + rpc_server_proxy = xmlrpc.client.ServerProxy(server_url) + + # get the function bytes to send + import marshal + function_bytes = marshal.dumps(hello_world.__code__) + rpc_server_proxy.add_rpc_function(hello_world.__name__, function_bytes) + + # now we can execute the function on the server + xmlrpc_binary_recv: xmlrpc.client.Binary = rpc_server_proxy.hello_world() + print(str(xmlrpc_binary_recv)) """ def __init__(self, *args, **kwargs): -- 2.45.2