Icmp: remove inputInterfaceId parameter, read InterfaceInd from packet

Remove the inputInterfaceId parameter from Icmp::sendErrorMessage,
Icmp::maySendErrorMessage, Ipv4::sendIcmpError, and Icmpv4SendErrorReq.
The input interface ID is now read directly from the InterfaceInd tag
on the original packet, which is always present on network-received
packets. This eliminates redundant parameter passing and the -1/TODO
placeholders in callers.

Author: ZoltanBojthe

src/inet/networklayer/common/IcmpErrorTag.msg

@@ -47,7 +47,6 @@ class Icmpv4SendErrorReq extends TagBase
 {
     IcmpType type;          // ICMPv4 type (e.g. ICMP_DESTINATION_UNREACHABLE)
     int code;               // ICMPv4 code (e.g. ICMP_DU_PORT_UNREACHABLE)
-    int inputInterfaceId = -1;
     Packet *originalPacket @owned;  // the packet that triggered the error
 }
 

src/inet/networklayer/ipv4/Icmp.cc

@@ -79,7 +79,7 @@ void Icmp::handleMessage(cMessage *msg)
             auto origPacket = tag->getOriginalPacketForUpdate();
             // restore the original network datagram (IP header + transport payload)
             origPacket->setFrontOffset(origPacket->getTag<NetworkProtocolInd>()->getNetworkHeaderFrontOffset());
-            sendErrorMessage(origPacket, tag->getInputInterfaceId(), tag->getType(), static_cast<IcmpCode>(tag->getCode()));
+            sendErrorMessage(origPacket, tag->getType(), static_cast<IcmpCode>(tag->getCode()));
         }
         else {
             throw cRuntimeError("Unknown Request arrived on transportIn: %s", request->getName());
@@ -91,12 +91,15 @@ void Icmp::handleMessage(cMessage *msg)
         throw cRuntimeError("Message %s(%s) arrived in unknown '%s' gate", msg->getName(), msg->getClassName(), msg->getArrivalGate()->getName());
 }
 
