Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ns3 does not accept 0 as a port_number so don't let it nicely overleap
[simgrid.git] / src / surf / network_ns3.cpp
index b44c56a..208bedb 100644 (file)
@@ -7,6 +7,7 @@
 #include <unordered_set>
 
 #include "xbt/config.hpp"
+#include "xbt/str.h"
 #include "xbt/string.hpp"
 #include "xbt/utility.hpp"
 
@@ -174,7 +175,7 @@ static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoin
                              std::vector<simgrid::kernel::resource::LinkImpl*> const& link_list)
 {
   if (link_list.size() == 1) {
-    auto* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
+    auto const* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
 
     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s %s", src->get_cname(), dst->get_cname(), link->get_cname(),
               (link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI ? "(wifi)" : "(wired)"),
@@ -210,7 +211,24 @@ void surf_network_model_init_NS3()
 }
 
 static simgrid::config::Flag<std::string>
-    ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be : NewReno or Reno or Tahoe", "default");
+    ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be: NewReno or Reno or Tahoe", "default");
+static simgrid::config::Flag<std::string> ns3_seed(
+    "ns3/seed",
+    "The random seed provided to ns-3. Either 'time' to seed with time(), blank to not set (default), or a number.", "",
+    [](std::string val) {
+      if (val.length() == 0)
+        return;
+      if (strcasecmp(val.c_str(), "time") == 0) {
+        std::srand(time(NULL));
+        ns3::RngSeedManager::SetSeed(std::rand());
+        ns3::RngSeedManager::SetRun(std::rand());
+      } else {
+        int v = xbt_str_parse_int(
+            val.c_str(), "Invalid value for option ns3/seed. It must be either 'time', a number, or left empty.");
+        ns3::RngSeedManager::SetSeed(v);
+        ns3::RngSeedManager::SetRun(v);
+      }
+    });
 
 namespace simgrid {
 namespace kernel {
@@ -309,7 +327,7 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
     ns3_socket                = elm.first;
     SgFlow* sgFlow            = elm.second;
     NetworkNS3Action * action = sgFlow->action_;
-    XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
+    XBT_DEBUG("Processing flow %p (socket %s, action %p)", sgFlow, ns3_socket.c_str(), action);
     // Because NS3 stops as soon as a flow is finished, the other flows that ends at the same time may remains in an
     // inconsistent state (i.e. remains_ == 0 but finished_ == false).
     // However, SimGrid considers sometimes that an action with remains_ == 0 is finished.
@@ -331,13 +349,13 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
       action->last_sent_ = sgFlow->sent_bytes_;
     }
 
-    if(sgFlow->finished_){
+    if ((sgFlow->finished_) && (remains <= 0)) { // finished_ should not become true before remains gets to 0, but it sometimes does. Let's play safe, here.
       socket_to_destroy.push_back(ns3_socket);
-      XBT_DEBUG("Destroy socket %p of action %p", ns3_socket.c_str(), action);
+      XBT_DEBUG("Destroy socket %s of action %p", ns3_socket.c_str(), action);
       action->set_remains(0);
       action->finish(Action::State::FINISHED);
     } else {
-      XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
+      XBT_DEBUG("Socket %s sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
                 sgFlow->total_bytes_, sgFlow->remaining_);
     }
   }
@@ -347,7 +365,7 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
     socket_to_destroy.pop_back();
     SgFlow* flow = flow_from_sock.at(ns3_socket);
     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
-      XBT_DEBUG("Removing socket %p of action %p", ns3_socket.c_str(), flow->action_);
+      XBT_DEBUG("Removing socket %s of action %p", ns3_socket.c_str(), flow->action_);
     }
     delete flow;
     flow_from_sock.erase(ns3_socket);
@@ -442,6 +460,20 @@ void LinkNS3::set_latency_profile(profile::Profile*)
 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
     : NetworkAction(model, *src, *dst, totalBytes, false)
 {
+  // ns-3 fails when src = dst, so avoid the problem by considering that communications are infinitely fast on the
+  // loopback that does not exists
+  if (src == dst) {
+    static bool warned = false;
+    if (not warned) {
+      XBT_WARN("Sending from a host %s to itself is not supported by ns-3. Every such communication finishes "
+               "immediately upon startup.",
+               src->get_cname());
+      warned = true;
+    }
+    finish(Action::State::FINISHED);
+    return;
+  }
+
   // If there is no other started actions, we need to move NS-3 forward to be sync with SimGrid
   if (model->get_started_action_set()->size()==1){
     while(double_positive(surf_get_clock() - ns3::Simulator::Now().GetSeconds(), sg_surf_precision)){
@@ -450,9 +482,7 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
     }
   }
 
-  XBT_DEBUG("Communicate from %s to %s", src->get_cname(), dst->get_cname());
-
-  static int port_number = 1025; // Port number is limited from 1025 to 65 000
+  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_;
@@ -461,13 +491,14 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
   xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
              dst->get_netpoint()->get_cname());
 
-  XBT_DEBUG("ns3: Create flow of %.0f Bytes from %s to %s with Interface %s", totalBytes, src->get_cname(),
-            dst->get_cname(), addr.c_str());
   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
   ns3::ApplicationContainer apps = sink.Install(dst_node);
 
   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
 
+  XBT_DEBUG("Create socket %s for a flow of %.0f Bytes from %s to %s with Interface %s",
+            transform_socket_ptr(sock).c_str(), totalBytes, src->get_cname(), dst->get_cname(), addr.c_str());
+
   flow_from_sock.insert({transform_socket_ptr(sock), new SgFlow(totalBytes, this)});
   sink_from_sock.insert({transform_socket_ptr(sock), apps});
 
@@ -476,8 +507,8 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
   ns3::Simulator::ScheduleNow(&start_flow, sock, addr.c_str(), port_number);
 
   port_number++;
-  if(port_number > 65000){
-    port_number = 1025;
+  if (port_number == UINT16_MAX) {
+    port_number = 1;
     XBT_WARN("Too many connections! Port number is saturated. Trying to use the oldest ports.");
   }