Class ScapyTrafficGenerator

dpdk/dts/framework/testbed_model/scapy.py:165–281

Provides access to scapy functions via an RPC interface. The traffic generator first starts an XML-RPC on the remote TG node. Then it populates the server with functions which use the Scapy library to send/receive traffic. Any packets sent to the remote server are first converted t

class ScapyTrafficGenerator(CapturingTrafficGenerator):
    """Provides access to scapy functions via an RPC interface.

    The traffic generator first starts an XML-RPC on the remote TG node.
    Then it populates the server with functions which use the Scapy library
    to send/receive traffic.

    Any packets sent to the remote server are first converted to bytes.
    They are received as xmlrpc.client.Binary objects on the server side.
    When the server sends the packets back, they are also received as
    xmlrpc.client.Binary object on the client side, are converted back to Scapy
    packets and only then returned from the methods.

    Arguments:
        tg_node: The node where the traffic generator resides.
        config: The user configuration of the traffic generator.

    Attributes:
        session: The exclusive interactive remote session created by the Scapy
            traffic generator where the XML-RPC server runs.
        rpc_server_proxy: The object used by clients to execute functions
            on the XML-RPC server.
    """

    session: PythonShell
    rpc_server_proxy: xmlrpc.client.ServerProxy
    _config: ScapyTrafficGeneratorConfig
    _tg_node: TGNode
    _logger: DTSLOG

    def __init__(self, tg_node: TGNode, config: ScapyTrafficGeneratorConfig):
        self._config = config
        self._tg_node = tg_node
        self._logger = getLogger(f"{self._tg_node.name} {self._config.traffic_generator_type}")

        assert (
            self._tg_node.config.os == OS.linux
        ), "Linux is the only supported OS for scapy traffic generation"

        self.session = self._tg_node.create_interactive_shell(
            PythonShell, timeout=5, privileged=True
        )

        # import libs in remote python console
        for import_statement in SCAPY_RPC_SERVER_IMPORTS:
            self.session.send_command(import_statement)

        # start the server
        xmlrpc_server_listen_port = 8000
        self._start_xmlrpc_server_in_remote_python(xmlrpc_server_listen_port)

        # connect to the server
        server_url = f"http://{self._tg_node.config.hostname}:{xmlrpc_server_listen_port}"
        self.rpc_server_proxy = xmlrpc.client.ServerProxy(
            server_url, allow_none=True, verbose=SETTINGS.verbose
        )

        # add functions to the server