Fix memory leak with ns3 routing tables.

[simgrid.git] / src / surf / network_ns3.cpp

diff --git a/src/surf/network_ns3.cpp b/src/surf/network_ns3.cpp
index 04adf6d..08a88e1 100644 (file)
--- a/src/surf/network_ns3.cpp
+++ b/src/surf/network_ns3.cpp
@@ -1,8 +1,10 @@
-/* Copyright (c) 2007-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2022. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
+#include "simgrid/plugins/ns3.hpp"
+
 #include <string>
 #include <unordered_set>
 
@@ -18,6 +20,7 @@
 #include <ns3/global-route-manager.h>
 #include <ns3/internet-stack-helper.h>
 #include <ns3/ipv4-address-helper.h>
+#include <ns3/ipv4-global-routing-helper.h>
 #include <ns3/packet-sink-helper.h>
 #include <ns3/point-to-point-helper.h>
 
@@ -168,7 +171,6 @@ static void zoneCreation_cb(simgrid::s4u::NetZone const& zone)
 
   mobility.SetPositionAllocator(positionAllocS);
   mobility.Install(nodes);
-
   ns3::Ipv4AddressHelper address;
   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
   address.SetBase(addr.c_str(), "255.255.0.0");
@@ -185,6 +187,9 @@ static void zoneCreation_cb(simgrid::s4u::NetZone const& zone)
   } else {
     number_of_links++;
   }
+  /* in theory we can compute the routing table only only once at the platform seal
+   *  however put it here since or platform_created signal is called before the seal right now */
+  ns3::Ipv4GlobalRoutingHelper::RecomputeRoutingTables();
 }
 
 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
@@ -236,7 +241,7 @@ static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs con
 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
                              simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* /*gw_src*/,
                              simgrid::kernel::routing::NetPoint* /*gw_dst*/,
-                             std::vector<simgrid::kernel::resource::LinkImpl*> const& link_list)
+                             std::vector<simgrid::kernel::resource::StandardLinkImpl*> const& link_list)
 {
   /* ignoring routes from StarZone, not supported */
   if (not src || not dst)
@@ -331,17 +336,23 @@ NetworkNS3Model::NetworkNS3Model(const std::string& name) : NetworkModel(name)
     XBT_VERB("Declare SimGrid's %s within ns-3", pt.get_cname());
   });
 
-  s4u::Engine::on_platform_created.connect([]() {
+  s4u::Engine::on_platform_created_cb([]() {
     /* Create the ns3 topology based on routing strategy */
+    ns3::GlobalRouteManager::DeleteGlobalRoutes(); // just in case this callback is called twice
     ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
     ns3::GlobalRouteManager::InitializeRoutes();
   });
   routing::on_cluster_creation.connect(&clusterCreation_cb);
   routing::NetZoneImpl::on_route_creation.connect(&routeCreation_cb);
-  s4u::NetZone::on_seal.connect(&zoneCreation_cb);
+  s4u::NetZone::on_seal_cb(&zoneCreation_cb);
+}
+
+NetworkNS3Model::~NetworkNS3Model()
+{
+  ns3::Simulator::Destroy();
 }
 
-LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
+StandardLinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
 {
   xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
   auto* link = new LinkNS3(name, bandwidths[0]);
@@ -349,7 +360,7 @@ LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vecto
   return link;
 }
 
-LinkImpl* NetworkNS3Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
+StandardLinkImpl* NetworkNS3Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
 {
   auto* link = create_link(name, bandwidths);
   link->set_sharing_policy(s4u::Link::SharingPolicy::WIFI, {});
@@ -415,7 +426,7 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
     if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) {
       double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_;
 
-      std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
+      std::vector<StandardLinkImpl*> route = std::vector<StandardLinkImpl*>();
 
       action->get_src().route_to(&action->get_dst(), route, nullptr);
       for (auto const& link : route)
@@ -454,7 +465,7 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
  * Resource *
  ************/
 
-LinkNS3::LinkNS3(const std::string& name, double bandwidth) : LinkImpl(name)
+LinkNS3::LinkNS3(const std::string& name, double bandwidth) : StandardLinkImpl(name)
 {
   bandwidth_.peak = bandwidth;
 }
@@ -517,8 +528,8 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
 
   static uint16_t port_number = 1;
 
-  ns3::Ptr<ns3::Node> src_node = src->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
-  ns3::Ptr<ns3::Node> dst_node = dst->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
+  ns3::Ptr<ns3::Node> src_node = get_ns3node_from_sghost(src);
+  ns3::Ptr<ns3::Node> dst_node = get_ns3node_from_sghost(dst);
 
   std::string& addr = dst->get_netpoint()->extension<NetPointNs3>()->ipv4_address_;
   xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
@@ -553,7 +564,7 @@ void NetworkNS3Action::resume()
   THROW_UNIMPLEMENTED;
 }
 
-std::list<LinkImpl*> NetworkNS3Action::get_links() const
+std::list<StandardLinkImpl*> NetworkNS3Action::get_links() const
 {
   THROW_UNIMPLEMENTED;
 }
@@ -564,6 +575,12 @@ void NetworkNS3Action::update_remains_lazy(double /*now*/)
 
 } // namespace resource
 } // namespace kernel
+
+ns3::Ptr<ns3::Node> get_ns3node_from_sghost(simgrid::s4u::Host* host)
+{
+  xbt_assert(host->get_netpoint()->extension<NetPointNs3>() != nullptr, "Please only use this function on ns-3 nodes");
+  return host->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
+}
 } // namespace simgrid
 
 void ns3_simulator(double maxSeconds)
@@ -572,7 +589,7 @@ void ns3_simulator(double maxSeconds)
   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
     id = ns3::Simulator::Schedule(ns3::Seconds(maxSeconds), &ns3::Simulator::Stop);
 
-  XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, EngineImpl::get_clock());
+  XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, simgrid::kernel::EngineImpl::get_clock());
   ns3::Simulator::Run();
   XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds());