tc_utils Namespace Reference

Functions
def	num_to_char (num)
def	str_static_gen (size)
def	str_rand_gen (size)
def	getFpgaIpv4 (args)
def	getFpgaPort (args)
def	getResourceManagerIpv4 (args)
def	getResourceManagerPort (args)
def	getInstanceId (args)
def	restartApp (instId, ipResMngr, portResMngr, user_name, user_passwd)
def	pingFpga (ipFpga)
def	display_throughput (byteCount, elapseTime)

Variables
int	ACM_OK = 0
int	ACM_KO = 1
int	MTU = 1500
int	MTU_ZYC2 = 1450
int	IP4_HDR_LEN = 20
int	TCP_HDR_LEN = 20
tuple	ZYC2_MSS = (MTU_ZYC2 - 92) & ~0x7
int	UDP_HDR_LEN = 8
tuple	UDP_MDS = (MTU_ZYC2 - IP4_HDR_LEN - UDP_HDR_LEN) & ~0x7
int	RECV_MODE_LSN_PORT = 8800
int	XMIT_MODE_LSN_PORT = 8801
int	BIDIR_MODE_LSN_PORT = 8802
int	ECHO_MODE_LSN_PORT = 8803
int	IPERF_LSN_PORT = 5001
int	IPREF3_LSN_PORT = 5201

Function Documentation

display_throughput()

def tc_utils.display_throughput	(		byteCount,
			elapseTime
	)

Display the throughput in human readable form.
 :param byteCount:  The number of bytes transferred.
 :param elapseTime: The duration of the transfer.
 :return:           Nothing

Definition at line 211 of file tc_utils.py.

def display_throughput(byteCount, elapseTime):
    """Display the throughput in human readable form.
     :param byteCount:  The number of bytes transferred.
     :param elapseTime: The duration of the transfer.
     :return:           Nothing
     """
    if byteCount < 1000000:
        print("[INFO] Transferred a total of %d bytes." % byteCount)
    elif byteCount < 1000000000:
        megaBytes = (byteCount * 1.0) / (1024 * 1024 * 1.0)
        print("[INFO] Transferred a total of %.1f MB." % megaBytes)
    else:
        gigaBytes = (byteCount * 1.0) / (1024 * 1024 * 1024 * 1.0)
        print("[INFO] Transferred a total of %.1f GB." % gigaBytes)
    throughput = (byteCount * 8 * 1.0) / (elapseTime.total_seconds() * 1024 * 1024)
 
    strMsg = ""
    if throughput < 1000:
        strMsg = "#### DONE with throughput = %.1f Mb/s ####" % throughput
    else:
        throughput = throughput / 1000
        strMsg = "#### DONE with throughput = %.1f Gb/s ####" % throughput
 
    strHashLine = ""
    for i in range(0, len(strMsg)):
        strHashLine += "#"
 
    print(strHashLine)
    print(strMsg)
    print(strHashLine)
    print()
 
 

Here is the caller graph for this function:

getFpgaIpv4()

def tc_utils.getFpgaIpv4

(

args

)

Retrieve the IPv4 address of the FPGA module.
:param args  The options passed as arguments to the script.
:return      The IPv4 address as an 'ipaddress.IPv4Address'.

Definition at line 95 of file tc_utils.py.

def getFpgaIpv4(args):
    """Retrieve the IPv4 address of the FPGA module.
    :param args  The options passed as arguments to the script.
    :return      The IPv4 address as an 'ipaddress.IPv4Address'."""
    ipFpgaStr = args.fpga_ipv4
    while True:
        if args.fpga_ipv4 == '':
            # Take an IP address from the console
            print("Enter the IPv4 address of the FPGA module to connect to (e.g. 10.12.200.21)")
            ipFpgaStr = input()
        try:
            ipFpga = ipaddress.ip_address(ipFpgaStr)
        except ValueError:
            print('[ERROR] Unrecognized IPv4 address.')
        else:
            return ipFpga
 
 

getFpgaPort()

def tc_utils.getFpgaPort

(

args

)

Retrieve the UDP listen port of the FPGA.
:param args The options passed as arguments to the script.
:return     The UDP port number as an integer.

Definition at line 113 of file tc_utils.py.

def getFpgaPort(args):
    """Retrieve the UDP listen port of the FPGA.
    :param args The options passed as arguments to the script.
    :return     The UDP port number as an integer."""
    portFpga = args.fpga_port
    if portFpga != 8803:
        print("[ERROR] The current version of the cFp_BringUp role always listens on port #8803.\n")
        exit(1)
    return portFpga
 
 

