SimIcmpPacket Class Reference

Class ICMP Packet for simulation. More...

#include <SimIcmpPacket.hpp>

Public Member Functions
	SimIcmpPacket (int pktLen)
	SimIcmpPacket ()
void	pushChunk (AxisIcmp icmpChunk)
AxisIcmp	pullChunk ()
int	length ()
int	size ()
void	setIcmpType (IcmpType type)
IcmpType	getIcmpType ()
void	setIcmpCode (IcmpCode code)
IcmpCode	getCode ()
void	setIcmpChecksum (IcmpCsum csum)
IcmpCsum	getIcmpChecksum ()
void	setIcmpIdent (IcmpIdent id)
IcmpIdent	getIcmpIdent ()
void	setIcmpSeqNum (IcmpSeqNum num)
IcmpSeqNum	getIcmpSeqNum ()
void	addIcmpPayload (string pldStr)
IcmpCsum	calculateIcmpChecksum ()
IcmpCsum	reCalculateIcmpChecksum ()
	Recalculate the ICMP checksum of a packet. More...

Detailed Description

Class ICMP Packet for simulation.

This class defines an ICMP packet as a stream of 'AxisIcmp' data chunks. Such an ICMP packet consists of a double-ended queue that is used to accumulate all these data chunks. For the 10GbE MAC, the ICMP chunks are 64 bits wide. ICMP chunks are extracted from the Ethernet frame by the IPRX core and are transmitted by the ICMP core.

Definition at line 49 of file SimIcmpPacket.hpp.

Constructor & Destructor Documentation

SimIcmpPacket() [1/2]

SimIcmpPacket::SimIcmpPacket ( int  pktLen )

inline

Definition at line 86 of file SimIcmpPacket.hpp.

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

Here is the call graph for this function:

SimIcmpPacket() [2/2]

SimIcmpPacket::SimIcmpPacket ( )

inline

Definition at line 98 of file SimIcmpPacket.hpp.

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

Member Function Documentation

addIcmpPayload()

void SimIcmpPacket::addIcmpPayload ( string  pldStr )

inline

