Functions
def	udp_rx_loop (clientSock, serverSock, size, ip_da, udp_dp, count, verbose=False)

Variables
	parser = argparse.ArgumentParser(description='A script to receive UDP data from an FPGA module.')

	type

	str

	default

	help

	int

	action

	args = parser.parse_args()

	ipFpga = getFpgaIpv4(args)

	instId = getInstanceId(args)

	ipResMngr = getResourceManagerIpv4(args)

	portFpgaServer = XMIT_MODE_LSN_PORT

	portResMngr = getResourceManagerPort(args)

tuple	fpgaServerAssociation = (str(ipFpga), portFpgaServer)

int	dpHost = 2718

tuple	fpgaClientAssociation = (str(ipFpga), dpHost)

	udpClientSock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

	udpServerSock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

	hostname = socket.gethostname()

	ipHostStr = socket.gethostbyname(hostname)

	ip4Str = ni.ifaddresses(itf)[AF_INET][0]['addr']

	ipHost = int(ipaddress.IPv4Address(ipHostStr))

	seed = args.seed

	size = args.size

	count = args.loop_count

Function Documentation

◆ udp_rx_loop()

def tc_UdpRecv.udp_rx_loop	(	clientSock,
		serverSock,
		size,
		ip_da,
		udp_dp,
		count,
		verbose = `False`
	)

UDP Rx Single-Thread Ramp.
Requests the FPGA to open a new active port and expects to receive 'count' datagrams
  of 'size' bytes. Each datagram is made of the following repetitive pattern
  '48692066726f6d200x464d4b553630210a' which decodes into the string "Hi from FMKU60\n".
:param clientSock The socket to send to.
:param serverSock The socket to receive from.
:param size       The size of the expected segment.
:param ip_da      The destination address of the host.
:param udp_dp     The active destination port number that the FPGA is requested to open.
:param count      The number of datagrams to receive.
:param verbose    Enables verbosity.
:return           None

Definition at line 43 of file tc_UdpRecv.py.

 def udp_rx_loop(clientSock, serverSock, size, ip_da, udp_dp, count, verbose=False):
     """UDP Rx Single-Thread Ramp.
     Requests the FPGA to open a new active port and expects to receive 'count' datagrams
       of 'size' bytes. Each datagram is made of the following repetitive pattern
       '48692066726f6d200x464d4b553630210a' which decodes into the string "Hi from FMKU60\n".
     :param clientSock The socket to send to.
     :param serverSock The socket to receive from.
     :param size       The size of the expected segment.
     :param ip_da      The destination address of the host.
     :param udp_dp     The active destination port number that the FPGA is requested to open.
     :param count      The number of datagrams to receive.
     :param verbose    Enables verbosity.
     :return           None"""
     if verbose:
         print("[INFO] Requesting the FPGA to send %d datagrams of %d bytes.\n" % (count, size))
     nrErr = 0
     loop = 0
     totalReceivedBytes = 0
  
     #  Set the server socket non-blocking
     # --------------------------------------
     serverSock.setblocking(False)
     serverSock.settimeout(5)
  
     # Request the test to generate a datagram of length='size' and to send it to
     # socket={ip_da, tcp_dp}. This is done by sending 'ip_da', 'tcp_dp' and 'size'
     # to the FPGA UDP_DP=8801 while turning the 'ip_da' into an unsigned int binary
     # and 'tcp_dp' and 'size' into an unsigned short binary data.
     reqMsgAsBytes = struct.pack(">IHH", ip_da, udp_dp, size)
     if verbose:
         print("\n\n[DEBUG] reqMsgAsBytes = %s" % reqMsgAsBytes)
  
     startTime = datetime.datetime.now()
     while loop < count:
             # SEND message length request to FPGA
             # ------------------------------------
             try:
                 clientSock.sendall(reqMsgAsBytes)
             except socket.error as exc:
                 # Any exception
                 print("[EXCEPTION] Socket error while transmitting :: %s" % exc)
                 exit(1)
             finally:
                 pass
  
             # RECEIVE message length bytes from FPGA
             # ---------------------------------------
             currRxByteCnt = 0
             while currRxByteCnt < size:
                 try:
                     data = serverSock.recv(MTU)
                 except IOError as e:
                     # On non blocking connections - when there are no incoming data, error is going to be raised
                     # Some operating systems will indicate that using AGAIN, and some using WOULDBLOCK error code
                     # We are going to check for both - if one of them - that's expected, means no incoming data,
                     # continue as normal. If we got different error code - something happened
                     if e.errno != errno.EAGAIN and e.errno != errno.EWOULDBLOCK:
                         print("[ERROR] Socket reading error: {}".format(str(e)))
                     # We just did not receive anything
                     print("\t[INFO] So far we received %d bytes out of %d." % (currRxByteCnt, size))
                     count = loop
                     break
                 except socket.error as exc:
                     # Any other exception
                     print("[EXCEPTION] Socket error while receiving :: %s" % exc)
                     exit(1)
                 else:
                     currRxByteCnt += len(data)
                     if verbose:
                         print("[INFO] Loop=%d | RxBytes=%d | RxData=%s\n" % (loop, len(data), data))
                         # [FIXME-TODO: assess the stream of received bytes]
                 finally:
                     pass
             totalReceivedBytes += currRxByteCnt;
             loop += 1
     endTime = datetime.datetime.now()
     elapseTime = endTime - startTime
  
     if totalReceivedBytes < 1000000:
         print("[INFO] Received a total of %d bytes." % totalReceivedBytes)
     elif totalReceivedBytes < 1000000000:
         megaBytes = (totalReceivedBytes * 1.0) / (1024 * 1024 * 1.0)
         print("[INFO] Received a total of %.1f MB." % megaBytes)
     else:
         gigaBytes = (totalReceivedBytes * 1.0) / (1024 * 1024 * 1024 * 1.0)
         print("[INFO] Transferred a total of %.1f GB." % gigaBytes)
  
     bandwidth = (totalReceivedBytes * 8 * 1.0) / (elapseTime.total_seconds() * 1024 * 1024)
     print("#####################################################")
     if bandwidth < 1000:
         print("#### UDP Rx DONE with bandwidth = %6.1f Mb/s " % bandwidth)
     else:
         bandwidth = bandwidth / 1000
         print("#### UDP Rx DONE with bandwidth = %2.1f Gb/s " % bandwidth)
     if (totalReceivedBytes != (size * count)):
         print("####  [WARNING] UDP data loss = %.1f%%" % (1-(totalReceivedBytes)/(size*count)))
     print("#####################################################")
     print()
  
  