-bool Icmp::maySendErrorMessage(Packet *packet, int inputInterfaceId)
+bool Icmp::maySendErrorMessage(Packet *packet)
 {
     const auto& ipv4Header = packet->peekAtFront<Ipv4Header>();
     Ipv4Address origSrcAddr = ipv4Header->getSrcAddress();
     Ipv4Address origDestAddr = ipv4Header->getDestAddress();
 
+    auto& interfaceInd = packet->findTag<InterfaceInd>();
+    int inputInterfaceId = interfaceInd ? interfaceInd->getInterfaceId() : -1;
+
     // don't send ICMP error messages in response to broadcast or multicast messages
     if (origDestAddr.isMulticast() || origDestAddr.isLimitedBroadcastAddress() || possiblyLocalBroadcast(origDestAddr, inputInterfaceId)) {
         EV_DETAIL << "won't send ICMP error messages for broadcast/multicast message " << ipv4Header << endl;
@@ -152,7 +155,7 @@ void Icmp::sendPtbMessage(Packet *packet, int mtu)
 {
     Enter_Method("sendPtbMessage(datagram, mtu=%d)", mtu);
 
-    if (maySendErrorMessage(packet, -1)) {
+    if (maySendErrorMessage(packet)) {
         // assemble a message name
         char msgname[80];
         snprintf(msgname, sizeof(msgname), "ICMP-PTB-#%" PRIu64 "-mtu%d", ++ctr, mtu);
@@ -176,11 +179,11 @@ void Icmp::sendPtbMessage(Packet *packet, int mtu)
     }
 }
 
-void Icmp::sendErrorMessage(Packet *packet, int inputInterfaceId, IcmpType type, IcmpCode code)
+void Icmp::sendErrorMessage(Packet *packet, IcmpType type, IcmpCode code)
 {
     Enter_Method("sendErrorMessage(datagram, type=%d, code=%d)", type, code);
 
-    if (maySendErrorMessage(packet, inputInterfaceId)) {
+    if (maySendErrorMessage(packet)) {
         // assemble a message name
         char msgname[80];
         snprintf(msgname, sizeof(msgname), "ICMP-error-#%" PRIu64 "-type%d-code%d", ++ctr, type, code);

src/inet/networklayer/ipv4/Icmp.h

@@ -50,9 +50,8 @@ class INET_API Icmp : public SimpleModule, public DefaultProtocolRegistrationLis
      * This method can be called from other modules to send an ICMP error packet
      * in response to a received bogus packet. It will not send ICMP error in response
      * to broadcast or multicast packets -- in that case it will simply delete the packet.
-     * KLUDGE if inputInterfaceId cannot be determined, pass in -1.
      */
-    virtual void sendErrorMessage(Packet *packet, int inputInterfaceId, IcmpType type, IcmpCode code);
+    virtual void sendErrorMessage(Packet *packet, IcmpType type, IcmpCode code);
     virtual void sendPtbMessage(Packet *packet, int mtu);
     static void insertChecksum(ChecksumMode checksumMode, const Ptr<IcmpHeader>& icmpHeader, Packet *payload);
     void insertChecksum(const Ptr<IcmpHeader>& icmpHeader, Packet *payload) { insertChecksum(checksumMode, icmpHeader, payload); }
@@ -64,7 +63,7 @@ class INET_API Icmp : public SimpleModule, public DefaultProtocolRegistrationLis
     virtual void handleMessage(cMessage *msg) override;
     virtual void handleParameterChange(const char *name) override;
     virtual void parseQuoteLengthParameter();
-    virtual bool maySendErrorMessage(Packet *packet, int inputInterfaceId);
+    virtual bool maySendErrorMessage(Packet *packet);
     virtual void sendOrProcessIcmpPacket(Packet *packet, Ipv4Address origSrcAddr);
 };
 

src/inet/networklayer/ipv4/Ipv4.cc

@@ -264,7 +264,7 @@ Ipv4Address Ipv4::getNextHop(Packet *packet)
 void Ipv4::handleIncomingDatagram(Packet *packet)
 {
     ASSERT(packet);
-    int interfaceId = packet->getTag<InterfaceInd>()->getInterfaceId();
+    ASSERT(packet->getTag<InterfaceInd>());
     emit(packetReceivedFromLowerSignal, packet);
 
     //
@@ -286,7 +286,7 @@ void Ipv4::handleIncomingDatagram(Packet *packet)
 
     if (ipv4Header->getTotalLengthField() > packet->getDataLength()) {
         EV_WARN << "length error found, sending ICMP_PARAMETER_PROBLEM\n";
-        sendIcmpError(packet, interfaceId, ICMP_PARAMETER_PROBLEM, 0);
+        sendIcmpError(packet, ICMP_PARAMETER_PROBLEM, 0);
         return;
     }
 
@@ -302,7 +302,7 @@ void Ipv4::handleIncomingDatagram(Packet *packet)
         double relativeHeaderLength = ipv4Header->getHeaderLength().get<B>() / (double)ipv4Header->getChunkLength().get<B>();
         if (dblrand() <= relativeHeaderLength) {
             EV_WARN << "bit error found, sending ICMP_PARAMETER_PROBLEM\n";
-            sendIcmpError(packet, interfaceId, ICMP_PARAMETER_PROBLEM, 0);
+            sendIcmpError(packet, ICMP_PARAMETER_PROBLEM, 0);
             return;
         }
     }
@@ -656,7 +656,7 @@ void Ipv4::routeUnicastPacket(Packet *packet)
         PacketDropDetails details;
         details.setReason(NO_ROUTE_FOUND);
         emit(packetDroppedSignal, packet, &details);
-        sendIcmpError(packet, fromIE ? fromIE->getInterfaceId() : -1, ICMP_DESTINATION_UNREACHABLE, 0);
+        sendIcmpError(packet, ICMP_DESTINATION_UNREACHABLE, 0);
     }
     else { // fragment and send
         if (fromIE != nullptr) {
@@ -883,9 +883,7 @@ void Ipv4::reassembleAndDeliverFinish(Packet *packet)
     else {
         EV_ERROR << "Transport protocol '" << protocol->getName() << "' not connected, discarding packet\n";
         packet->setFrontOffset(ipv4HeaderPosition);
-        // get source interface:
-        const auto& tag = packet->findTag<InterfaceInd>();
-        sendIcmpError(packet, tag ? tag->getInterfaceId() : -1, ICMP_DESTINATION_UNREACHABLE, ICMP_DU_PROTOCOL_UNREACHABLE);
+        sendIcmpError(packet, ICMP_DESTINATION_UNREACHABLE, ICMP_DU_PROTOCOL_UNREACHABLE);
     }
 }
 
@@ -944,7 +942,7 @@ void Ipv4::fragmentAndSend(Packet *packet)
         details.setReason(HOP_LIMIT_REACHED);
         emit(packetDroppedSignal, packet, &details);
         EV_WARN << "datagram TTL reached zero, sending ICMP_TIME_EXCEEDED\n";
-        sendIcmpError(packet, -1 /*TODO*/, ICMP_TIME_EXCEEDED, 0);
+        sendIcmpError(packet, ICMP_TIME_EXCEEDED, 0);
         numDropped++;
         return;
     }
@@ -1485,9 +1483,9 @@ void Ipv4::receiveSignal(cComponent *source, simsignal_t signalID, cObject *obj,
     }
 }
 
-void Ipv4::sendIcmpError(Packet *origPacket, int inputInterfaceId, IcmpType type, IcmpCode code)
+void Ipv4::sendIcmpError(Packet *origPacket, IcmpType type, IcmpCode code)
 {
-    icmp->sendErrorMessage(origPacket, inputInterfaceId, type, code);
+    icmp->sendErrorMessage(origPacket, type, code);
     delete origPacket;
 }
 

src/inet/networklayer/ipv4/Ipv4.h

@@ -210,7 +210,7 @@ class INET_API Ipv4 : public OperationalBase, public NetfilterBase, public INetw
 
     virtual void sendPacketToNIC(Packet *packet);
 
-    virtual void sendIcmpError(Packet *packet, int inputInterfaceId, IcmpType type, IcmpCode code);
+    virtual void sendIcmpError(Packet *packet, IcmpType type, IcmpCode code);
 
     virtual Packet *prepareForForwarding(Packet *packet) const;
 

src/inet/networklayer/ipv4/Ipv4FragBuf.cc

@@ -113,7 +113,7 @@ void Ipv4FragBuf::purgeStaleFragments(Icmp *icmpModule, simtime_t lastupdate)
             // packet, resulting in "length became negative" error. Use getEncapsulatedPacket().
             EV_WARN << "datagram fragment timed out in reassembly buffer, sending ICMP_TIME_EXCEEDED\n";
             if (buf.packet != nullptr) {
-                icmpModule->sendErrorMessage(buf.packet, -1 /*TODO*/, ICMP_TIME_EXCEEDED, 0);
+                icmpModule->sendErrorMessage(buf.packet, ICMP_TIME_EXCEEDED, 0);
                 delete buf.packet;
             }
 

src/inet/transportlayer/udp/Udp.cc

@@ -1094,14 +1094,11 @@ void Udp::processUndeliverablePacket(Packet *udpPacket)
                 udpPacket->getClassName(), udpPacket->getName());
     }
 
-    auto inIe = udpPacket->getTag<InterfaceInd>()->getInterfaceId();
-
     if (protocol->getId() == Protocol::ipv4.getId()) {
         auto request = new Request("ICMP_send_error");
         auto& tag = request->addTag<Icmpv4SendErrorReq>();
         tag->setType(ICMP_DESTINATION_UNREACHABLE);
         tag->setCode(ICMP_DU_PORT_UNREACHABLE);
-        tag->setInputInterfaceId(inIe);
         tag->setOriginalPacket(udpPacket);
         request->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::icmpv4);
         send(request, "ipOut");