Definition at line 148 of file SimIcmpPacket.hpp.

                                       {
        if (this->getLen() != ICMP_HEADER_LEN) {
            printFatal("IcmpPacket", "Empty packet is expected to be of length %d bytes (was found to be %d bytes).\n",
                       ICMP_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
        // ICMP 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(AxisIcmp(leQword, leKeep, leLast));
        }
    }  // End-of: addIcmpPayload

Here is the call graph for this function:

calculateIcmpChecksum()

IcmpCsum SimIcmpPacket::calculateIcmpChecksum ( )

inline

Definition at line 181 of file SimIcmpPacket.hpp.

                                     {
        ap_uint<32> csum = 0;
        for (uint8_t i=0;i<this->size();++i) {
            ap_uint<64> tempInput = 0x0000000000000000;
            if (pktQ[i].getLE_TKeep() & 0x01)
                tempInput.range(  7, 0) = (pktQ[i].getLE_TData().range( 7, 0));
            if (pktQ[i].getLE_TKeep() & 0x02)
                tempInput.range(15, 8) = (pktQ[i].getLE_TData().range(15, 8));
            if (pktQ[i].getLE_TKeep() & 0x04)
                tempInput.range(23,16) = (pktQ[i].getLE_TData().range(23,16));
            if (pktQ[i].getLE_TKeep() & 0x08)
                tempInput.range(31,24) = (pktQ[i].getLE_TData().range(31,24));
            if (pktQ[i].getLE_TKeep() & 0x10)
                tempInput.range(39,32) = (pktQ[i].getLE_TData().range(39,32));
            if (pktQ[i].getLE_TKeep() & 0x20)
                tempInput.range(47,40) = (pktQ[i].getLE_TData().range(47,40));
            if (pktQ[i].getLE_TKeep() & 0x40)
                tempInput.range(55,48) = (pktQ[i].getLE_TData().range(55,48));
            if (pktQ[i].getLE_TKeep() & 0x80)
                tempInput.range(63,56) = (pktQ[i].getLE_TData().range(63,56));
            csum = ((((csum +
                       tempInput.range(63, 48)) + tempInput.range(47, 32)) +
                       tempInput.range(31, 16)) + tempInput.range(15,  0));
            csum = (csum & 0xFFFF) + (csum >> 16);
        }
        // Reverse the bits of the result
        IcmpCsum icmpCsum = csum;
        icmpCsum = ~icmpCsum;
        return byteSwap16(icmpCsum);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCode()

IcmpCode SimIcmpPacket::getCode ( )

inline

Definition at line 133 of file SimIcmpPacket.hpp.

{ return pktQ[0].getIcmpCode();          }

Here is the caller graph for this function:

getIcmpChecksum()

IcmpCsum SimIcmpPacket::getIcmpChecksum ( )

inline

Definition at line 137 of file SimIcmpPacket.hpp.

{ return pktQ[0].getIcmpCsum();          }

Here is the caller graph for this function:

getIcmpIdent()

IcmpIdent SimIcmpPacket::getIcmpIdent ( )

inline

Definition at line 141 of file SimIcmpPacket.hpp.

{ return pktQ[0].getIcmpIdent();         }

getIcmpSeqNum()

IcmpSeqNum SimIcmpPacket::getIcmpSeqNum ( )

inline

Definition at line 145 of file SimIcmpPacket.hpp.

{ return pktQ[0].getIcmpSeqNum();        }

getIcmpType()

IcmpType SimIcmpPacket::getIcmpType ( )

inline

Definition at line 129 of file SimIcmpPacket.hpp.

{ return pktQ[0].getIcmpType();          }

Here is the caller graph for this function:

length()

int SimIcmpPacket::length ( )

inline

Definition at line 122 of file SimIcmpPacket.hpp.

{ return this->len;                               }

Here is the caller graph for this function:

pullChunk()

AxisIcmp SimIcmpPacket::pullChunk ( )

inline

Definition at line 114 of file SimIcmpPacket.hpp.

                         {
        AxisIcmp 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:

pushChunk()

void SimIcmpPacket::pushChunk ( AxisIcmp  icmpChunk )

inline

Definition at line 104 of file SimIcmpPacket.hpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

reCalculateIcmpChecksum()

IcmpCsum SimIcmpPacket::reCalculateIcmpChecksum ( )

inline

Recalculate the ICMP checksum of a packet.

• This will also overwrite the former ICMP checksum.
• You typically use this method if the packet was modified or when the checksum has not yet been calculated.

Returns

the computed checksum.

Definition at line 220 of file SimIcmpPacket.hpp.

                                       {
        this->setIcmpChecksum(0x0000);
        IcmpCsum newIcmpCsum = calculateIcmpChecksum();
        // Overwrite the former ICMP checksum
        this->setIcmpChecksum(newIcmpCsum);
        return (newIcmpCsum);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setIcmpChecksum()

void SimIcmpPacket::setIcmpChecksum ( IcmpCsum  csum )

inline

Definition at line 136 of file SimIcmpPacket.hpp.

{        pktQ[0].setIcmpCsum(csum);      }

Here is the caller graph for this function:

setIcmpCode()

void SimIcmpPacket::setIcmpCode ( IcmpCode  code )

inline

Definition at line 132 of file SimIcmpPacket.hpp.

{        pktQ[0].setIcmpCode(code);      }

Here is the caller graph for this function:

setIcmpIdent()

void SimIcmpPacket::setIcmpIdent ( IcmpIdent  id )

inline

Definition at line 140 of file SimIcmpPacket.hpp.

{        pktQ[0].setIcmpIdent(id);       }

setIcmpSeqNum()

void SimIcmpPacket::setIcmpSeqNum ( IcmpSeqNum  num )

inline

Definition at line 144 of file SimIcmpPacket.hpp.

{        pktQ[0].setIcmpSeqNum(num);     }

setIcmpType()

void SimIcmpPacket::setIcmpType ( IcmpType  type )

inline

Definition at line 128 of file SimIcmpPacket.hpp.

{        pktQ[0].setIcmpType(type);      }

Here is the caller graph for this function:

size()

int SimIcmpPacket::size ( )

inline

Definition at line 125 of file SimIcmpPacket.hpp.

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

Here is the caller 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/SimIcmpPacket.hpp