inet::ICMPv6 Class Reference

ICMPv6 implementation. More...

#include <ICMPv6.h>

Inheritance diagram for inet::ICMPv6:

Public Member Functions
virtual void	sendErrorMessage (IPv6Datagram *datagram, ICMPv6Type type, int code)
	This method can be called from other modules to send an ICMPv6 error packet. More...
virtual void	sendErrorMessage (cPacket *transportPacket, IPv6ControlInfo *ctrl, ICMPv6Type type, int code)
	This method can be called from other modules to send an ICMP error packet in response to a received bogus packet from the transport layer (like UDP). More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Types
typedef std::map< long, int >	PingMap

Protected Member Functions
virtual void	sendToIP (ICMPv6Message *msg, const IPv6Address &dest)
virtual void	sendToIP (ICMPv6Message *msg)
virtual ICMPv6Message *	createDestUnreachableMsg (int code)
virtual ICMPv6Message *	createPacketTooBigMsg (int mtu)
virtual ICMPv6Message *	createTimeExceededMsg (int code)
virtual ICMPv6Message *	createParamProblemMsg (int code)
virtual void	initialize (int stage) override
	Initialization. More...
virtual int	numInitStages () const override
virtual void	handleMessage (cMessage *msg) override
	Processing of messages that arrive in this module. More...
virtual void	processICMPv6Message (ICMPv6Message *)
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual void	processEchoRequest (ICMPv6EchoRequestMsg *)
	Respond to the machine that tried to ping us. More...
virtual void	processEchoReply (ICMPv6EchoReplyMsg *)
	Forward the ping reply to the "pingOut" of this module. More...
virtual void	sendEchoRequest (PingPayload *)
	Ping a machine. More...
virtual bool	validateDatagramPromptingError (IPv6Datagram *datagram)
	Validate the received IPv6 datagram before responding with error message. More...
virtual void	errorOut (ICMPv6Message *)

Protected Attributes
PingMap	pingMap

Detailed Description

ICMPv6 implementation.

Member Typedef Documentation

typedef std::map<long, int> inet::ICMPv6::PingMap

protected

Member Function Documentation

ICMPv6Message * inet::ICMPv6::createDestUnreachableMsg ( int  code )

protectedvirtual

Referenced by sendErrorMessage().

{
    ICMPv6DestUnreachableMsg *errorMsg = new ICMPv6DestUnreachableMsg("Dest Unreachable");
    errorMsg->setType(ICMPv6_DESTINATION_UNREACHABLE);
    errorMsg->setCode(code);
    return errorMsg;
}

ICMPv6Message * inet::ICMPv6::createPacketTooBigMsg ( int  mtu )

protectedvirtual

Referenced by sendErrorMessage().

{
    ICMPv6PacketTooBigMsg *errorMsg = new ICMPv6PacketTooBigMsg("Packet Too Big");
    errorMsg->setType(ICMPv6_PACKET_TOO_BIG);
    errorMsg->setCode(0);    //Set to 0 by sender and ignored by receiver.
    errorMsg->setMTU(mtu);
    return errorMsg;
}

ICMPv6Message * inet::ICMPv6::createParamProblemMsg ( int  code )

protectedvirtual

Referenced by sendErrorMessage().

{
    ICMPv6ParamProblemMsg *errorMsg = new ICMPv6ParamProblemMsg("Parameter Problem");
    errorMsg->setType(ICMPv6_PARAMETER_PROBLEM);
    errorMsg->setCode(code);
    //TODO: What Pointer? section 3.4
    return errorMsg;
}

ICMPv6Message * inet::ICMPv6::createTimeExceededMsg ( int  code )

protectedvirtual

Referenced by sendErrorMessage().

{
    ICMPv6TimeExceededMsg *errorMsg = new ICMPv6TimeExceededMsg("Time Exceeded");
    errorMsg->setType(ICMPv6_TIME_EXCEEDED);
    errorMsg->setCode(code);
    return errorMsg;
}

void inet::ICMPv6::errorOut ( ICMPv6Message *  icmpv6msg )

protectedvirtual

Referenced by processICMPv6Message().

{
    send(icmpv6msg, "errorOut");
}

void inet::ICMPv6::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

Processing of messages that arrive in this module.

Messages arrived here could be for ICMP ping requests or ICMPv6 messages that require processing.

