Support and utilities for the simulation of the Network Transport Stack (NTS). More...

Collaboration diagram for SimNts:

Files
file	SimAppData.hpp
	: A simulation class to build APP data streams.

file	SimArpPacket.hpp
	: A simulation class to build and handle ARP packets.

file	SimEthFrame.hpp
	: A simulation class to build and handle Ethernet frames.

file	SimIcmpPacket.hpp
	: A simulation class to build and handle ICMP packets.

file	SimIp4Packet.hpp
	: A simulation class to build and handle IPv4 packets.

file	SimNtsUtils.cpp
	: Utilities for the simulation of the Network-Transport-Stack (NTS) cores.

file	SimNtsUtils.hpp
	: Utilities for the simulation of the Network-Transport-Stack (NTS) components.

file	SimTcpSegment.hpp
	: A simulation class to build TCP segments.

file	SimUdpDatagram.hpp
	: A simulation class to build UDP datagrams.

Classes
class	SimAppData
	Class App Data. More...

class	SimArpPacket
	Class ARP Packet for simulation. More...

class	SimEthFrame
	Class ETHERNET Frame. More...

class	SimIcmpPacket
	Class ICMP Packet for simulation. More...

class	SimIp4Packet
	Class IPv4 Packet for simulation. More...

class	SimTcpSegment
	Class TCP Segment. More...

class	SimUdpDatagram
	Class UDP Datagram. More...

Macros
#define	THIS_NAME "SimNtsUtils"

Functions
bool	isDatFile (string fileName)
	Checks if a file has a ".dat" extension. More...

bool	isDottedDecimal (string ipStr)
	Checks if a string contains an IP address represented in dot-decimal notation. More...

bool	isHexString (string str)
	Checks if a string contains a hexadecimal number. More...

ap_uint< 32 >	myDottedDecimalIpToUint32 (string ipStr)
	Converts an IPv4 address represented with a dotted-decimal string into an UINT32. More...

vector< string >	myTokenizer (string strBuff, char delimiter)
	Brakes a string into tokens by using the 'delimiter' character. More...

string	myUint64ToStrHex (ap_uint< 64 > inputNumber)
	Converts an UINT64 into a string of 16 HEX characters. More...

string	myUint8ToStrHex (ap_uint< 8 > inputNumber)
	Converts an UINT8 into a string of 2 HEX characters. More...

ap_uint< 64 >	myStrHexToUint64 (string dataString)
	Converts a string of 16 HEX characters into an UINT64. More...

ap_uint< 8 >	myStrHexToUint8 (string keepString)
	Converts a string of 2 HEX characters into an UINT8. More...

int	myDiffTwoFiles (string dataFileName, string goldFileName)
	Compares 2 files line-by-line, up to length of the 2nd file. More...

bool	readAxisRawFromLine (AxisRaw &axisRaw, string stringBuffer)
	Retrieve an AxisRaw chunk from a string. More...

bool	writeAxisRawToFile (AxisRaw &axisRaw, ofstream &outFileStream)
	Dump an Axis raw data chunk to a file. More...

int	writeAxisAppToFile (AxisApp &axisApp, ofstream &outFile)
	Dump a TCP or UDP application data chunk into a file. The data are stored as a stream of bytes which is terminated by a newline when the 'TLAST' bit of the data chunk is set. More...

int	writeAxisAppToFile (AxisApp &axisApp, ofstream &outFile, int &wrCount)
	Dump a TCP or UDP application data chunk into a file. Data are stored as a stream of bytes with a newline being appended every time the write-counter reaches the Maximum Segment Size (.i.e, MY_MSS) or the TLAST' bit of the data chunk is set. More...

bool	readFpgaSocketFromLine (SockAddr &fpgaSock, string stringBuffer)
	Retrieve an Fpga socket from a string. More...

bool	readHostSocketFromLine (SockAddr &hostSock, string stringBuffer)
	Retrieve a Host socket from a string. More...

bool	readFpgaSndPortFromLine (Ly4Port &port, string stringBuffer)
	Retrieve an FPGA send port from a string. More...

bool	readAxisRawFromFile (AxisRaw &axisRaw, ifstream &inpFileStream)
	Retrieve an Axis raw data chunk from a file. More...

bool	readTbParamFromFile (const string paramName, const string datFile, unsigned int &paramVal)
	Retrieve a testbench parameter from a DAT file. More...

template<int D>
bool	writeApUintToFile (ap_uint< D > &data, ofstream &outFileStream)
	Dump an AP_UINT to a file. More...

bool	writeSocketPairToFile (SocketPair &socketPair, ofstream &outFileStream)
	Dump a SocketPair to a file. More...

template<class AXIS_T >
bool	feedAxisFromFile (stream< AXIS_T > &ss, const string ssName, string datFile, int &nrChunks, int &nrFrames, int &nrBytes)
	Initialize an Axi4-Stream (Axis) from a DAT file. More...

template<class AXIS_T >
bool	drainAxisToFile (stream< AXIS_T > &ss, const string ssName, string datFile, int &nrChunks, int &nrFrames, int &nrBytes)
	Empty an Axi4-Stream (Axis) to a DAT file. More...

void	_fakeCallTo_feedAxisAppFromFile ()
	Create a bunch of fake local calls to functions as workaround to link errors related to template classes. More...

void	_fakeCallTo_feedAxisArpFromFile ()

void	_fakeCallTo_feedAxisIp4FromFile ()

void	_fakeCallTo_feedAxisEthFromFile ()

void	_fakeCallTo_drainAxisAppToFile ()

