Bgp: rename identifiers to the INET naming convention

Cosmetic, behavior-preserving cleanup; all 8 bgpv4 fingerprints unchanged.

- Acronyms in method names take only a leading capital (Tcp/Bgp/Ip/Fsm/Id):
  openTCPConnectionToPeer -> openTcpConnectionToPeer, processMessageFromTCP ->
  processMessageFromTcp, getBGPRoutingTable -> getBgpRoutingTable,
  deleteBGPRoutingEntry -> deleteBgpRoutingEntry, getIPRoutingTable ->
  getIpRoutingTable, getFSM -> getFsm, getSessionID -> getSessionId.
- BgpHeader.msg fields BGPIdentifier -> bgpIdentifier and NLRI -> nlri (and the
  accessors/locals they drive: getBgpIdentifier, getNlri, ...).
- The get-prefixed forwarders in BgpRouter that are not getters become plain
  forwarders: getScheduleAt/getCancelEvent/getCancelAndDelete ->
  scheduleAt/cancelEvent/cancelAndDelete.

"AS" (autonomous system) is deliberately left uppercase (getMyAS, getASCount,
isInASList, the myAS field, ...) -- folding it to "As" reads worse than the
acronym. The shared getIPAddress() network-layer API is out of scope (not
BGP-owned; called from ~40 files across other protocols).

Author: avarga

src/inet/routing/bgpv4/Bgp.cc

@@ -79,7 +79,7 @@ void Bgp::handleMessageWhenUp(cMessage *msg)
         else if (msg->isSelfMessage()) // BGP level
             handleTimer(msg);
         else if (!strcmp(msg->getArrivalGate()->getName(), "socketIn")) // TCP level
-            bgpRouter->processMessageFromTCP(msg);
+            bgpRouter->processMessageFromTcp(msg);
         else
             delete msg;
     }
@@ -163,22 +163,22 @@ void Bgp::handleTimer(cMessage *timer)
         switch (timer->getKind()) {
             case START_EVENT_KIND:
                 EV_INFO << "Processing Start Event" << std::endl;
-                pSession->getFSM()->ManualStart();
+                pSession->getFsm()->ManualStart();
                 break;
 
             case CONNECT_RETRY_KIND:
                 EV_INFO << "Expiring Connect Retry Timer" << std::endl;
-                pSession->getFSM()->ConnectRetryTimer_Expires();
+                pSession->getFsm()->ConnectRetryTimer_Expires();
                 break;
 
             case HOLD_TIME_KIND:
                 EV_INFO << "Expiring Hold Timer" << std::endl;
-                pSession->getFSM()->HoldTimer_Expires();
+                pSession->getFsm()->HoldTimer_Expires();
                 break;
 
             case KEEP_ALIVE_KIND:
                 EV_INFO << "Expiring Keep Alive timer" << std::endl;
-                pSession->getFSM()->KeepaliveTimer_Expires();
+                pSession->getFsm()->KeepaliveTimer_Expires();
                 break;
 
             default:

src/inet/routing/bgpv4/BgpFsm.cc

@@ -36,7 +36,7 @@ void Idle::ManualStart()
     // - listens for a connection that may be initiated by the remote BGP peer,
     session.listenConnectionFromPeer();
     // - initiates a TCP connection to the other BGP peer and,
-    session.openTCPConnectionToPeer();
+    session.openTcpConnectionToPeer();
     // - changes its state to Connect.
     setState<Connect>();
 }
@@ -53,7 +53,7 @@ void Connect::ConnectRetryTimer_Expires()
     session.stopConnectRetryTimer();
     // - initiates a TCP connection to the other BGP peer,
 //    session._info.socket->renewSocket();
-    session.openTCPConnectionToPeer();
+    session.openTcpConnectionToPeer();
     // - continues to listen for a connection that may be initiated by the remote BGP peer, and
     // - stays in the Connect state.
     setState<Connect>();
@@ -136,7 +136,7 @@ void Active::ConnectRetryTimer_Expires()
     session.stopConnectRetryTimer();
     // - initiates a TCP connection to the other BGP peer,T);
 //    session._info.socket->renewSocket();
-    session.openTCPConnectionToPeer();
+    session.openTcpConnectionToPeer();
     // - continues to listen for a TCP connection that may be initiated by a remote BGP peer, and
     // - changes its state to Connect.
     setState<Connect>();