{
    ASSERT(!msg->isSelfMessage());    // no timers in ICMPv6

    // process arriving ICMP message
    if (msg->getArrivalGate()->isName("ipv6In")) {
        EV_INFO << "Processing ICMPv6 message.\n";
        processICMPv6Message(check_and_cast<ICMPv6Message *>(msg));
        return;
    }

    // request from application
    if (msg->getArrivalGate()->isName("pingIn")) {
        sendEchoRequest(check_and_cast<PingPayload *>(msg));
        return;
    }
}

bool inet::ICMPv6::handleOperationStage ( LifecycleOperation *  operation, int  stage, IDoneCallback *  doneCallback  )

overrideprotectedvirtual

Perform one stage of a lifecycle operation.

Processing may be done entirely within this method, or may be a longer process that involves nonzero simulation time or several events, and is triggered by this method call.

Return value: true = "done"; false = "not yet done, will invoke doneCallback when done"

Implements inet::ILifecycle.

{
    //pingMap.clear();
    throw cRuntimeError("Lifecycle operation support not implemented");
}

void inet::ICMPv6::initialize ( int  stage )

overrideprotectedvirtual

Initialization.

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_NETWORK_LAYER) {
        bool isOperational;
        NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        isOperational = (!nodeStatus) || nodeStatus->getState() == NodeStatus::UP;
        if (!isOperational)
            throw cRuntimeError("This module doesn't support starting in node DOWN state");
    }
    if (stage == INITSTAGE_NETWORK_LAYER_2) {
        IPSocket socket(gate("ipv6Out"));
        socket.registerProtocol(IP_PROT_IPv6_ICMP);
    }
}

virtual int inet::ICMPv6::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::ICMPv6::processEchoReply ( ICMPv6EchoReplyMsg *  reply )

protectedvirtual

Forward the ping reply to the "pingOut" of this module.

Referenced by processICMPv6Message().

{
    IPv6ControlInfo *ctrl = check_and_cast<IPv6ControlInfo *>(reply->removeControlInfo());
    PingPayload *payload = check_and_cast<PingPayload *>(reply->decapsulate());
    payload->setControlInfo(ctrl);
    delete reply;
    long originatorId = payload->getOriginatorId();
    auto i = pingMap.find(originatorId);
    if (i != pingMap.end())
        send(payload, "pingOut", i->second);
    else {
        EV_WARN << "Received ECHO REPLY has an unknown originator ID: " << originatorId << ", packet dropped." << endl;
        delete payload;
    }
}

void inet::ICMPv6::processEchoRequest ( ICMPv6EchoRequestMsg *  request )

protectedvirtual

Respond to the machine that tried to ping us.

Referenced by processICMPv6Message().

{
    //Create an ICMPv6 Reply Message
    ICMPv6EchoReplyMsg *reply = new ICMPv6EchoReplyMsg("Echo Reply");
    reply->setName((std::string(request->getName()) + "-reply").c_str());
    reply->setType(ICMPv6_ECHO_REPLY);
    reply->encapsulate(request->decapsulate());

    IPv6ControlInfo *ctrl = check_and_cast<IPv6ControlInfo *>(request->getControlInfo());
    IPv6ControlInfo *replyCtrl = new IPv6ControlInfo();
    replyCtrl->setProtocol(IP_PROT_IPv6_ICMP);
    replyCtrl->setDestAddr(ctrl->getSrcAddr());

    if (ctrl->getDestAddr().isMulticast()    /*TODO check for anycast too*/) {
        IInterfaceTable *it = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        IPv6InterfaceData *ipv6Data = it->getInterfaceById(ctrl->getInterfaceId())->ipv6Data();
        replyCtrl->setSrcAddr(ipv6Data->getPreferredAddress());
        // TODO implement default address selection properly.
        //      According to RFC 3484, the source address to be used
        //      depends on the destination address
    }
    else
        replyCtrl->setSrcAddr(ctrl->getDestAddr());

    reply->setControlInfo(replyCtrl);

    delete request;
    sendToIP(reply);
}

void inet::ICMPv6::processICMPv6Message ( ICMPv6Message *  icmpv6msg )

protectedvirtual

Referenced by handleMessage(), and sendErrorMessage().

