inet::serializer::ICMPSerializer Class Reference

Converts between ICMPMessage and binary (network byte order) ICMP header. More...

#include <ICMPSerializer.h>

Inheritance diagram for inet::serializer::ICMPSerializer:

Public Member Functions
	ICMPSerializer (const char *name=nullptr)
Public Member Functions inherited from inet::serializer::SerializerBase
	SerializerBase (const char *name=nullptr)
void	serializePacket (const cPacket *pkt, Buffer &b, Context &context)
cPacket *	deserializePacket (const Buffer &b, Context &context)

Protected Member Functions
virtual void	serialize (const cPacket *pkt, Buffer &b, Context &context) override
	Serializes a cPacket for transmission on the wire. More...
virtual cPacket *	deserialize (const Buffer &b, Context &context) override
	Puts a packet sniffed from the wire into an EtherFrame. More...

Additional Inherited Members
Static Public Member Functions inherited from inet::serializer::SerializerBase
static SerializerBase &	lookupSerializer (const cPacket *pkt, Context &context, ProtocolGroup group, int id)
static void	lookupAndSerialize (const cPacket *pkt, Buffer &b, Context &context, ProtocolGroup group, int id, unsigned int maxLength=(unsigned int)(-1))
static SerializerBase &	lookupDeserializer (Context &context, ProtocolGroup group, int id)
static cPacket *	lookupAndDeserialize (const Buffer &b, Context &context, ProtocolGroup group, int id, unsigned int maxLength=(unsigned int)(-1))

Detailed Description

Converts between ICMPMessage and binary (network byte order) ICMP header.

Constructor & Destructor Documentation

inet::serializer::ICMPSerializer::ICMPSerializer ( const char *  name = nullptr )

inline

: SerializerBase(name) {}

Member Function Documentation

cPacket * inet::serializer::ICMPSerializer::deserialize ( const Buffer &  b, Context &  context  )

overrideprotectedvirtual

Puts a packet sniffed from the wire into an EtherFrame.

Implements inet::serializer::SerializerBase.

{
    ASSERT(b.getPos() == 0);

    ICMPMessage *pkt = new ICMPMessage("parsed-icmp");
    uint8_t type = b.readByte();     // type
    uint8_t subcode = b.readByte();  // subcode
    b.readUint16();   // checksum

    switch (type) {
        case ICMP_ECHO_REQUEST: {
            PingPayload *pp = new PingPayload();
            pkt->setType(ICMP_ECHO_REQUEST);
            pkt->setCode(subcode);
            pkt->setByteLength(4);
            pp->setOriginatorId(b.readUint16());
            uint16_t seqno = b.readUint16();
            pp->setSeqNo(seqno);

            char name[32];
            sprintf(name, "parsed-ping%d", seqno);
            pp->setName(name);
            pkt->setName(name);

            pp->setByteLength(4 + b.getRemainingSize());
            pp->setDataArraySize(b.getRemainingSize());
            for (unsigned int i = 0; b.getRemainingSize() > 0; i++)
                pp->setData(i, b.readByte());
            pkt->encapsulate(pp);
            break;
        }

        case ICMP_ECHO_REPLY: {
            PingPayload *pp = new PingPayload();
            pkt->setType(ICMP_ECHO_REPLY);
            pkt->setCode(subcode);
            pkt->setByteLength(4);
            pp->setOriginatorId(b.readUint16());
            uint16_t seqno = b.readUint16();
            pp->setSeqNo(seqno);

            char name[32];
            sprintf(name, "parsed-ping%d-reply", seqno);
            pp->setName(name);
            pkt->setName(name);

            pp->setByteLength(4 + b.getRemainingSize());
            pp->setDataArraySize(b.getRemainingSize());
            for (unsigned int i = 0; b.getRemainingSize() > 0; i++)
                pp->setData(i, b.readByte());
            pkt->encapsulate(pp);
            break;
        }

        case ICMP_DESTINATION_UNREACHABLE: {
            pkt->setType(ICMP_DESTINATION_UNREACHABLE);
            pkt->setCode(subcode);
            b.readUint16();   // unused
            b.readUint16();   // next hop MTU
            pkt->setByteLength(8);
            Buffer s(b, b.getRemainingSize());    // save buffer error bit (encapsulated packet usually larger than ICMPPacket payload size)
            cPacket *pp = SerializerBase::lookupAndDeserialize(s, c, ETHERTYPE, ETHERTYPE_IPv4);
            b.accessNBytes(s.getPos());
            pkt->encapsulate(pp);
            pkt->setByteLength(b.getPos());
            break;
        }

        case ICMP_TIME_EXCEEDED: {
            pkt->setType(ICMP_TIME_EXCEEDED);
            pkt->setCode(subcode);
            b.readUint32();   // unused
            pkt->setByteLength(8);
            Buffer s(b, b.getRemainingSize());    // save buffer error bit (encapsulated packet usually larger than ICMPPacket payload size)
            cPacket *pp = SerializerBase::lookupAndDeserialize(s, c, ETHERTYPE, ETHERTYPE_IPv4);
            b.accessNBytes(s.getPos());
            pkt->encapsulate(pp);
            pkt->setByteLength(b.getPos());
            break;
        }

        default: {
            EV_ERROR << "Can not parse ICMP packet: type " << type << " not supported.";
            delete pkt;
            return nullptr;
        }
    }
    uint16_t cchecksum = TCPIPchecksum::checksum(b._getBuf(), b.getPos());
    if (cchecksum)
        pkt->setBitError(true);
    return pkt;
}