getInstanceId()

def tc_utils.getInstanceId

(

args

)

Retrieve the instance Id that was assigned by the cloudFPGA Resource Manager.
:param args The options passed as arguments to the script.
:return     The instance Id as an integer.

Definition at line 153 of file tc_utils.py.

def getInstanceId(args):
    """Retrieve the instance Id that was assigned by the cloudFPGA Resource Manager.
    :param args The options passed as arguments to the script.
    :return     The instance Id as an integer."""
    instId = args.inst_id
    while True:
        if not 1 <= args.inst_id:   # Take an instance Id from the console
            print("Enter the instance Id that was assigned by the cloudFPGA Resource Manager (e.g. 42)")
            instIdStr = input()
            try:
                instId = int(instIdStr)
            except ValueError:
                print("ERROR: Bad format for the instance Id.")
                print("\tEnter a new instance Id > 0.\n")
            else:
                break
        else:
            break;
    return instId
 
 

getResourceManagerIpv4()

def tc_utils.getResourceManagerIpv4

(

args

)

Retrieve the IPv4 address of the cloudFPGA Resource Manager.
:param args The options passed as arguments to the script.
:return     The IP address as an 'ipaddress.IPv4Address'.

Definition at line 124 of file tc_utils.py.

def getResourceManagerIpv4(args):
    """Retrieve the IPv4 address of the cloudFPGA Resource Manager.
    :param args The options passed as arguments to the script.
    :return     The IP address as an 'ipaddress.IPv4Address'."""
    ipResMngrStr = args.mngr_ipv4
    while True:
        if args.mngr_ipv4 == '':
            # Take an IP address from the console
            print("Enter the IPv4 address of the cloudFPGA Resource Manager (e.g. 10.12.0.132)")
            ipResMngrStr = input()
        try:
            ipResMngr = ipaddress.ip_address(ipResMngrStr)
        except ValueError:
            print('[ERROR] Unrecognized IPv4 address.')
        else:
            return ipResMngr
 
 

getResourceManagerPort()

def tc_utils.getResourceManagerPort

(

args

)

Retrieve the TCP port of the cloudFPGA Resource Manager.
:param args The options passed as arguments to the script.
:return     The TCP port number as an integer.

Definition at line 142 of file tc_utils.py.

def getResourceManagerPort(args):
    """Retrieve the TCP port of the cloudFPGA Resource Manager.
    :param args The options passed as arguments to the script.
    :return     The TCP port number as an integer."""
    portMngr = args.mngr_port
    if portMngr != 8080:
        print("[ERROR] The current version of the cloudFPGA Resource manager always listens on port #8080.\n")
        exit(1)
    return portMngr
 
 

num_to_char()

def tc_utils.num_to_char

(

num

)

 Function to map a number to a character.

Definition at line 70 of file tc_utils.py.

def num_to_char(num):
    """ Function to map a number to a character."""
    switcher = {
         0: '0',  1: '1',  2: '2',  3: '3',  4: '4',  5: '5',  6: '6',  7: '7',
         8: '8',  9: '9', 10: 'a', 11: 'b', 12: 'c', 13: 'd', 14: 'e', 15: 'f'
    }
    return switcher.get(num, ' ')  # ' ' is default
 
 

Here is the caller graph for this function:

pingFpga()

def tc_utils.pingFpga

(

ipFpga

)

Ping an FPGA.
:param ipFpga:  The IPv4 address of the FPGA.
:return:        Nothing

Definition at line 199 of file tc_utils.py.

def pingFpga(ipFpga):
    """Ping an FPGA.
    :param ipFpga:  The IPv4 address of the FPGA.
    :return:        Nothing
    """
    print("Now: Trying to \'ping\' the FPGA: ")
    # Send 2 PINGs and wait 2 seconds max for each of them (for a total max of 4s)
    rc = os.system("ping -c 2 -W 2 " + str(ipFpga))
    if rc != 0:
        print("[ERROR] FPGA does not reply to \'ping\'!")
        exit(1)
 

restartApp()

def tc_utils.restartApp	(		instId,
			ipResMngr,
			portResMngr,
			user_name,
			user_passwd
	)

Trigger the role of an FPGA to restart (i.e. perform a SW reset of the role)
:param instId:      The instance Id to restart.
:param ipResMngr:   The IPv4 address of the cF resource manager.
:param portResMngr: The TCP port number of the cF resource manager.
:param user_name:   The user name as used to log in ZYC2.
:param user_passwd: The ZYC2 password attached to the user name.
:return:            Nothing

