SimUdpDatagram Class Reference

Class UDP Datagram. More...

#include <SimUdpDatagram.hpp>

Public Member Functions
	SimUdpDatagram (int dgmLen)
	SimUdpDatagram ()
void	pushChunk (AxisUdp udpChunk)
AxisUdp	pullChunk ()
int	length ()
int	size ()
void	clone (SimUdpDatagram &udpDgm)
	Clone a UDP datagram. More...
void	cloneHeader (SimUdpDatagram &udpDgm)
	Clone the header of a UDP datagram. More...
SimUdpDatagram	pullHeader ()
	Pull the header of this datagram. More...
void	setUdpSourcePort (int port)
int	getUdpSourcePort ()
void	setUdpDestinationPort (int port)
int	getUdpDestinationPort ()
void	setUdpLength (UdpLen len)
UdpLen	getUdpLength ()
void	setUdpChecksum (UdpCsum csum)
UdpCsum	getUdpChecksum ()
void	addUdpPayload (string pldStr)
UdpCsum	calculateUdpChecksum (Ip4Addr ipSa, Ip4Addr ipDa)
	Calculate the UDP checksum of the datagram. More...
UdpCsum	reCalculateUdpChecksum (Ip4Addr ipSa, Ip4Addr ipDa)
	Recalculate the UDP checksum of a datagram. More...
bool	isWellFormed (const char *callerName, Ip4Addr ipSa, Ip4Addr ipDa)
	Checks if the datagram header fields are properly set. More...
bool	writeAxisUdpToFile (AxisUdp *axisUdp, ofstream &outFileStream)
	Dump an AxisUdp chunk to a file. More...
bool	writeToDatFile (ofstream &outFileStream)
	Dump this UDP datagram as raw AxisUdp chunks into a file. More...
bool	writePayloadToDatFile (ofstream &outFileStream)
	Dump the payload of this datagram as AxisUdp chunks into a file. More...

Detailed Description

Class UDP Datagram.

This class defines an UDP datagram as a stream of 'AxisUdp' data chunks. Such an UDP datagram consists of a double-ended queue that is used to accumulate all these data chunks. For the 10GbE MAC, the UDP chunks are 64 bits wide.

Definition at line 47 of file SimUdpDatagram.hpp.

Constructor & Destructor Documentation

SimUdpDatagram() [1/2]

SimUdpDatagram::SimUdpDatagram ( int  dgmLen )

inline

Definition at line 83 of file SimUdpDatagram.hpp.

                               {
        this->myName = "SimUdpDatagram";
        setLen(0);
        if (dgmLen > 0 && dgmLen <= MTU) {
            int noBytes = dgmLen;
            while(noBytes > 8) {
                pushChunk(AxisUdp(0x0000000000000000, 0xFF, 0));
                noBytes -= 8;
            }
            pushChunk(AxisUdp(0x0000000000000000, lenToLE_tKeep(noBytes), TLAST));
        }
    }

Here is the call graph for this function:

SimUdpDatagram() [2/2]

SimUdpDatagram::SimUdpDatagram ( )

inline

Definition at line 95 of file SimUdpDatagram.hpp.

                     {
        this->myName = "SimUdpDatagram";
        this->len = 0;
    }

Member Function Documentation

addUdpPayload()

void SimUdpDatagram::addUdpPayload ( string  pldStr )

inline

Definition at line 189 of file SimUdpDatagram.hpp.

                                      {
        if (this->getLen() != UDP_HEADER_LEN) {
            printFatal(this->myName, "Empty datagram is expected to be of length %d bytes (was found to be %d bytes).\n",
                       UDP_HEADER_LEN, this->getLen());
        }
        int hdrLen = this->getLen();  // in bytes
        int pldLen = pldStr.size();
        int q = (hdrLen / 8);
        int b = (hdrLen % 8);
        int i = 0;
        // At this point we are aligned on an 8-byte data chunk since all
        // UDP packets have an 8-byte header.
        while (i < pldLen) {
            unsigned long leQword = 0x0000000000000000;  // in LE order
            unsigned char leKeep  = 0x00;
            bool          leLast  = false;
            while (b < 8) {
                unsigned char datByte = pldStr[i];
                leQword = leQword | (datByte << b*8);
                leKeep  = leKeep  | (1 << b);
                i++;
                b++;
                if (i == pldLen) {
                    leLast = true;
                    break;
                }
            }
            b = 0;
            pushChunk(AxisUdp(leQword, leKeep, leLast));
        }
    }  // End-of: addUdpPayload