void	_fakeCallTo_drainAxisArpToFile ()

void	_fakeCallTo_drainAxisEthToFile ()

void	_fakeCallTo_drainAxisIp4ToFile ()

void	_fakeCallTo_writeApUintToFile ()

bool	feedAxisRawStreamFromFile (stream< AxisRaw > &ss, const string ssName, string datFile, int &nrChunks, int &nrFrames, int &nrBytes)

bool	drainAxisRawStreamToFile (stream< AxisRaw > &ss, const string ssName, string datFile, int &nrChunks, int &nrFrames, int &nrBytes)

Detailed Description

Support and utilities for the simulation of the Network Transport Stack (NTS).

Macro Definition Documentation

◆ THIS_NAME

#define THIS_NAME "SimNtsUtils"

DEBUG PRINT HELPERS

Definition at line 39 of file SimNtsUtils.cpp.

Function Documentation

◆ _fakeCallTo_drainAxisAppToFile()

void _fakeCallTo_drainAxisAppToFile ( )

Definition at line 937 of file SimNtsUtils.cpp.

                                       {
     stream<AxisApp> ss;
     int  nr1, nr2, nr3;
     drainAxisToFile<AxisApp>(ss, "ssName", "aFileName", nr1, nr2, nr3);
 }

◆ _fakeCallTo_drainAxisArpToFile()

void _fakeCallTo_drainAxisArpToFile ( )

Definition at line 942 of file SimNtsUtils.cpp.

                                       {
     stream<AxisArp> ss;
     int  nr1, nr2, nr3;
     drainAxisToFile<AxisArp>(ss, "ssName", "aFileName", nr1, nr2, nr3);
 }

◆ _fakeCallTo_drainAxisEthToFile()

void _fakeCallTo_drainAxisEthToFile ( )

Definition at line 947 of file SimNtsUtils.cpp.

                                       {
     stream<AxisEth> ss;
     int  nr1, nr2, nr3;
     drainAxisToFile<AxisEth>(ss, "ssName", "aFileName", nr1, nr2, nr3);
 }

◆ _fakeCallTo_drainAxisIp4ToFile()

void _fakeCallTo_drainAxisIp4ToFile ( )

Definition at line 952 of file SimNtsUtils.cpp.

                                       {
     stream<AxisIp4> ss;
     int  nr1, nr2, nr3;
     drainAxisToFile<AxisIp4>(ss, "ssName", "aFileName", nr1, nr2, nr3);
 }

◆ _fakeCallTo_feedAxisAppFromFile()

void _fakeCallTo_feedAxisAppFromFile ( )

Create a bunch of fake local calls to functions as workaround to link errors related to template classes.

The common procedure in C++ is to put the class definition in a C++ header file and the implementation in a C++ source file. However, this approach creates linking problems when template functions are used because template functions are expected to be declared and defined in the same file.
Here we implement method #1 proposed by Febil Chacko Thanikal in [1]. The idea is to create a fake call to the template function in the current file, in order for the compiler to compile the function with the appropriate class. This function will then become available at link time.
There is no need to call these functions. They are just here to solve and avoid link errors.

See also: [1] https://www.codeproject.com/Articles/48575/How-to-define-a-template-class-in-a-h-file-and-imp

Definition at line 916 of file SimNtsUtils.cpp.

                                        {
     stream<AxisApp> ss;
     int  nr1, nr2, nr3;
     feedAxisFromFile<AxisApp>(ss, "ssName", "aFileName", nr1, nr2, nr3);
 }

◆ _fakeCallTo_feedAxisArpFromFile()

void _fakeCallTo_feedAxisArpFromFile ( )

Definition at line 921 of file SimNtsUtils.cpp.

                                        {
     stream<AxisArp> ss;
     int  nr1, nr2, nr3;
     feedAxisFromFile<AxisArp>(ss, "ssName", "aFileName", nr1, nr2, nr3);
 }

◆ _fakeCallTo_feedAxisEthFromFile()

void _fakeCallTo_feedAxisEthFromFile ( )

Definition at line 931 of file SimNtsUtils.cpp.

                                        {
     stream<AxisEth> ss;
     int  nr1, nr2, nr3;
     feedAxisFromFile<AxisEth>(ss, "ssName", "aFileName", nr1, nr2, nr3);
 }

◆ _fakeCallTo_feedAxisIp4FromFile()

void _fakeCallTo_feedAxisIp4FromFile ( )

Definition at line 926 of file SimNtsUtils.cpp.

                                        {
     stream<AxisIp4> ss;
     int  nr1, nr2, nr3;
     feedAxisFromFile<AxisIp4>(ss, "ssName", "aFileName", nr1, nr2, nr3);
 }

◆ _fakeCallTo_writeApUintToFile()

void _fakeCallTo_writeApUintToFile ( )

Definition at line 958 of file SimNtsUtils.cpp.

                                      {
     ap_uint<16> data;
     ofstream    ofs;
     writeApUintToFile(data, ofs);
 }

Here is the call graph for this function:

◆ drainAxisRawStreamToFile()

bool drainAxisRawStreamToFile	(	stream< AxisRaw > &	ss,
		const string	ssName,
		string	datFile,
		int &	nrChunks,
		int &	nrFrames,
		int &	nrBytes
	)

◆ drainAxisToFile()

template<class AXIS_T >

bool drainAxisToFile	(	stream< AXIS_T > &	ss,
		const string	ssName,
		string	datFile,
		int &	nrChunks,
		int &	nrFrames,
		int &	nrBytes
	)