{
    ASSERT(dynamic_cast<ICMPv6Message *>(icmpv6msg));
    if (dynamic_cast<ICMPv6DestUnreachableMsg *>(icmpv6msg)) {
        EV_INFO << "ICMPv6 Destination Unreachable Message Received." << endl;
        errorOut(icmpv6msg);
    }
    else if (dynamic_cast<ICMPv6PacketTooBigMsg *>(icmpv6msg)) {
        EV_INFO << "ICMPv6 Packet Too Big Message Received." << endl;
        errorOut(icmpv6msg);
    }
    else if (dynamic_cast<ICMPv6TimeExceededMsg *>(icmpv6msg)) {
        EV_INFO << "ICMPv6 Time Exceeded Message Received." << endl;
        errorOut(icmpv6msg);
    }
    else if (dynamic_cast<ICMPv6ParamProblemMsg *>(icmpv6msg)) {
        EV_INFO << "ICMPv6 Parameter Problem Message Received." << endl;
        errorOut(icmpv6msg);
    }
    else if (dynamic_cast<ICMPv6EchoRequestMsg *>(icmpv6msg)) {
        EV_INFO << "ICMPv6 Echo Request Message Received." << endl;
        processEchoRequest((ICMPv6EchoRequestMsg *)icmpv6msg);
    }
    else if (dynamic_cast<ICMPv6EchoReplyMsg *>(icmpv6msg)) {
        EV_INFO << "ICMPv6 Echo Reply Message Received." << endl;
        processEchoReply((ICMPv6EchoReplyMsg *)icmpv6msg);
    }
    else
        throw cRuntimeError("Unknown message type received: (%s)%s.\n", icmpv6msg->getClassName(),icmpv6msg->getName());
}

void inet::ICMPv6::sendEchoRequest ( PingPayload *  msg )

protectedvirtual

Ping a machine.

The information needed to do this is in the cMessage parameter. TODO where in cMessage? document!!!

Referenced by handleMessage().

{
    cGate *arrivalGate = msg->getArrivalGate();
    int i = arrivalGate->getIndex();
    pingMap[msg->getOriginatorId()] = i;

    IPv6ControlInfo *ctrl = check_and_cast<IPv6ControlInfo *>(msg->removeControlInfo());
    ctrl->setProtocol(IP_PROT_IPv6_ICMP);
    ICMPv6EchoRequestMsg *request = new ICMPv6EchoRequestMsg(msg->getName());
    request->setType(ICMPv6_ECHO_REQUEST);
    request->encapsulate(msg);
    request->setControlInfo(ctrl);
    sendToIP(request);
}

void inet::ICMPv6::sendErrorMessage ( IPv6Datagram *  datagram, ICMPv6Type  type, int  code  )

virtual

This method can be called from other modules to send an ICMPv6 error packet.

RFC 2463, Section 3: ICMPv6 Error Messages There are a total of 4 ICMPv6 error messages as described in the RFC. This method will construct and send error messages corresponding to the given type. Error Types:

• Destination Unreachable Message - 1
• Packet Too Big Message - 2
• Time Exceeded Message - 3
• Parameter Problem Message - 4 Code Types have different semantics for each error type. See RFC 2463.

Referenced by inet::IPv6FragBuf::addFragment(), inet::IPv6NeighbourDiscovery::dropQueuedPacketsAwaitingAR(), inet::IPv6NeighbourDiscovery::processIPv6Datagram(), inet::UDP::processUndeliverablePacket(), inet::IPv6FragBuf::purgeStaleFragments(), and sendErrorMessage().