Here is the call graph for this function:

calculateUdpChecksum()

UdpCsum SimUdpDatagram::calculateUdpChecksum ( Ip4Addr  ipSa, Ip4Addr  ipDa  )

inline

Calculate the UDP checksum of the datagram.

• This method computes the UDP checksum over the pseudo header, the UDP header and UDP data. According to RFC768, the pseudo header consists of the IP-{SA,DA,Prot} fields and the UDP length field. 0 7 8 15 16 23 24 31 +-----—+-----—+-----—+-----—+ | source address | +-----—+-----—+-----—+-----—+ | destination address | +-----—+-----—+-----—+-----—+ | zero |protocol| UDP length | +-----—+-----—+-----—+-----—+

@Warning The checksum is computed on the double-ended queue which holds the UDP chunks in little-endian order (see AxisUdp) !

Returns

the computed checksum.

Definition at line 240 of file SimUdpDatagram.hpp.

                                                             {
        ap_uint<32> csum = 0;
        csum += byteSwap16(ipSa(31, 16));  // Set IP_SA in LE
        csum += byteSwap16(ipSa(15,  0));
        csum += byteSwap16(ipDa(31, 16));  // Set IP_DA in LE
        csum += byteSwap16(ipDa(15,  0));
        csum += byteSwap16(ap_uint<16>(IP4_PROT_UDP));
        csum += byteSwap16(this->getUdpLength());
        for (int i=0; i<this->size(); ++i) {
            LE_tData tempInput = 0;
            if (dgmQ[i].getLE_TKeep() & 0x01)
                tempInput.range( 7, 0) = (dgmQ[i].getLE_TData()).range( 7, 0);
            if (dgmQ[i].getLE_TKeep() & 0x02)
                tempInput.range(15, 8) = (dgmQ[i].getLE_TData()).range(15, 8);
            if (dgmQ[i].getLE_TKeep() & 0x04)
                tempInput.range(23,16) = (dgmQ[i].getLE_TData()).range(23,16);
            if (dgmQ[i].getLE_TKeep() & 0x08)
                tempInput.range(31,24) = (dgmQ[i].getLE_TData()).range(31,24);
            if (dgmQ[i].getLE_TKeep() & 0x10)
                tempInput.range(39,32) = (dgmQ[i].getLE_TData()).range(39,32);
            if (dgmQ[i].getLE_TKeep() & 0x20)
                tempInput.range(47,40) = (dgmQ[i].getLE_TData()).range(47,40);
            if (dgmQ[i].getLE_TKeep() & 0x40)
                tempInput.range(55,48) = (dgmQ[i].getLE_TData()).range(55,48);
            if (dgmQ[i].getLE_TKeep() & 0x80)
                tempInput.range(63,56) = (dgmQ[i].getLE_TData()).range(63,56);
            csum = ((((csum +
                       tempInput.range(63, 48)) + tempInput.range(47, 32)) +
                       tempInput.range(31, 16)) + tempInput.range(15,  0));
        }
        while (csum >> 16) {
            csum = (csum & 0xFFFF) + (csum >> 16);
        }
        // Reverse the bits of the result
        UdpCsum udpCsum = csum.range(15, 0);
        udpCsum = ~udpCsum;
        return byteSwap16(udpCsum);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

clone()

void SimUdpDatagram::clone ( SimUdpDatagram &  udpDgm )

inline

Clone a UDP datagram.

Parameters

[in]

udpDgm

A reference to the datagram to clone.

Definition at line 132 of file SimUdpDatagram.hpp.

                                       {
        AxisUdp newAxisUdp;
        for (int i=0; i<udpDgm.dgmQ.size(); i++) {
            newAxisUdp = udpDgm.dgmQ[i];
            this->dgmQ.push_back(newAxisUdp);
        }
        this->setLen(udpDgm.getLen());
    }

cloneHeader()

void SimUdpDatagram::cloneHeader ( SimUdpDatagram &  udpDgm )

inline

Clone the header of a UDP datagram.

Parameters

[in]

udpDgm

A reference to the datagram to clone.

Definition at line 145 of file SimUdpDatagram.hpp.

                                             {
        int cloneBytes = UDP_HEADER_LEN; // in bytes
        int inpChunkCnt = 0;
        while(cloneBytes > 0) {
            if (cloneBytes > 8) {
                this->pushChunk(udpDgm.dgmQ[inpChunkCnt]);
            }
            else {
                AxisUdp lastHdrChunk(udpDgm.dgmQ[inpChunkCnt].getLE_TData(),
                                     lenToLE_tKeep(cloneBytes), TLAST);
                this->pushChunk(lastHdrChunk);
            }
            cloneBytes -= 8;
            inpChunkCnt++;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUdpChecksum()

UdpCsum SimUdpDatagram::getUdpChecksum ( )

inline

Definition at line 186 of file SimUdpDatagram.hpp.

{ return dgmQ[0].getUdpCsum();          }

Here is the caller graph for this function:

getUdpDestinationPort()

int SimUdpDatagram::getUdpDestinationPort ( )

inline

Definition at line 180 of file SimUdpDatagram.hpp.

{ return dgmQ[0].getUdpDstPort();       }

Here is the caller graph for this function:

getUdpLength()

UdpLen SimUdpDatagram::getUdpLength ( )

inline

Definition at line 183 of file SimUdpDatagram.hpp.

{ return dgmQ[0].getUdpLen();           }

Here is the caller graph for this function:

getUdpSourcePort()

int SimUdpDatagram::getUdpSourcePort ( )

inline

Definition at line 177 of file SimUdpDatagram.hpp.

{ return dgmQ[0].getUdpSrcPort();       }

Here is the caller graph for this function:

isWellFormed()

bool SimUdpDatagram::isWellFormed ( const char *  callerName, Ip4Addr  ipSa, Ip4Addr  ipDa  )

inline

Checks if the datagram header fields are properly set.

Parameters

[in]	callerName	The name of the calling function or process.
[in]	ipSa	The IP source address.
[in]	ipDa	The IP destination address.

Returns

true if the cheksum and the length fields are valid.

Definition at line 305 of file SimUdpDatagram.hpp.

                                                                          {
        bool rc = true;
        // Assess the length field vs datagram length
        if (this->getUdpLength() !=  this->getLen()) {
            printWarn(callerName, "Malformed UDP datagram: 'Length' field does not match the length of the datagram.\n");
            printWarn(callerName, "\tFound 'Length' field=0x%4.4X, Was expecting 0x%4.4X)\n",
                      (this->getUdpLength()).to_uint(), this->getLen());
            rc = false;
        }
        // Assess the checksum is valid (or 0x0000)
        UdpCsum udpHCsum = this->getUdpChecksum();
        UdpCsum calcCsum = this->reCalculateUdpChecksum(ipSa, ipDa);
        if ((udpHCsum != 0) and (udpHCsum != calcCsum)) {
            // UDP datagram comes with an invalid checksum
            printWarn(callerName, "Malformed UDP datagram: 'Checksum' field does not match the checksum of the pseudo-packet.\n");
            printWarn(callerName, "\tFound 'Checksum' field=0x%4.4X, Was expecting 0x%4.4X)\n",
                      udpHCsum.to_uint(), calcCsum.to_ushort());
            rc = false;
        }
       return rc;
    }

Here is the call graph for this function:

length()

int SimUdpDatagram::length ( )

inline

Definition at line 119 of file SimUdpDatagram.hpp.

                 {
        return this->len;
    }

Here is the caller graph for this function:

pullChunk()

AxisUdp SimUdpDatagram::pullChunk ( )

inline

Definition at line 111 of file SimUdpDatagram.hpp.

                        {
        AxisUdp headingChunk = this->front();
        this->pop_front();
        setLen(getLen() - headingChunk.getLen());
        return headingChunk;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

pullHeader()

SimUdpDatagram SimUdpDatagram::pullHeader ( )

inline

Pull the header of this datagram.

Returns

the datagram header as a 'SimUdpDatagram'.

Definition at line 166 of file SimUdpDatagram.hpp.

                                {
        SimUdpDatagram headerAsDatagram;
        AxisUdp headerChunk = this->front();
        this->pop_front();
        setLen(getLen() - headerChunk.getLen());
        headerAsDatagram.pushChunk(headerChunk);
        return headerAsDatagram;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

pushChunk()

void SimUdpDatagram::pushChunk ( AxisUdp  udpChunk )

inline

Definition at line 101 of file SimUdpDatagram.hpp.

                                     {
        if (this->size() > 0) {
            // Always clear 'TLAST' bit of previous chunck
            this->dgmQ[this->size()-1].setLE_TLast(0);
        }
        this->push_back(udpChunk);
        this->setLen(this->getLen() + udpChunk.getLen());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reCalculateUdpChecksum()

UdpCsum SimUdpDatagram::reCalculateUdpChecksum ( Ip4Addr  ipSa, Ip4Addr  ipDa  )

inline

Recalculate the UDP checksum of a datagram.

• While re-computing the checksum, the checksum field itself is replaced with zeros.
• This will also overwrite the former UDP checksum.
• You typically use this method if the datagram was modified or when the checksum has not yet been calculated.

Returns

the computed checksum.

Definition at line 289 of file SimUdpDatagram.hpp.

                                                               {
        this->setUdpChecksum(0x0000);
        UdpCsum newUdpCsum = calculateUdpChecksum(ipSa, ipDa);
        // Overwrite the former UDP checksum
        this->setUdpChecksum(newUdpCsum);
        return (newUdpCsum);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUdpChecksum()

void SimUdpDatagram::setUdpChecksum ( UdpCsum  csum )

inline

Definition at line 185 of file SimUdpDatagram.hpp.

{        dgmQ[0].setUdpCsum(csum);      }

Here is the caller graph for this function:

setUdpDestinationPort()

void SimUdpDatagram::setUdpDestinationPort ( int  port )

inline

Definition at line 179 of file SimUdpDatagram.hpp.

{        dgmQ[0].setUdpDstPort(port);   }

Here is the caller graph for this function:

setUdpLength()

void SimUdpDatagram::setUdpLength ( UdpLen  len )

inline

Definition at line 182 of file SimUdpDatagram.hpp.

{        dgmQ[0].setUdpLen(len);        }

Here is the caller graph for this function:

setUdpSourcePort()

void SimUdpDatagram::setUdpSourcePort ( int  port )

inline

Definition at line 176 of file SimUdpDatagram.hpp.

{        dgmQ[0].setUdpSrcPort(port);   }

Here is the caller graph for this function:

size()

int SimUdpDatagram::size ( )

inline

Definition at line 124 of file SimUdpDatagram.hpp.

               {
        return this->dgmQ.size();
    }

Here is the caller graph for this function:

writeAxisUdpToFile()

bool SimUdpDatagram::writeAxisUdpToFile ( AxisUdp *  axisUdp, ofstream &  outFileStream  )

inline

Dump an AxisUdp chunk to a file.

Parameters

[in]	axisUdp	A pointer to the AxisUdp chunk to write.
[in]	outFileStream	A reference to the file stream to write.

Returns

true upon success, otherwise false.

Definition at line 333 of file SimUdpDatagram.hpp.

                                                                       {
        if (!outFileStream.is_open()) {
            printError(myName, "File is not opened.\n");
            return false;
        }
        AxisRaw axisRaw(axisUdp->getLE_TData(), axisUdp->getLE_TKeep(), axisUdp->getLE_TLast());
        bool rc = writeAxisRawToFile(axisRaw, outFileStream);
        return(rc);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writePayloadToDatFile()

bool SimUdpDatagram::writePayloadToDatFile ( ofstream &  outFileStream )

inline

Dump the payload of this datagram as AxisUdp chunks into a file.

Parameters

[in]

outFileStream

A reference to the file stream to write.

Returns

true upon success, otherwise false.

Definition at line 363 of file SimUdpDatagram.hpp.

                                                         {
        for (int i=1; i < this->size(); i++) {
            AxisUdp axisChunk = this->dgmQ[i];
            if (not this->writeAxisUdpToFile(&axisChunk, outFileStream)) {
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writeToDatFile()

bool SimUdpDatagram::writeToDatFile ( ofstream &  outFileStream )

inline

Dump this UDP datagram as raw AxisUdp chunks into a file.

Parameters

[in]

outFileStream

A reference to the file stream to write.

Returns

true upon success, otherwise false.

Definition at line 348 of file SimUdpDatagram.hpp.

                                                  {
        for (int i=0; i < this->size(); i++) {
            AxisUdp axisUdp = this->dgmQ[i];
            if (not this->writeAxisUdpToFile(&axisUdp, outFileStream)) {
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• repos_for_Dox/cFDK/SRA/LIB/SHELL/LIB/hls/NTS/SimUdpDatagram.hpp