Variable Documentation

◆ action

tc_UdpRecv.action

Definition at line 170 of file tc_UdpRecv.py.

◆ args

tc_UdpRecv.args = parser.parse_args()

Definition at line 173 of file tc_UdpRecv.py.

◆ count

tc_UdpRecv.count = args.loop_count

Definition at line 311 of file tc_UdpRecv.py.

◆ default

tc_UdpRecv.default

Definition at line 152 of file tc_UdpRecv.py.

◆ dpHost

int tc_UdpRecv.dpHost = 2718

Definition at line 213 of file tc_UdpRecv.py.

◆ fpgaClientAssociation

tuple tc_UdpRecv.fpgaClientAssociation = (str(ipFpga), dpHost)

Definition at line 214 of file tc_UdpRecv.py.

◆ fpgaServerAssociation

tuple tc_UdpRecv.fpgaServerAssociation = (str(ipFpga), portFpgaServer)

Definition at line 209 of file tc_UdpRecv.py.

◆ help

tc_UdpRecv.help

Definition at line 153 of file tc_UdpRecv.py.

◆ hostname

tc_UdpRecv.hostname = socket.gethostname()

Definition at line 249 of file tc_UdpRecv.py.

◆ instId

tc_UdpRecv.instId = getInstanceId(args)

Definition at line 185 of file tc_UdpRecv.py.

◆ int

tc_UdpRecv.int

Definition at line 154 of file tc_UdpRecv.py.

◆ ip4Str

tc_UdpRecv.ip4Str = ni.ifaddresses(itf)[AF_INET][0]['addr']

Definition at line 256 of file tc_UdpRecv.py.

◆ ipFpga

tc_UdpRecv.ipFpga = getFpgaIpv4(args)

Definition at line 181 of file tc_UdpRecv.py.

◆ ipHost

tc_UdpRecv.ipHost = int(ipaddress.IPv4Address(ipHostStr))

Definition at line 265 of file tc_UdpRecv.py.

◆ ipHostStr

string tc_UdpRecv.ipHostStr = socket.gethostbyname(hostname)

Definition at line 250 of file tc_UdpRecv.py.

◆ ipResMngr

tc_UdpRecv.ipResMngr = getResourceManagerIpv4(args)

Definition at line 189 of file tc_UdpRecv.py.

◆ parser

tc_UdpRecv.parser = argparse.ArgumentParser(description='A script to receive UDP data from an FPGA module.')

MAIN # #

Definition at line 151 of file tc_UdpRecv.py.

◆ portFpgaServer

tc_UdpRecv.portFpgaServer = XMIT_MODE_LSN_PORT

Definition at line 193 of file tc_UdpRecv.py.

◆ portResMngr

tc_UdpRecv.portResMngr = getResourceManagerPort(args)

Definition at line 197 of file tc_UdpRecv.py.

◆ seed

tc_UdpRecv.seed = args.seed

Definition at line 296 of file tc_UdpRecv.py.

◆ size

tc_UdpRecv.size = args.size

Definition at line 302 of file tc_UdpRecv.py.

◆ str

tc_UdpRecv.str

Definition at line 152 of file tc_UdpRecv.py.

◆ type

tc_UdpRecv.type

Definition at line 152 of file tc_UdpRecv.py.

◆ udpClientSock

tc_UdpRecv.udpClientSock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

Definition at line 219 of file tc_UdpRecv.py.

◆ udpServerSock

tc_UdpRecv.udpServerSock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

Definition at line 228 of file tc_UdpRecv.py.

Functions

Variables

Function Documentation

◆ udp_rx_loop()

Variable Documentation

◆ action

◆ args

◆ count

◆ default

◆ dpHost

◆ fpgaClientAssociation

◆ fpgaServerAssociation

◆ help

◆ hostname

◆ instId

◆ int

◆ ip4Str

◆ ipFpga

◆ ipHost

◆ ipHostStr

◆ ipResMngr

◆ parser

◆ portFpgaServer

◆ portResMngr

◆ seed

◆ size

◆ str

◆ type

◆ udpClientSock

◆ udpServerSock