@@ -412,7 +412,7 @@ void Established::entry()
     // if it's an IGP Session, send update message with only the BGP routes learned by EGP
 
     if (session.getType() == EGP) {
-        auto IPRoutingTable = session.getIPRoutingTable();
+        auto IPRoutingTable = session.getIpRoutingTable();
         for (int i = 0; i < IPRoutingTable->getNumRoutes(); i++) {
             const Ipv4Route *rtEntry = IPRoutingTable->getRoute(i);
             if (session.isRouteExcluded(*rtEntry))
@@ -424,7 +424,7 @@ void Established::entry()
         }
     }
 
-    for (auto& elem : session.getBGPRoutingTable())
+    for (auto& elem : session.getBgpRoutingTable())
         session.updateSendProcess(elem);
 
     // when all EGP Sessions are in established state, start IGP Session(s)

src/inet/routing/bgpv4/BgpRouter.cc

@@ -287,7 +287,7 @@ void BgpRouter::setRedistributeOspf(std::string str)
     }
 }
 
-void BgpRouter::processMessageFromTCP(cMessage *msg)
+void BgpRouter::processMessageFromTcp(cMessage *msg)
 {
     TcpSocket *socket = check_and_cast_nullable<TcpSocket *>(_socketMap.findSocketFor(msg));
     if (!socket) {
@@ -340,7 +340,7 @@ void BgpRouter::processMessageFromTCP(cMessage *msg)
 void BgpRouter::listenConnectionFromPeer(SessionId sessionID)
 {
     // Ensure the single shared listening socket is up. One wildcard listener per router
-    // accepts all incoming BGP connections on TCP_PORT; processMessageFromTCP() demuxes
+    // accepts all incoming BGP connections on TCP_PORT; processMessageFromTcp() demuxes
     // accepted connections to the right session by peer address. This replaces the former
     // per-session listeners, which collided on the shared wildcard port when several
     // sessions reconnected at once (see plan §4 Phase 0 result).
@@ -364,7 +364,7 @@ void BgpRouter::listenConnectionFromPeer(SessionId sessionID)
     }
 }
 
-void BgpRouter::openTCPConnectionToPeer(SessionId sessionID)
+void BgpRouter::openTcpConnectionToPeer(SessionId sessionID)
 {
     EV_DEBUG << "Opening a TCP connection to "
              << _BGPSessions[sessionID]->getPeerAddr()
@@ -423,10 +423,10 @@ void BgpRouter::socketEstablished(TcpSocket *socket)
     if (_BGPSessions[_currSessionId]->getType() == IGP &&
         this->findNextSession(EGP) != static_cast<SessionId>(-1))
     {
-        _BGPSessions[_currSessionId]->getFSM()->TcpConnectionFails();
+        _BGPSessions[_currSessionId]->getFsm()->TcpConnectionFails();
     }
     else {
-        _BGPSessions[_currSessionId]->getFSM()->TcpConnectionConfirmed();
+        _BGPSessions[_currSessionId]->getFsm()->TcpConnectionConfirmed();
     }
     // Note: the shared listening socket is intentionally left listening (it is not a
     // per-session resource and must stay up to accept connections for other sessions).
@@ -437,7 +437,7 @@ void BgpRouter::socketFailure(TcpSocket *socket, int code)
     int connId = socket->getSocketId();
     _currSessionId = findIdFromSocketConnId(_BGPSessions, connId);
     if (_currSessionId != static_cast<SessionId>(-1)) {
-        _BGPSessions[_currSessionId]->getFSM()->TcpConnectionFails();
+        _BGPSessions[_currSessionId]->getFsm()->TcpConnectionFails();
     }
 }
 
@@ -447,7 +447,7 @@ void BgpRouter::socketPeerClosed(TcpSocket *socket)
     int connId = socket->getSocketId();
     _currSessionId = findIdFromSocketConnId(_BGPSessions, connId);
     if (_currSessionId != static_cast<SessionId>(-1))
-        _BGPSessions[_currSessionId]->getFSM()->TcpConnectionFails();
+        _BGPSessions[_currSessionId]->getFsm()->TcpConnectionFails();
 }
 
 void BgpRouter::socketDataArrived(TcpSocket *socket)
@@ -495,7 +495,7 @@ void BgpRouter::processMessage(const BgpOpenMessage& msg)
             << session->getPeerAddr().str(false)
             << " with contents: \n";
     printOpenMessage(msg);
-    session->getFSM()->OpenMsgEvent();
+    session->getFsm()->OpenMsgEvent();
 }
 
 void BgpRouter::processMessage(const BgpKeepAliveMessage& msg)
@@ -505,7 +505,7 @@ void BgpRouter::processMessage(const BgpKeepAliveMessage& msg)
             << session->getPeerAddr().str(false)
             << " with contents: \n";
     printKeepAliveMessage(msg);
