configurator: add addRemoteRoutes and addManualRoutes parameters

Give the IPv4 and IPv6 network configurators finer-grained control over
which routes they install, so a routing protocol can be tested with each
router knowing only its directly-connected subnets and learning every
remote subnet from the protocol (otherwise the configurator's precomputed
shortest-path routes mask the protocol; for BGP they make decisionProcess
discard the learned route because a route to the destination already exists).

- addRemoteRoutes (default true): when false, do not add the multi-hop
  shortest-path routes (those that have a gateway / next hop). This is the
  mirror image of the existing addDirectRoutes filter, which drops the
  on-link (gateway-less) routes. Used only when addStaticRoutes is true.
- addManualRoutes (default true): when false, skip the manual <route>
  entries in the XML configuration. Independent of addStaticRoutes: manual
  routes are still applied regardless of the master switch, as before.

All new parameters default to true, so existing behavior is unchanged.

Author: avarga

src/inet/networklayer/configurator/ipv4/Ipv4NetworkConfigurator.cc

@@ -64,7 +64,9 @@ void Ipv4NetworkConfigurator::initialize(int stage)
         addSubnetRoutesParameter = par("addSubnetRoutes");
         addDefaultRoutesParameter = par("addDefaultRoutes");
         addDirectRoutesParameter = par("addDirectRoutes");
+        addRemoteRoutesParameter = par("addRemoteRoutes");
         optimizeRoutesParameter = par("optimizeRoutes");