Definition at line 174 of file tc_utils.py.

def restartApp(instId, ipResMngr, portResMngr, user_name, user_passwd):
    """Trigger the role of an FPGA to restart (i.e. perform a SW reset of the role)
    :param instId:      The instance Id to restart.
    :param ipResMngr:   The IPv4 address of the cF resource manager.
    :param portResMngr: The TCP port number of the cF resource manager.
    :param user_name:   The user name as used to log in ZYC2.
    :param user_passwd: The ZYC2 password attached to the user name.
    :return:            Nothing
    """
    print("\nNow: Requesting the application of FPGA instance #%d to restart." % instId)
    try:
        # We must build a request that is formatted as follows:
        #  http://10.12.0.132:8080/instances/13/app_restart?username=fab&password=secret
        reqUrl = "http://" + str(ipResMngr) + ":" + str(portResMngr) + "/instances/" \
                 + str(instId) + "/app_restart?username=" + user_name \
                 + "&password=" + user_passwd
        # DEBUG print("Generated request URL = ", reqUrl)
        r1 = requests.patch(reqUrl)
        print(r1.content.decode('ascii'))
    except Exception as e:
        print("ERROR: Failed to reset the FPGA role")
        print(str(e))
        exit(1)
 
 

str_rand_gen()

def tc_utils.str_rand_gen

(

size

)

Returns an encoded random string of length 'size'.

Definition at line 89 of file tc_utils.py.

def str_rand_gen(size):
    """Returns an encoded random string of length 'size'."""
    msg = '\n'
    msg += "".join(random.choice(string.ascii_lowercase + string.digits) for _ in range(size-1))
    return msg.encode('ascii', 'replace')
 

str_static_gen()

def tc_utils.str_static_gen

(

size

)

Returns an encoded static string of length 'size'.

Definition at line 79 of file tc_utils.py.

def str_static_gen(size):
    """Returns an encoded static string of length 'size'."""
    msg = '\n'
    msg += '__________Hello_World__________'
    while (len(msg)) < (size):
        msg += num_to_char(len(msg) % 16)
    msg = (msg[:size]) if len(msg) > size else msg
    return msg.encode('ascii', 'replace')
 
 

Here is the call graph for this function:

Variable Documentation

ACM_KO

int tc_utils.ACM_KO = 1

Definition at line 36 of file tc_utils.py.

ACM_OK

int tc_utils.ACM_OK = 0

Definition at line 35 of file tc_utils.py.

BIDIR_MODE_LSN_PORT

int tc_utils.BIDIR_MODE_LSN_PORT = 8802

Definition at line 65 of file tc_utils.py.

ECHO_MODE_LSN_PORT

int tc_utils.ECHO_MODE_LSN_PORT = 8803

Definition at line 66 of file tc_utils.py.

IP4_HDR_LEN

int tc_utils.IP4_HDR_LEN = 20

Definition at line 40 of file tc_utils.py.

IPERF_LSN_PORT

int tc_utils.IPERF_LSN_PORT = 5001

Definition at line 67 of file tc_utils.py.

IPREF3_LSN_PORT

int tc_utils.IPREF3_LSN_PORT = 5201

Definition at line 68 of file tc_utils.py.

MTU

int tc_utils.MTU = 1500

Definition at line 38 of file tc_utils.py.

MTU_ZYC2

int tc_utils.MTU_ZYC2 = 1450

Definition at line 39 of file tc_utils.py.

RECV_MODE_LSN_PORT

int tc_utils.RECV_MODE_LSN_PORT = 8800

Definition at line 63 of file tc_utils.py.

TCP_HDR_LEN

int tc_utils.TCP_HDR_LEN = 20

Definition at line 41 of file tc_utils.py.

UDP_HDR_LEN

int tc_utils.UDP_HDR_LEN = 8

Definition at line 43 of file tc_utils.py.

UDP_MDS

tuple tc_utils.UDP_MDS = (MTU_ZYC2 - IP4_HDR_LEN - UDP_HDR_LEN) & ~0x7

Definition at line 44 of file tc_utils.py.

XMIT_MODE_LSN_PORT

int tc_utils.XMIT_MODE_LSN_PORT = 8801

Definition at line 64 of file tc_utils.py.

ZYC2_MSS

tuple tc_utils.ZYC2_MSS = (MTU_ZYC2 - 92) & ~0x7

Definition at line 42 of file tc_utils.py.