-    session->getFSM()->KeepAliveMsgEvent();
+    session->getFsm()->KeepAliveMsgEvent();
 }
 
 void BgpRouter::processMessage(const BgpUpdateMessage& msg)
@@ -515,14 +515,14 @@ void BgpRouter::processMessage(const BgpUpdateMessage& msg)
             << session->getPeerAddr().str(false)
             << " with contents: \n";
     printUpdateMessage(msg);
-    session->getFSM()->UpdateMsgEvent();
+    session->getFsm()->UpdateMsgEvent();
 
     BgpRoutingTableEntry *entry = new BgpRoutingTableEntry();
     entry->setLocalPreference(bgpModule->par("localPreference").intValue());
-    entry->setDestination(msg.getNLRI(0).prefix);
+    entry->setDestination(msg.getNlri(0).prefix);
 
     Ipv4Address netMask(Ipv4Address::ALLONES_ADDRESS);
-    netMask = Ipv4Address::makeNetmask(msg.getNLRI(0).length);
+    netMask = Ipv4Address::makeNetmask(msg.getNlri(0).length);
     entry->setNetmask(netMask);
 
     for (size_t i = 0; i < msg.getPathAttributesArraySize(); i++) {
@@ -688,22 +688,22 @@ BgpProcessResult BgpRouter::decisionProcess(const BgpUpdateMessage& msg, BgpRout
 bool BgpRouter::tieBreakingProcess(BgpRoutingTableEntry *oldEntry, BgpRoutingTableEntry *entry)
 {
     if (entry->getLocalPreference() > oldEntry->getLocalPreference()) {
-        deleteBGPRoutingEntry(oldEntry);
+        deleteBgpRoutingEntry(oldEntry);
         return false;
     }
 
     /* Remove from consideration all routes that are not tied for
          having the smallest number of AS numbers present in their
          AS_PATH attributes.*/
     if (entry->getASCount() < oldEntry->getASCount()) {
-        deleteBGPRoutingEntry(oldEntry);
+        deleteBgpRoutingEntry(oldEntry);
         return false;
     }
 
     /* Remove from consideration all routes that are not tied for
          having the lowest Origin number in their Origin attribute.*/
     if (entry->getPathType() < oldEntry->getPathType()) {
-        deleteBGPRoutingEntry(oldEntry);
+        deleteBgpRoutingEntry(oldEntry);
         return false;
     }
 
@@ -745,7 +745,7 @@ void BgpRouter::updateSendProcess(BgpProcessResult type, SessionId sessionIndex,
             type == ROUTE_DESTINATION_CHANGED ||
             type == NEW_SESSION_ESTABLISHED)
         {
-            BgpUpdateNlri NLRI;
+            BgpUpdateNlri nlri;
             std::vector<BgpUpdatePathAttributes *> content;
 
             unsigned int nbAS = entry->getASCount();
@@ -798,10 +798,10 @@ void BgpRouter::updateSendProcess(BgpProcessResult type, SessionId sessionIndex,
             originAttr->setValue((BgpSessionType)entry->getPathType());
 
             Ipv4Address netMask = entry->getNetmask();
-            NLRI.prefix = entry->getDestination().doAnd(netMask);
-            NLRI.length = (unsigned char)netMask.getNetmaskLength();
+            nlri.prefix = entry->getDestination().doAnd(netMask);
+            nlri.length = (unsigned char)netMask.getNetmaskLength();
 
-            (elem).second->sendUpdateMessage(content, NLRI);
+            (elem).second->sendUpdateMessage(content, nlri);
         }
     }
 }
@@ -811,7 +811,7 @@ void BgpRouter::updateSendProcess(BgpProcessResult type, SessionId sessionIndex,
  *  Side effects when returns true:
  *      bgpRoutingTable changed, iterators on bgpRoutingTable will be invalid.
  */
-bool BgpRouter::deleteBGPRoutingEntry(BgpRoutingTableEntry *entry)
+bool BgpRouter::deleteBgpRoutingEntry(BgpRoutingTableEntry *entry)
 {
     for (auto it = bgpRoutingTable.begin();
          it != bgpRoutingTable.end(); it++)
@@ -927,7 +927,7 @@ void BgpRouter::printOpenMessage(const BgpOpenMessage& openMsg)
 {
     EV_INFO << "  My AS: " << openMsg.getMyAS() << "\n";
     EV_INFO << "  Hold time: " << openMsg.getHoldTime() << "s \n";
-    EV_INFO << "  BGP Id: " << openMsg.getBGPIdentifier() << "\n";
+    EV_INFO << "  BGP Id: " << openMsg.getBgpIdentifier() << "\n";
     if (openMsg.getOptionalParameterArraySize() == 0)
         EV_INFO << "  Optional parameters: empty \n";
     for (size_t i = 0; i < openMsg.getOptionalParameterArraySize(); i++) {
@@ -1000,11 +1000,11 @@ void BgpRouter::printUpdateMessage(const BgpUpdateMessage& updateMsg)
         }
     }
 
-    if (updateMsg.getNLRIArraySize() > 0) {
-        auto NLRI_Base = updateMsg.getNLRI(0);
+    if (updateMsg.getNlriArraySize() > 0) {
+        auto nlriBase = updateMsg.getNlri(0);
         EV_INFO << "  Network Layer Reachability Information (NLRI): \n";
-        EV_INFO << "    NLRI length: " << (int)NLRI_Base.length << "\n";
-        EV_INFO << "    NLRI prefix: " << NLRI_Base.prefix << "\n";
+        EV_INFO << "    NLRI length: " << (int)nlriBase.length << "\n";
+        EV_INFO << "    NLRI prefix: " << nlriBase.prefix << "\n";
     }
 }
 

src/inet/routing/bgpv4/BgpRouter.h

@@ -44,7 +44,7 @@ class INET_API BgpRouter : public TcpSocket::BufferingCallback
     SocketMap _socketMap;
     // A single shared listening socket per router accepts all incoming BGP connections
     // on TCP_PORT (wildcard bind) and demuxes them to sessions by peer address in
-    // processMessageFromTCP(). RFC 4271: a BGP speaker listens for connections on port 179.
+    // processMessageFromTcp(). RFC 4271: a BGP speaker listens for connections on port 179.
     TcpSocket *listeningSocket = nullptr;
     SessionId _currSessionId = 0;
     std::map<SessionId, BgpSession *> _BGPSessions;
@@ -95,7 +95,7 @@ class INET_API BgpRouter : public TcpSocket::BufferingCallback
     void setNextHopSelf(Ipv4Address peer, bool nextHopSelf);
     void setLocalPreference(Ipv4Address peer, int localPref);
     bool isExternalAddress(const Ipv4Route& rtEntry);
-    void processMessageFromTCP(cMessage *msg);
+    void processMessageFromTcp(cMessage *msg);
 
     void printOpenMessage(const BgpOpenMessage& msg);
     void printUpdateMessage(const BgpUpdateMessage& msg);
@@ -118,11 +118,11 @@ class INET_API BgpRouter : public TcpSocket::BufferingCallback
 
     friend class BgpSession;
     // functions used by the BgpSession class
-    void getScheduleAt(simtime_t t, cMessage *msg) { bgpModule->scheduleAt(t, msg); }
-    void getCancelAndDelete(cMessage *msg) { bgpModule->cancelAndDelete(msg); }
-    cMessage *getCancelEvent(cMessage *msg) { return bgpModule->cancelEvent(msg); }
-    IIpv4RoutingTable *getIPRoutingTable() { return rt; }
-    std::vector<BgpRoutingTableEntry *> getBGPRoutingTable() { return bgpRoutingTable; }
+    void scheduleAt(simtime_t t, cMessage *msg) { bgpModule->scheduleAt(t, msg); }
+    void cancelAndDelete(cMessage *msg) { bgpModule->cancelAndDelete(msg); }
+    cMessage *cancelEvent(cMessage *msg) { return bgpModule->cancelEvent(msg); }
+    IIpv4RoutingTable *getIpRoutingTable() { return rt; }
+    std::vector<BgpRoutingTableEntry *> getBgpRoutingTable() { return bgpRoutingTable; }
 
     /**
      * \brief active listenSocket for a given session (used by fsm)
@@ -131,7 +131,7 @@ class INET_API BgpRouter : public TcpSocket::BufferingCallback
     /**
      * \brief active TcpConnection for a given session (used by fsm)
      */
-    void openTCPConnectionToPeer(SessionId sessionID);
+    void openTcpConnectionToPeer(SessionId sessionID);
     /**
      * \brief RFC 4271, 9.2 : Update-Send Process / Sent or not new UPDATE messages to its peers
      */
@@ -148,7 +148,7 @@ class INET_API BgpRouter : public TcpSocket::BufferingCallback
     void processMessage(const BgpKeepAliveMessage& msg);
     void processMessage(const BgpUpdateMessage& msg);
 
-    bool deleteBGPRoutingEntry(BgpRoutingTableEntry *entry);
+    bool deleteBgpRoutingEntry(BgpRoutingTableEntry *entry);
 
     /**
      * \brief RFC 4271: 9.1. : Decision Process used when an UPDATE message is received