{
    Enter_Method("sendErrorMessage(datagram, type=%d, code=%d)", type, code);

    // get ownership
    take(origDatagram);

    if (!validateDatagramPromptingError(origDatagram))
        return;

    ICMPv6Message *errorMsg;

    if (type == ICMPv6_DESTINATION_UNREACHABLE)
        errorMsg = createDestUnreachableMsg(code);
    //TODO: implement MTU support.
    else if (type == ICMPv6_PACKET_TOO_BIG)
        errorMsg = createPacketTooBigMsg(0);
    else if (type == ICMPv6_TIME_EXCEEDED)
        errorMsg = createTimeExceededMsg(code);
    else if (type == ICMPv6_PARAMETER_PROBLEM)
        errorMsg = createParamProblemMsg(code);
    else
        throw cRuntimeError("Unknown ICMPv6 error type: %d\n", type);

    // Encapsulate the original datagram, but the whole ICMPv6 error
    // packet cannot be larger than the minimum IPv6 MTU (RFC 4443 2.4. (c)).
    // NOTE: since we just overwrite the errorMsg length without actually
    // truncating origDatagram, one can get "packet length became negative"
    // error when decapsulating the origDatagram on the receiver side.
    // A workaround is to avoid decapsulation, or to manually set the
    // errorMessage length to be larger than the encapsulated message.
    errorMsg->encapsulate(origDatagram);
    if (errorMsg->getByteLength() + IPv6_HEADER_BYTES > IPv6_MIN_MTU)
        errorMsg->setByteLength(IPv6_MIN_MTU - IPv6_HEADER_BYTES);

    // debugging information
    EV_DEBUG << "sending ICMP error: (" << errorMsg->getClassName() << ")" << errorMsg->getName()
             << " type=" << type << " code=" << code << endl;

    // if srcAddr is not filled in, we're still in the src node, so we just
    // process the ICMP message locally, right away
    if (origDatagram->getSrcAddress().isUnspecified()) {
        // pretend it came from the IP layer
        IPv6ControlInfo *ctrlInfo = new IPv6ControlInfo();
        ctrlInfo->setSrcAddr(IPv6Address::LOOPBACK_ADDRESS);    // FIXME maybe use configured loopback address
        ctrlInfo->setProtocol(IP_PROT_ICMP);
        errorMsg->setControlInfo(ctrlInfo);

        // then process it locally
        processICMPv6Message(errorMsg);
    }
    else {
        sendToIP(errorMsg, origDatagram->getSrcAddress());
    }
}

void inet::ICMPv6::sendErrorMessage ( cPacket *  transportPacket, IPv6ControlInfo *  ctrl, ICMPv6Type  type, int  code  )

virtual

This method can be called from other modules to send an ICMP error packet in response to a received bogus packet from the transport layer (like UDP).

The ICMP error packet needs to include (part of) the original IP datagram, so this function will wrap back the transport packet into the IP datagram based on its IPv4ControlInfo.

{
    Enter_Method("sendErrorMessage(transportPacket, ctrl, type=%d, code=%d)", type, code);

    IPv6Datagram *datagram = ctrl->removeOrigDatagram();
    delete ctrl;
    take(transportPacket);
    take(datagram);
    datagram->encapsulate(transportPacket);
    sendErrorMessage(datagram, type, code);
}

void inet::ICMPv6::sendToIP ( ICMPv6Message *  msg, const IPv6Address &  dest  )

protectedvirtual

Referenced by processEchoRequest(), sendEchoRequest(), and sendErrorMessage().

{
    IPv6ControlInfo *ctrlInfo = new IPv6ControlInfo();
    ctrlInfo->setDestAddr(dest);
    ctrlInfo->setProtocol(IP_PROT_IPv6_ICMP);
    msg->setControlInfo(ctrlInfo);

    send(msg, "ipv6Out");
}

void inet::ICMPv6::sendToIP ( ICMPv6Message *  msg )

protectedvirtual

{
    // assumes IPv6ControlInfo is already attached
    send(msg, "ipv6Out");
}

bool inet::ICMPv6::validateDatagramPromptingError ( IPv6Datagram *  datagram )

protectedvirtual

Validate the received IPv6 datagram before responding with error message.

Referenced by sendErrorMessage().

{
    // don't send ICMP error messages for multicast messages
    if (origDatagram->getDestAddress().isMulticast()) {
        EV_INFO << "won't send ICMP error messages for multicast message " << origDatagram << endl;
        delete origDatagram;
        return false;
    }

    // do not reply with error message to error message
    if (origDatagram->getTransportProtocol() == IP_PROT_IPv6_ICMP) {
        ICMPv6Message *recICMPMsg = check_and_cast<ICMPv6Message *>(origDatagram->getEncapsulatedPacket());
        if (recICMPMsg->getType() < 128) {
            EV_INFO << "ICMP error received -- do not reply to it" << endl;
            delete origDatagram;
            return false;
        }
    }
    return true;
}

Member Data Documentation

PingMap inet::ICMPv6::pingMap

protected

Referenced by processEchoReply(), and sendEchoRequest().

---

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

• ICMPv6.h
• ICMPv6.cc