+        addManualRoutesParameter = par("addManualRoutes");
         updateRoutesParameter = par("updateRoutes");
     }
     else if (stage == INITSTAGE_NETWORK_CONFIGURATION) {
@@ -91,7 +93,9 @@ void Ipv4NetworkConfigurator::computeConfiguration()
     // read and configure multicast groups from the XML configuration
     TIME(readMulticastGroupConfiguration(topology));
     // read and configure manual routes from the XML configuration
-    readManualRouteConfiguration(topology);
+    // (independent of addStaticRoutes)
+    if (addManualRoutesParameter)
+        readManualRouteConfiguration(topology);
     // read and configure manual multicast routes from the XML configuration
     readManualMulticastRouteConfiguration(topology);
     // calculate shortest paths, and add corresponding static routes
@@ -1583,6 +1587,8 @@ void Ipv4NetworkConfigurator::addStaticRoutes(Topology& topology, cXMLElement *a
                                 delete route;
                             else if (!addDirectRoutesParameter && route->getGateway().isUnspecified())
                                 delete route;
+                            else if (!addRemoteRoutesParameter && !route->getGateway().isUnspecified())
+                                delete route;
                             else {
                                 sourceNode->staticRoutes.push_back(route);
                                 sourceNode->routingTableNetworkInterfaces.push_back(route->getInterface());

src/inet/networklayer/configurator/ipv4/Ipv4NetworkConfigurator.h

@@ -121,7 +121,9 @@ class INET_API Ipv4NetworkConfigurator : public L3NetworkConfiguratorBase, publi
     bool addSubnetRoutesParameter = false;
     bool addDefaultRoutesParameter = false;
     bool addDirectRoutesParameter = false;
+    bool addRemoteRoutesParameter = false;
     bool optimizeRoutesParameter = false;
+    bool addManualRoutesParameter = false;
     bool updateRoutesParameter = false;
 
     // internal state

src/inet/networklayer/configurator/ipv4/Ipv4NetworkConfigurator.ned

@@ -413,7 +413,9 @@ simple Ipv4NetworkConfigurator extends L3NetworkConfiguratorBase
         bool addDefaultRoutes = default(true); // Add default routes if all routes from a source node go through the same gateway (used only if addStaticRoutes is true)
         bool addSubnetRoutes = default(true);  // Add subnet routes instead of destination interface routes (only where applicable; used only if addStaticRoutes is true)
         bool addDirectRoutes = default(true);  // Add direct routes towards local network members (i.e. directly connected interfaces) to the routing table (used only if addStaticRoutes is true)
+        bool addRemoteRoutes = default(true);  // Add routes towards remote (non-directly-connected) destinations via a gateway (used only if addStaticRoutes is true)
         bool optimizeRoutes = default(true); // Optimize routing tables by merging routes, the resulting routing table might route more packets than the original (used only if addStaticRoutes is true)
+        bool addManualRoutes = default(true);  // Add manual routes from the XML configuration; independent of addStaticRoutes
         bool updateRoutes = default(false);  // Recalculate static routes if an interface goes down/up or a carrier is lost/back
         bool dumpTopology = default(false);  // Print extracted network topology to the module output
         bool dumpLinks = default(false);     // Print recognized network links to the module output

src/inet/networklayer/configurator/ipv6/Ipv6NetworkConfigurator.cc

@@ -36,6 +36,8 @@ void Ipv6NetworkConfigurator::initialize(int stage)
         addStaticRoutesParameter = par("addStaticRoutes");
         addDefaultRoutesParameter = par("addDefaultRoutes");
         addDirectRoutesParameter = par("addDirectRoutes");
+        addRemoteRoutesParameter = par("addRemoteRoutes");
+        addManualRoutesParameter = par("addManualRoutes");
     }
     else if (stage == INITSTAGE_NETWORK_CONFIGURATION) {
         ensureConfigurationComputed(topology);
@@ -57,7 +59,9 @@ void Ipv6NetworkConfigurator::computeConfiguration()
     if (assignAddressesParameter)
         TIME(assignAddresses(topology));
     // read and configure manual routes from the XML configuration
-    readManualRouteConfiguration(topology);
+    // (independent of addStaticRoutes)
+    if (addManualRoutesParameter)
+        readManualRouteConfiguration(topology);
     // read and configure manual multicast routes from the XML configuration
     readManualMulticastRouteConfiguration(topology);
     // calculate shortest paths, and add corresponding static routes
@@ -1037,6 +1041,9 @@ void Ipv6NetworkConfigurator::addStaticRoutes(Topology& topology, cXMLElement *a
                         // Skip direct (on-link) routes when direct routes are disabled
                         if (!addDirectRoutesParameter && nextHop.isUnspecified())
                             continue;
+                        // Skip remote routes (via a next hop) when remote routes are disabled
+                        if (!addRemoteRoutesParameter && !nextHop.isUnspecified())
+                            continue;
 
                         // Check for duplicate routes
                         bool duplicate = false;

src/inet/networklayer/configurator/ipv6/Ipv6NetworkConfigurator.h

@@ -86,6 +86,8 @@ class INET_API Ipv6NetworkConfigurator : public L3NetworkConfiguratorBase, publi
     bool addStaticRoutesParameter = false;
     bool addDefaultRoutesParameter = false;
     bool addDirectRoutesParameter = false;
+    bool addRemoteRoutesParameter = false;
+    bool addManualRoutesParameter = false;
 
     // internal state
     Topology topology;

src/inet/networklayer/configurator/ipv6/Ipv6NetworkConfigurator.ned

@@ -106,7 +106,9 @@ simple Ipv6NetworkConfigurator extends L3NetworkConfiguratorBase
         bool assignAddressesToHosts = default(true); // If true, statically assign global addresses to host (non-router) interfaces too. If false, configure only router interfaces and their advertised prefixes, leaving hosts to obtain addresses through DYNAMIC configuration; which dynamic method is used is selected by the usual mechanisms (router AdvAutonomousFlag for SLAAC; the Managed/Other-config RA flags plus a DHCPv6 server for DHCPv6), not by this parameter. Set to false for mobile nodes (MIPv6), whose home/care-of addresses must be autoconfigured. Routers always get static addresses regardless of this setting.
         bool addStaticRoutes = default(true); // Add static routes to all routing tables
         bool addDefaultRoutes = default(true); // Add default routes if all routes from a source go through the same gateway
-        bool addDirectRoutes = default(true); // Add direct routes (on-link prefix routes) for local network members
+        bool addDirectRoutes = default(true); // Add direct routes (on-link prefix routes) for local network members (used only if addStaticRoutes is true)
+        bool addRemoteRoutes = default(true); // Add routes towards remote (non-on-link) destinations via a next hop (used only if addStaticRoutes is true)
+        bool addManualRoutes = default(true); // Add manual routes from the XML configuration; independent of addStaticRoutes
         bool dumpTopology = default(false); // Print extracted network topology
         bool dumpLinks = default(false); // Print recognized network links
         bool dumpAddresses = default(false); // Print assigned IPv6 addresses for all interfaces