Empty an Axi4-Stream (Axis) to a DAT file.

Parameters

	[in/out]	ss, a ref to the Axis to drain.
[in]	ssName,the	name of the Axis to drain.
[in]	fileName,the	DAT file to write to.
	[out	nrChunks, a ref to the number of written chuncks.
[out]	nrFrames,a	ref to the number of written frames.
[out]	nrBytes,a	ref to the number of written bytes.

Returns: NTS_OK if successful, otherwise NTS_KO.

Definition at line 838 of file SimNtsUtils.cpp.

                                                                     {
     ofstream    outFileStream;
     char        currPath[FILENAME_MAX];
     string      strLine;
     int         lineCnt=0;
     AXIS_T      axisChunk;
  
     //-- REMOVE PREVIOUS FILE
     remove(ssName.c_str());
  
     //-- OPEN FILE
     if (!outFileStream.is_open()) {
         outFileStream.open(datFile.c_str(), ofstream::out);
         if (!outFileStream) {
             printError(THIS_NAME, "Cannot open the file: \'%s\'.\n", datFile.c_str());
             return(NTS_KO);
         }
     }
  
     // Assess that file has ".dat" extension
     if ( datFile.find_last_of ( '.' ) != string::npos ) {
         string extension ( datFile.substr( datFile.find_last_of ( '.' ) + 1 ) );
         if (extension != "dat") {
             printError(THIS_NAME, "Cannot dump AxisChunk stream to file \'%s\' because file is not of type \'DAT\'.\n", datFile.c_str());
             outFileStream.close();
             return(NTS_KO);
         }
     }
  
     //-- READ FROM STREAM AND WRITE TO FILE
     outFileStream << std::hex << std::noshowbase;
     outFileStream << std::setfill('0');
     outFileStream << std::uppercase;
     while (!(ss.empty())) {
         ss.read(axisChunk);
         outFileStream << std::setw(16) << ((uint64_t) axisChunk.getLE_TData());
         outFileStream << " ";
         outFileStream << std::setw(1)  << ( (uint32_t) axisChunk.getLE_TLast());
         outFileStream << " ";
         outFileStream << std::setw(2)  << ( (uint32_t) axisChunk.getLE_TKeep());
         outFileStream << std::endl;
         nrChunks++;
         nrBytes  += axisChunk.getLen();
         if (axisChunk.getLE_TLast()) {
             nrFrames ++;
             outFileStream << std::endl;
         }
     }
  
     //-- CLOSE FILE
     outFileStream.close();
  
     return(NTS_OK);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ feedAxisFromFile()

template<class AXIS_T >

bool feedAxisFromFile	(	stream< AXIS_T > &	ss,
		const string	ssName,
		string	datFile,
		int &	nrChunks,
		int &	nrFrames,
		int &	nrBytes
	)

Initialize an Axi4-Stream (Axis) from a DAT file.

Parameters

	[in/out]	ss A ref to the Axis to set.
[in]	ssName	The name of the Axis to set.
[in]	fileName	The DAT file to read from.
	[out	nrChunks A ref to the number of written chunks.
[out]	nrFrames	A ref to the number of written frames.
[out]	nrBytes	A ref to the number of written bytes.

Returns: true successful, otherwise false.

Definition at line 776 of file SimNtsUtils.cpp.

                                                                             {
     ifstream    inpFileStream;
     char        currPath[FILENAME_MAX];
     string      strLine;
     int         lineCnt=0;
     AxisRaw     axisRaw;
     bool        rc=false;
  
     //-- STEP-1 : OPEN FILE
     inpFileStream.open(datFile.c_str());
     if (!inpFileStream) {
         getcwd(currPath, sizeof(currPath));
         printError(THIS_NAME, "Cannot open the file: %s \n\t (FYI - The current working directory is: %s) \n", datFile.c_str(), currPath);
         return(NTS_KO);
     }
     // Assess that file has ".dat" extension
     if (not isDatFile(datFile)) {
         printError(THIS_NAME, "Cannot set AxisRaw stream from file \'%s\' because file is not of type \'DAT\'.\n", datFile.c_str());
         inpFileStream.close();
         return(NTS_KO);
     }
     //-- STEP-2 : READ FROM FILE AND WRITE TO STREAM
     while (!inpFileStream.eof()) {
         if (not readAxisRawFromFile(axisRaw, inpFileStream)) {
             break;
         }
         // Write to stream
         if (ss.full()) {
             printError(THIS_NAME, "Cannot write stream \'%s\'. Stream is full.\n",
                        ssName.c_str());
             rc = false;
             break;
         }
         else {
             ss.write(AXIS_T(axisRaw));
             nrChunks++;
             nrFrames += axisRaw.getLE_TLast().to_int();
             nrBytes  += axisRaw.getLen();
             lineCnt++;
             rc = true;
         }
     }
     //-- STEP-3: CLOSE FILE
     inpFileStream.close();
     return(rc);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ feedAxisRawStreamFromFile()

bool feedAxisRawStreamFromFile	(	stream< AxisRaw > &	ss,
		const string	ssName,
		string	datFile,
		int &	nrChunks,
		int &	nrFrames,
		int &	nrBytes
	)

SIMULATION STREAM WRITER HELPERS - PROTOTYPE DEFINITIONS

◆ isDatFile()

bool isDatFile ( string fileName )

Checks if a file has a ".dat" extension.

SIMULATION UTILITY HELPERS

Parameters

[in] fileName,the name of the file to assess.

Returns: True/False.

FORWARD DECLARATIONS HELPERS FOR THE DEBUGGING TRACES FYI: The global variable 'gTraceEvent' is set whenever a trace call is done. SIMULATION UTILITY HELPERS - PROTOTYPE DEFINITIONS

Definition at line 52 of file SimNtsUtils.cpp.

                                 {
     if (fileName.find_last_of ( '.' ) != string::npos) {
         string extension (fileName.substr(fileName.find_last_of ( '.' ) + 1 ) );
         if (extension != "dat")
             return false;
         else
             return true;
     }
     return false;
 }

Here is the caller graph for this function:

◆ isDottedDecimal()

bool isDottedDecimal ( string ipStr )

Checks if a string contains an IP address represented in dot-decimal notation.

Parameters

[in] ipAddStr The string to assess.

Returns: True/False.

Definition at line 72 of file SimNtsUtils.cpp.

                                    {
     vector<string>  stringVector;
  
     stringVector = myTokenizer(ipStr, '.');
     if (stringVector.size() == 4)
         return true;
     else
         return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isHexString()

bool isHexString ( string str )

Checks if a string contains a hexadecimal number.

Parameters

[in] str The string to assess.

Returns: True/False.

Definition at line 90 of file SimNtsUtils.cpp.

                              {
     char     *pEnd;
     long int  res;
  
     if (str == "")
         return false;
     res = strtol(str.c_str(), &pEnd, 16);
     //  If string is not '\0' and *pEnd is '\0' on return, the entire string is valid.
     if (*pEnd == '\0') {
         if ((str.find("0x") != string::npos) || (str.find("0X") != string::npos))
             return true;
         else
             return false;
     }
     else
         return false;
 }

Here is the caller graph for this function:

◆ myDiffTwoFiles()

int myDiffTwoFiles	(	string	dataFileName,
		string	goldFileName
	)

Compares 2 files line-by-line, up to length of the 2nd file.

Parameters

[in]	dataFileName	The name of the 1st file.
[in]	goldFileName	The name of the 2nd file.

Returns: NTS_OK upon success, otherwise the number of line that differ.

@info: This comparison is equivalent to the Linux command 'diff –brief -w', except that it offers the possibility to stop the comparison after a certain number of lines. This can be useful when comparing a golden file with the output data file generated by a Vivado HLS C/RTL Co-simulation. In facts, when using the pragma 'HLS INTERFACE ap_ctrl_none', we observe that the simulator is generating unexpected stimuli after the testbench is over (at least with Vivado 2017.4), which can create a discrepancy with the golden file. Therefore, this function can be used to compare two files based on the length of the 2nd file.

Definition at line 305 of file SimNtsUtils.cpp.

                                                              {
     ifstream    dataFileStream;
     ifstream    goldFileStream;
     int         noLineDiff = 0;
  
     //-- OPEN FILES
     dataFileStream.open(dataFileName.c_str());
     if (!dataFileStream) {
         printError(THIS_NAME, "Cannot open the file: \'%s\'.\n", dataFileName.c_str());
         return(NTS_KO);
     }
     goldFileStream.open(goldFileName.c_str());
     if (!goldFileStream) {
         printError(THIS_NAME, "Cannot open the file: \'%s\'.\n", goldFileName.c_str());
         dataFileStream.close();
         return(NTS_KO);
     }
  
     if ((dataFileStream.peek() != std::ifstream::traits_type::eof()) and
         (goldFileStream.peek() != std::ifstream::traits_type::eof())) {
         string goldStrLine;
         string dataStrLine;
         while (getline(goldFileStream, goldStrLine)) {
             if (getline(dataFileStream, dataStrLine)) {
                 if (goldStrLine != dataStrLine) {
                     printWarn(THIS_NAME, "Diff: %s - %s\n", goldStrLine.c_str(), dataStrLine.c_str());
                     noLineDiff++;
                }
             }
             else {
                 printWarn(THIS_NAME, "Diff: %s - %s\n", goldStrLine.c_str(), "No entry found in data file!");
                 noLineDiff++;
             }
         }
     }
     else if (dataFileStream.peek() == std::ifstream::traits_type::eof()) {
         string goldStrLine;
         while (getline(goldFileStream, goldStrLine)) {
             printWarn(THIS_NAME, "Diff: %s - %s\n", goldStrLine.c_str(), "  ");
             noLineDiff++;
         }
     }
     else if (goldFileStream.peek() == std::ifstream::traits_type::eof()) {
         string dataStrLine;
         while (getline(goldFileStream, dataStrLine)) {
             printWarn(THIS_NAME, "Diff: %s - %s\n", dataStrLine.c_str(), "  ");
             noLineDiff++;
         }
     }
     else {
         noLineDiff++;
     }
     //-- CLOSE FILES
     dataFileStream.close();
     goldFileStream.close();
  
     return noLineDiff;
 }

Here is the caller graph for this function:

◆ myDottedDecimalIpToUint32()

ap_uint< 32 > myDottedDecimalIpToUint32 ( string ipStr )

Converts an IPv4 address represented with a dotted-decimal string into an UINT32.

Parameters

[in] inputNumber The string to convert.

Returns: ap_uint<32>.

Definition at line 117 of file SimNtsUtils.cpp.

                                                     {
     vector<string>  stringVector;
     ap_uint<32>     ip4Uint = 0x00000000;
     ap_uint<32>     octet;
  
     stringVector = myTokenizer(ipStr, '.');
     char * ptr;
     for (int i=0; i<stringVector.size(); i++) {
         octet = strtoul(stringVector[i].c_str(), &ptr, 10);
         ip4Uint |= (octet << 8*(3-i));
     }
     return ip4Uint;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ myStrHexToUint64()

ap_uint< 64 > myStrHexToUint64 ( string dataString )

Converts a string of 16 HEX characters into an UINT64.

Parameters

[in] inputNumber The string to convert.

Returns: ap_uint<64>.

Definition at line 230 of file SimNtsUtils.cpp.

                                                 {
     ap_uint<64> tempOutput          = 0;
     unsigned short int  tempValue   = 16;
     static const char* const    lut = "0123456789ABCDEF";
  
     for (unsigned short int i = 0; i<dataString.size(); ++i) {
         for (unsigned short int j = 0;j<16;++j) {
             if (lut[j] == toupper(dataString[i])) {
                 tempValue = j;
                 break;
             }
         }
         if (tempValue != 16) {
             for (short int k = 3; k>=0; --k) {
                 if (tempValue >= pow(2.0, k)) {
                     tempOutput.bit(63-(4*i+(3-k))) = 1;
                     tempValue -= static_cast <unsigned short int>(pow(2.0, k));
                 }
             }
         }
     }
     return tempOutput;
 }

Here is the caller graph for this function:

◆ myStrHexToUint8()

ap_uint< 8 > myStrHexToUint8 ( string keepString )

Converts a string of 2 HEX characters into an UINT8.

Parameters

[in] inputNumber The string to convert.

Returns: ap_uint<8>.

Definition at line 262 of file SimNtsUtils.cpp.

                                               {
     ap_uint<8>               tempOutput = 0;
     unsigned short int       tempValue  = 16;
     static const char* const lut        = "0123456789ABCDEF";
  
     for (unsigned short int i = 0; i<2;++i) {
         for (unsigned short int j = 0;j<16;++j) {
             if (lut[j] == toupper(keepString[i])) {
                 tempValue = j;
                 break;
             }
         }
         if (tempValue != 16) {
             for (short int k = 3;k>=0;--k) {
                 if (tempValue >= pow(2.0, k)) {
                     tempOutput.bit(7-(4*i+(3-k))) = 1;
                     tempValue -= static_cast <unsigned short int>(pow(2.0, k));
                 }
             }
         }
     }
     return tempOutput;
 }

Here is the caller graph for this function:

◆ myTokenizer()

vector< string > myTokenizer	(	string	strBuff,
		char	delimiter
	)

Brakes a string into tokens by using the 'delimiter' character.

Parameters

[in]	stringBuffer	The string to tokenize.
[in]	delimiter	The delimiter character to use.

Returns: a vector of strings.

Definition at line 141 of file SimNtsUtils.cpp.

                                                            {
     vector<string>   tmpBuff;
     int              tokenCounter = 0;
     bool             found = false;
  
     if (strBuff.empty()) {
         tmpBuff.push_back(strBuff);
         return tmpBuff;
     }
     else {
         // Substitute the "\r" with nothing
         if (strBuff[strBuff.size() - 1] == '\r')
             strBuff.erase(strBuff.size() - 1);
     }
     // Search for 'delimiter' characters between the different strings
     while (strBuff.find(delimiter) != string::npos) {
         // Split the string in two parts
         string temp = strBuff.substr(0, strBuff.find(delimiter));
         // Remove first element from 'strBuff'
         strBuff = strBuff.substr(strBuff.find(delimiter)+1, strBuff.length());
         // Store the new part into the vector.
         if (temp != "")
             tmpBuff.push_back(temp);
         // Quit if the current line is a comment
         if ((tokenCounter == 0) && (temp =="#"))
             break;
     }
  
     // Push the final part of the string into the vector when no more spaces are present.
     tmpBuff.push_back(strBuff);
     return tmpBuff;
 }

Here is the caller graph for this function:

◆ myUint64ToStrHex()

string myUint64ToStrHex ( ap_uint< 64 > inputNumber )

Converts an UINT64 into a string of 16 HEX characters.

Parameters

[in] inputNumber The UINT64 to convert.

Returns: a string of 16 HEX characters.

Definition at line 182 of file SimNtsUtils.cpp.

                                                  {
     string                    outputString    = "0000000000000000";
     unsigned short int        tempValue       = 16;
     static const char* const  lut             = "0123456789ABCDEF";
  
     for (int i = 15;i>=0;--i) {
         tempValue = 0;
         for (unsigned short int k = 0;k<4;++k) {
             if (inputNumber.bit((i+1)*4-k-1) == 1)
                 tempValue += static_cast <unsigned short int>(pow(2.0, 3-k));
         }
         outputString[15-i] = lut[tempValue];
     }
     return outputString;
 }

◆ myUint8ToStrHex()

string myUint8ToStrHex ( ap_uint< 8 > inputNumber )

Converts an UINT8 into a string of 2 HEX characters.

Parameters

[in] inputNumber The UINT8 to convert.

Returns: a string of 2 HEX characters.

Definition at line 206 of file SimNtsUtils.cpp.

                                                {
     string                      outputString    = "00";
     unsigned short int          tempValue       = 16;
     static const char* const    lut             = "0123456789ABCDEF";
  
     for (int i = 1;i>=0;--i) {
         tempValue = 0;
         for (unsigned short int k = 0; k<4; ++k) {
             if (inputNumber.bit((i+1)*4-k-1) == 1)
                 tempValue += static_cast <unsigned short int>(pow(2.0, 3-k));
         }
         outputString[1-i] = lut[tempValue];
     }
     return outputString;
 }

Here is the caller graph for this function:

◆ readAxisRawFromFile()

bool readAxisRawFromFile	(	AxisRaw &	axisRaw,
		ifstream &	inpFileStream
	)

Retrieve an Axis raw data chunk from a file.

FILE READ & WRITER HELPERS

Parameters

[in]	axisRaw	A reference to the raw data chunk to retrieve.
[in]	inpFileStream	The input file stream to read from.

Returns: true if successful, otherwise false.

SIMULATION FILE READ & WRITE HELPERS - PROTOTYPE DEFINITIONS

Definition at line 624 of file SimNtsUtils.cpp.

                                                                     {
     string          stringBuffer;
     vector<string>  stringVector;
     bool rc = false;
  
     if (!inpFileStream.is_open()) {
         printError(THIS_NAME, "File is not opened.\n");
         return false;
     }
     while (inpFileStream.peek() != EOF) {
         getline(inpFileStream, stringBuffer);
         rc = readAxisRawFromLine(axisRaw, stringBuffer);
         if (rc) {
             break;
         }
     }
     return rc;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readAxisRawFromLine()

bool readAxisRawFromLine	(	AxisRaw &	axisRaw,
		string	stringBuffer
	)

Retrieve an AxisRaw chunk from a string.

LINE READ & WRITE HELPERS

Parameters

[in]	axisRaw	A ref to the AxisRaw to retrieve.
[in]	stringBuffer	The string buffer to read from.

Returns: true if successful, otherwise false.

SIMULATION LINE READ & WRITE HELPERS - PROTOTYPE DEFINITIONS

Definition at line 378 of file SimNtsUtils.cpp.

                                                                 {
     vector<string> stringVector;
     stringVector = myTokenizer(stringBuffer, ' ');
     if (stringVector[0] == "") {
         return false;
     }
     else if (stringVector[0].length() == 1) {
         // Skip this line as it is either a comment of a command
         return false;
     }
     else if ( (stringVector.size() == 3) or
              ((stringVector.size() == 4) and (stringVector[3] == "(FORCED_INVALID_TKEEP)")) ) {
         axisRaw.setLE_TData(myStrHexToUint64(stringVector[0]));
         axisRaw.setLE_TLast(atoi(            stringVector[1].c_str()));
         axisRaw.setLE_TKeep(myStrHexToUint8( stringVector[2]));
         if ((stringVector.size() == 3) and (not axisRaw.isValid())) {
             printError(THIS_NAME, "Failed to read AxisRaw from line \"%s\".\n", stringBuffer.c_str());
             printFatal(THIS_NAME, "\tFYI - 'tkeep' and 'tlast' are inconsistent...\n");
         }
         return true;
     }
     else {
         printError(THIS_NAME, "Failed to read AxisRaw from line \"%s\".\n", stringBuffer.c_str());
         printFatal(THIS_NAME, "\tFYI - The file might be corrupted...\n");
     }
     return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFpgaSndPortFromLine()

bool readFpgaSndPortFromLine	(	Ly4Port &	port,
		string	stringBuffer
	)

Retrieve an FPGA send port from a string.

Parameters

[in]	port	A ref to the socket port to retrieve.
[in]	stringBuffer	The string buffer to read from.

Returns: true if successful, otherwise false.

Definition at line 591 of file SimNtsUtils.cpp.

                                                                  {
     vector<string> stringVector;
     stringVector = myTokenizer(stringBuffer, ' ');
     if ((stringVector[0] == ">") and (stringVector[1] == "SET")) {
         if (stringVector[2] == "FpgaSndPort") {
             char *pEnd;
             // Retrieve the host LY4 port
             if (isHexString(stringVector[4])) {
                 port = strtoul(stringVector[4].c_str(), &pEnd, 16);
             }
             else {
                 port = strtoul(stringVector[4].c_str(), &pEnd, 10);
             }
             return true;
         }
     }
     return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFpgaSocketFromLine()

bool readFpgaSocketFromLine	(	SockAddr &	fpgaSock,
		string	stringBuffer
	)

Retrieve an Fpga socket from a string.

Parameters

[in]	fpgaSock	A ref to the socket address to retrieve.
[in]	stringBuffer	The string buffer to read from.

Returns: true if successful, otherwise false.

Definition at line 511 of file SimNtsUtils.cpp.

                                                                      {
     vector<string> stringVector;
     stringVector = myTokenizer(stringBuffer, ' ');
     if ((stringVector[0] == ">") and (stringVector[1] == "SET")) {
         if ((stringVector[2] == "FpgaServerSocket") or
             (stringVector[2] == "FpgaSocket")) {
             char *pEnd;
             // Retrieve the fpga IPv4 address
             if (isDottedDecimal(stringVector[3])) {
                 fpgaSock.addr = myDottedDecimalIpToUint32(stringVector[3]);
             }
             else if (isHexString(stringVector[3])) {
                 fpgaSock.addr = strtoul(stringVector[3].c_str(), &pEnd, 16);
             }
             else {
                 fpgaSock.addr = strtoul(stringVector[3].c_str(), &pEnd, 10);
             }
             // Retrieve the fpga LY4 port
             if (isHexString(stringVector[4])) {
                 fpgaSock.port = strtoul(stringVector[4].c_str(), &pEnd, 16);
             }
             else {
                 fpgaSock.port = strtoul(stringVector[4].c_str(), &pEnd, 10);
             }
             return true;
         }
     }
     return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readHostSocketFromLine()

bool readHostSocketFromLine	(	SockAddr &	hostSock,
		string	stringBuffer
	)

Retrieve a Host socket from a string.

Parameters

[in]	hostSock	A ref to the socket address to retrieve.
[in]	stringBuffer	The string buffer to read from.

Returns: true if successful, otherwise false.

Definition at line 551 of file SimNtsUtils.cpp.

                                                                      {
     vector<string> stringVector;
     stringVector = myTokenizer(stringBuffer, ' ');
     if ((stringVector[0] == ">") and (stringVector[1] == "SET")) {
         if ((stringVector[2] == "HostServerSocket") or
             (stringVector[2] == "HostSocket")) {
             char *pEnd;
             // Retrieve the host IPv4 address
             if (isDottedDecimal(stringVector[3])) {
                 hostSock.addr = myDottedDecimalIpToUint32(stringVector[3]);
             }
             else if (isHexString(stringVector[3])) {
                 hostSock.addr = strtoul(stringVector[3].c_str(), &pEnd, 16);
             }
             else {
                 hostSock.addr = strtoul(stringVector[3].c_str(), &pEnd, 10);
             }
             // Retrieve the host LY4 port
             if (isHexString(stringVector[4])) {
                 hostSock.port = strtoul(stringVector[4].c_str(), &pEnd, 16);
             }
             else {
                 hostSock.port = strtoul(stringVector[4].c_str(), &pEnd, 10);
             }
             return true;
         }
     }
     return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readTbParamFromFile()

bool readTbParamFromFile	(	const string	paramName,
		const string	datFile,
		unsigned int &	paramVal
	)

Retrieve a testbench parameter from a DAT file.

Parameters

[in]	paramName	The name of the parameter to read.
[in]	datFile	The input file to read from.
[out]	paramVal	A ref. to the parameter value.

Returns: true if successful, otherwise false.

Definition at line 654 of file SimNtsUtils.cpp.

                                                  {
     ifstream        inpFileStream;
     char            currPath[FILENAME_MAX];
     string          rxStringBuffer;
     vector<string>  stringVector;
  
     if (not isDatFile(datFile)) {
         printError(THIS_NAME, "Input test vector file \'%s\' is not of type \'DAT\'.\n", datFile.c_str());
         return(NTS_KO);
     }
     inpFileStream.open(datFile.c_str());
     if (!inpFileStream) {
         getcwd(currPath, sizeof(currPath));
         printError(THIS_NAME, "Cannot open the file: %s \n\t (FYI - The current working directory is: %s) \n", datFile.c_str(), currPath);
         return(NTS_KO);
     }
  
     do {
         //-- READ ONE LINE AT A TIME FROM INPUT FILE ---------------
         getline(inpFileStream, rxStringBuffer);
         stringVector = myTokenizer(rxStringBuffer, ' ');
         if (stringVector[0] == "") {
             continue;
         }
         else if (stringVector[0].length() == 1) {
             // By convention, a global parameter must start with a single 'G' character.
             if ((stringVector[0] == "G") && (stringVector[1] == "PARAM")) {
                 if (stringVector[2] == paramName) {
                     char * ptr;
                     if (isDottedDecimal(stringVector[3])) {
                         paramVal = myDottedDecimalIpToUint32(stringVector[3]);
                     }
                     else if (isHexString(stringVector[3])) {
                         paramVal = strtoul(stringVector[3].c_str(), &ptr, 16);
                     }
                     else {
                         paramVal = strtoul(stringVector[3].c_str(), &ptr, 10);
                     }
                     inpFileStream.close();
                     return NTS_OK;
                 }
             }
         }
     } while(!inpFileStream.eof());
     inpFileStream.close();
     return NTS_KO;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeApUintToFile()

template<int D>

bool writeApUintToFile	(	ap_uint< D > &	data,
		ofstream &	outFileStream
	)

Dump an AP_UINT to a file.

Parameters

[in]	data	A reference to the data to dump.
[in]	outFileStream	A reference to the file stream to write.

Returns: true upon successful, otherwise false.

Definition at line 714 of file SimNtsUtils.cpp.

                                                                                    {
     if (not outFileStream.is_open()) {
         printError(THIS_NAME, "File is not opened.\n");
         return false;
     }
     outFileStream << std::uppercase;
     outFileStream << "0x" << hex << noshowbase << setfill('0');
     switch (D) {
     case 8:
     case 16:
     case 32:
     case 64:
         outFileStream << setw(D/4) << data.to_int() << "\n";
         break;
     default:
         printError(THIS_NAME, "Format ap_uint<%d> is not supported.\n", D);
         return false;
     }
     return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAxisAppToFile() [1/2]

int writeAxisAppToFile	(	AxisApp &	axisApp,
		ofstream &	outFile
	)

Dump a TCP or UDP application data chunk into a file. The data are stored as a stream of bytes which is terminated by a newline when the 'TLAST' bit of the data chunk is set.

Parameters

[in]	appData	A reference to AxisApp chunk to write.
[in]	outFile	A reference to the file stream to write.

Returns: the number of bytes written into the file.

Definition at line 444 of file SimNtsUtils.cpp.

                                                             {
     int writtenBytes = 0;
     for (int bytNum=0; bytNum<8; bytNum++) {
         if (axisApp.getLE_TKeep()[bytNum]) {
             int hi = ((bytNum*8) + 7);
             int lo = ((bytNum*8) + 0);
             ap_uint<8>  octet = axisApp.getLE_TData(hi, lo);
             // Write byte to file
             outFile << myUint8ToStrHex(octet);
             writtenBytes++;
         }
     }
     if (axisApp.getTLast()) {
         outFile << endl;
     }
     return writtenBytes;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAxisAppToFile() [2/2]

int writeAxisAppToFile	(	AxisApp &	axisApp,
		ofstream &	outFile,
		int &	wrCount
	)

Dump a TCP or UDP application data chunk into a file. Data are stored as a stream of bytes with a newline being appended every time the write-counter reaches the Maximum Segment Size (.i.e, MY_MSS) or the TLAST' bit of the data chunk is set.

Parameters

[in]	appData	A reference to the AxisApp chunk to write.
[in]	outFile	A reference to the file stream to write.
[in]	wrCount	A ref to a segment write counter.

Returns: the number of bytes written into the file.

Definition at line 475 of file SimNtsUtils.cpp.

                                                                           {
     int writtenBytes = 0;
     for (int bytNum=0; bytNum<8; bytNum++) {
         if (axisApp.getLE_TKeep()[bytNum]) {
             int hi = ((bytNum*8) + 7);
             int lo = ((bytNum*8) + 0);
             ap_uint<8>  octet = axisApp.getLE_TData(hi, lo);
             // Write byte to file
             outFile << myUint8ToStrHex(octet);
             writtenBytes++;
             wrCount++;
             if (wrCount == ZYC2_MSS) {
                 // Emulate the IP segmentation behavior when writing this
                 //  file by appending a newline when mssCounter == MMS
                 outFile << endl;
                 wrCount = 0;
             }
         }
     }
     if ((axisApp.getTLast()) && (wrCount != 0)) {
         outFile << endl;
         wrCount = 0;
     }
     return writtenBytes;
 }

Here is the call graph for this function:

◆ writeAxisRawToFile()

bool writeAxisRawToFile	(	AxisRaw &	axisRaw,
		ofstream &	outFileStream
	)

Dump an Axis raw data chunk to a file.

Parameters

[in]	axisRaw	A reference to the raw data chunk to write.
[in]	outFileStream	A reference to the file stream to write.

Returns: true upon successful, otherwise false.

Definition at line 416 of file SimNtsUtils.cpp.

                                                                    {
     if (not outFileStream) {
         printError(THIS_NAME, "File is not opened.\n");
         return false;
     }
     outFileStream << std::uppercase;
     outFileStream << hex << noshowbase << setfill('0') << setw(16) << axisRaw.getLE_TData().to_uint64();
     outFileStream << " ";
     outFileStream << setw(1)  << axisRaw.getLE_TLast().to_int();
     outFileStream << " ";
     outFileStream << hex << noshowbase << setfill('0') << setw(2)  << axisRaw.getLE_TKeep().to_int() << "\n";
     if (axisRaw.getLE_TLast()) {
         outFileStream << "\n";
     }
     return(true);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeSocketPairToFile()

bool writeSocketPairToFile	(	SocketPair &	socketPair,
		ofstream &	outFileStream
	)

Dump a SocketPair to a file.

Parameters

[in]	socketPair	A reference to the SocketPair to dump.
[in]	outFileStream	The output file stream to write to.

Returns: true if successful, otherwise false.

Definition at line 745 of file SimNtsUtils.cpp.

                                                                             {
     if (!outFileStream.is_open()) {
         printError(THIS_NAME, "File is not opened.\n");
         return false;
     }
     outFileStream << std::uppercase;
     outFileStream << "0x" << hex << noshowbase << setfill('0') << setw(8) << socketPair.src.addr.to_uint();
     outFileStream << " ";
     outFileStream << "0x" << hex << noshowbase << setfill('0') << setw(4) << socketPair.src.port.to_ushort();
     outFileStream << " ";
     outFileStream << "0x" << hex << noshowbase << setfill('0') << setw(8) << socketPair.dst.addr.to_uint();
     outFileStream << " ";
     outFileStream << "0x" << hex << noshowbase << setfill('0') << setw(4) << socketPair.dst.port.to_ushort();
     outFileStream << "\n";
     return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Files

Classes

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ THIS_NAME

Function Documentation

◆ _fakeCallTo_drainAxisAppToFile()

◆ _fakeCallTo_drainAxisArpToFile()

◆ _fakeCallTo_drainAxisEthToFile()

◆ _fakeCallTo_drainAxisIp4ToFile()

◆ _fakeCallTo_feedAxisAppFromFile()

◆ _fakeCallTo_feedAxisArpFromFile()

◆ _fakeCallTo_feedAxisEthFromFile()

◆ _fakeCallTo_feedAxisIp4FromFile()

◆ _fakeCallTo_writeApUintToFile()

◆ drainAxisRawStreamToFile()

◆ drainAxisToFile()

◆ feedAxisFromFile()

◆ feedAxisRawStreamFromFile()

◆ isDatFile()

◆ isDottedDecimal()

◆ isHexString()

◆ myDiffTwoFiles()

◆ myDottedDecimalIpToUint32()

◆ myStrHexToUint64()

◆ myStrHexToUint8()

◆ myTokenizer()

◆ myUint64ToStrHex()

◆ myUint8ToStrHex()

◆ readAxisRawFromFile()

◆ readAxisRawFromLine()

◆ readFpgaSndPortFromLine()

◆ readFpgaSocketFromLine()

◆ readHostSocketFromLine()

◆ readTbParamFromFile()

◆ writeApUintToFile()

◆ writeAxisAppToFile() [1/2]

◆ writeAxisAppToFile() [2/2]

◆ writeAxisRawToFile()

◆ writeSocketPairToFile()