uhd/mpm/python/usrp_mpm/simulator/chdr_endpoint.py

#
# Copyright 2020 Ettus Research, a National Instruments Brand
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
"""This module houses the ChdrEndpoint class, which handles networking,
packet dispatch, and acts as an interface between these and the RFNoC
Graph.
"""

from threading import Thread
import socket
import queue
import select
from uhd.chdr import ChdrPacket, ChdrWidth
from .rfnoc_graph import XbarNode, XportNode, StreamEndpointNode, RFNoCGraph, NodeType
from .chdr_stream import ChdrOutputStream, ChdrInputStream

CHDR_W = ChdrWidth.W64

class SelectableQueue:
    """ A simple python Queue implementation which can be selected.
    This allows waiting on a queue and a socket simultaneously.
    """
    def __init__(self, max_size=0):
        self._queue = queue.Queue(max_size)
        self._send_signal_rx, self._send_signal_tx = socket.socketpair()

    def put(self, item, block=True, timeout=None):
        """ Put an element into the queue, optionally blocking """
        self._queue.put(item, block, timeout)
        self._send_signal_tx.send(b"\x00")

    def fileno(self):
        """ A fileno compatible with select.select """
        return self._send_signal_rx.fileno()

    def get(self):
        """ Return the first element in the queue, blocking if none
        are available.
        """
        self._send_signal_rx.recv(1)
        return self._queue.get_nowait()

class SendWrapper:
    """This class is used as an abstraction over queueing packets to be
    sent by the socket thread.
    """
    def __init__(self, queue):
        self.queue = queue

    def send_packet(self, packet, addr):
        """Serialize packet and then queue the data to be sent to addr
        returns the length of the serialized packet
        """
        data = packet.serialize()
        self.send_data(bytes(data), addr)
        return len(data)

    def send_data(self, data, addr):
        """Queue data to be sent to addr"""
        self.queue.put((data, addr))


class ChdrEndpoint:
    """This class is created by the sim periph_manager
    It is responsible for opening sockets, dispatching all chdr packet
    traffic to the appropriate destination, and responding to said
    traffic.

    The config parameter is a Config object (see simulator/config.py)
    """
    def __init__(self, log, config):
        self.log = log.getChild("ChdrEndpoint")
        self.config = config
        self.source_gen = config.source_gen
        self.sink_gen = config.sink_gen
        self.xport_map = {}

        self.send_queue = SelectableQueue()
        self.send_wrapper = SendWrapper(self.send_queue)

        self.graph = RFNoCGraph(self.get_default_nodes(), self.log, 0, self.send_wrapper,
                                CHDR_W, config.hardware.rfnoc_device_type)
        self.thread = Thread(target=self.socket_worker, daemon=True)
        self.thread.start()

    def set_device_id(self, device_id):
        """Set the device_id for this endpoint"""
        self.graph.set_device_id(device_id)

    def set_sample_rate(self, rate):
        """Set the sample_rate of the next tx_stream.

        This method is called by the daughterboard. It coresponds to
        sim_dboard.py:sim_db#set_catalina_clock_rate()
        """
        self.graph.get_stream_spec().sample_rate = rate

    def get_default_nodes(self):
        """Get a sensible NoC Core setup. This is the simplest
        functional layout. It has one of each required component.
        """
        nodes = [
            XportNode(0),
            XbarNode(0, [2], [0]),
            StreamEndpointNode(0, self.source_gen, self.sink_gen)
        ]
        return nodes

    def send_strc(self, stream_ep, addr):
        pass # TODO: currently not implemented

    def begin_tx(self, src_epid, stream_spec):
        pass # TODO: currently not implemented

    def end_tx(self, src_epid):
        pass # TODO: currently not implemented

    def begin_rx(self, dst_epid):
        pass # TODO: currently not implemented

    def socket_worker(self):
        """This is the method that runs in a background thread. It
        blocks on the CHDR socket and processes packets as they come
        in.
        """
        self.log.info("Starting ChdrEndpoint Thread")
        main_sock = socket.socket(socket.AF_INET,
                                  socket.SOCK_DGRAM)
        main_sock.bind(("0.0.0.0", 49153))

        while True:
            # This allows us to block on multiple sockets at the same time
            ready_list, _, _ = select.select([main_sock, self.send_queue], [], [])
            buffer = bytearray(8000) # Max MTU
            for sock in ready_list:
                if sock is main_sock:
                    # Received Data over socket
                    n_bytes, sender = main_sock.recvfrom_into(buffer)
                    self.log.trace("Received {} bytes of data from {}"
                                   .format(n_bytes, sender))
                    try:
                        packet = ChdrPacket.deserialize(CHDR_W, buffer[:n_bytes])
                        self.log.trace("Decoded Packet: {}"
                                       .format(packet.to_string_with_payload()))
                        entry_xport = (NodeType.XPORT, 0)
                        response = self.graph.handle_packet(packet, entry_xport, sender,
                                                            sender, n_bytes)

                        if response is not None:
                            data = response.serialize()
                            self.log.trace("Returning Packet: {}"
                                           .format(packet.to_string_with_payload()))
                            main_sock.sendto(bytes(data), sender)
                    except BaseException as ex:
                        self.log.warning("Unable to decode packet: {}"
                                         .format(ex))
                        raise ex
                else:
                    data, addr = self.send_queue.get()
                    sent_len = main_sock.sendto(data, addr)
                    assert len(data) == sent_len, "Didn't send whole packet."