void inet::serializer::ICMPSerializer::serialize ( const cPacket *  pkt, Buffer &  b, Context &  context  )

overrideprotectedvirtual

Serializes a cPacket for transmission on the wire.

Returns the length of data written into buffer.

Implements inet::serializer::SerializerBase.

{
    unsigned int startpos = b.getPos();
    const ICMPMessage *pkt = check_and_cast<const ICMPMessage *>(_pkt);

    switch (pkt->getType()) {
        case ICMP_ECHO_REQUEST: {
            PingPayload *pp = check_and_cast<PingPayload *>(pkt->getEncapsulatedPacket());
            b.writeByte(ICMP_ECHO_REQUEST);
            b.writeByte(pkt->getCode());
            b.writeUint16(0);   // checksum
            b.writeUint16(pp->getOriginatorId());
            b.writeUint16(pp->getSeqNo());
            unsigned int datalen = pp->getDataArraySize();
            for (unsigned int i = 0; i < datalen; i++)
                b.writeByte(pp->getData(i));
            datalen = (pp->getByteLength() - 4) - datalen;
            b.fillNBytes(datalen, 'a');
            break;
        }

        case ICMP_ECHO_REPLY: {
            PingPayload *pp = check_and_cast<PingPayload *>(pkt->getEncapsulatedPacket());
            b.writeByte(ICMP_ECHO_REPLY);
            b.writeByte(pkt->getCode());
            b.writeUint16(0);   // checksum
            b.writeUint16(pp->getOriginatorId());
            b.writeUint16(pp->getSeqNo());
            unsigned int datalen = pp->getDataArraySize();
            for (unsigned int i = 0; i < datalen; i++)
                b.writeByte(pp->getData(i));
            datalen = (pp->getByteLength() - 4) - datalen;
            b.fillNBytes(datalen, 'a');
            break;
        }

        case ICMP_DESTINATION_UNREACHABLE: {
            b.writeByte(ICMP_DESTINATION_UNREACHABLE);
            b.writeByte(pkt->getCode());
            b.writeUint16(0);   // checksum
            b.writeUint16(0);   // unused
            b.writeUint16(0);   // next hop MTU
            Buffer s(b, b.getRemainingSize());    // save buffer error bit (encapsulated packet usually larger than ICMPPacket payload size)
            SerializerBase::lookupAndSerialize(pkt->getEncapsulatedPacket(), s, c, ETHERTYPE, ETHERTYPE_IPv4);
            b.accessNBytes(std::min((unsigned int)(pkt->getByteLength() - ICMP_MINLEN), s.getPos()));
            break;
        }

        case ICMP_TIME_EXCEEDED: {
            b.writeByte(ICMP_TIME_EXCEEDED);
            b.writeByte(ICMP_TIMXCEED_INTRANS);
            b.writeUint16(0);   // checksum
            b.writeUint32(0);   // unused
            Buffer s(b, b.getRemainingSize());    // save buffer error bit (encapsulated packet usually larger than ICMPPacket payload size)
            SerializerBase::lookupAndSerialize(pkt->getEncapsulatedPacket(), s, c, ETHERTYPE, ETHERTYPE_IPv4);
            b.accessNBytes(std::min((unsigned int)(pkt->getByteLength() - ICMP_MINLEN), s.getPos()));
            break;
        }

        default: {
            //TODO if (c.throwOnSerializerNotFound)
            throw cRuntimeError("Can not serialize ICMP packet: type %d  not supported.", pkt->getType());
        }
    }
    b.writeUint16To(startpos + 2, TCPIPchecksum::checksum(b._getBuf() + startpos, b.getPos() - startpos));
}

---

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

• ICMPSerializer.h
• ICMPSerializer.cc