Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make Model::update_algo a constant field, set at initialization only
[simgrid.git] / src / surf / network_ns3.cpp
index 3ac508d..f133055 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2018. 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. */
@@ -8,18 +8,25 @@
 
 #include "xbt/config.hpp"
 #include "xbt/string.hpp"
+#include "xbt/utility.hpp"
 
-#include "ns3/core-module.h"
-#include "ns3/node.h"
+#include <ns3/core-module.h>
+#include <ns3/csma-helper.h>
+#include <ns3/global-route-manager.h>
+#include <ns3/internet-stack-helper.h>
+#include <ns3/ipv4-address-helper.h>
+#include <ns3/packet-sink-helper.h>
+#include <ns3/point-to-point-helper.h>
 
 #include "network_ns3.hpp"
 #include "ns3/ns3_simulator.hpp"
 
-#include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
-#include "src/kernel/routing/NetPoint.hpp"
-
+#include "simgrid/kernel/routing/NetPoint.hpp"
+#include "simgrid/plugins/energy.h"
 #include "simgrid/s4u/Engine.hpp"
 #include "simgrid/s4u/NetZone.hpp"
+#include "src/surf/xml/platf_private.hpp"
+#include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
 
@@ -40,15 +47,14 @@ static int number_of_nodes = 0;
 static int number_of_clusters_nodes = 0;
 static int number_of_links = 1;
 static int number_of_networks = 1;
-static int port_number = 1025; //Port number is limited from 1025 to 65 000
 
 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
 
 NetPointNs3::NetPointNs3()
 {
-  ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
-  stack.Install(node);
-  nodes.Add(node);
+  ns3Node_ = ns3::CreateObject<ns3::Node>(0);
+  stack.Install(ns3Node_);
+  nodes.Add(ns3Node_);
   node_num = number_of_nodes++;
 }
 
@@ -56,7 +62,7 @@ NetPointNs3::NetPointNs3()
  * Callbacks *
  *************/
 
-static void clusterCreation_cb(ClusterCreationArgs* cluster)
+static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs* cluster)
 {
   for (int const& i : *cluster->radicals) {
     // Routers don't create a router on the other end of the private link by themselves.
@@ -81,10 +87,10 @@ static void clusterCreation_cb(ClusterCreationArgs* cluster)
 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::surf::LinkImpl*>* link_list)
+                             std::vector<simgrid::surf::LinkImpl*>& link_list)
 {
-  if (link_list->size() == 1) {
-    simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
+  if (link_list.size() == 1) {
+    simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list[0]);
 
     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->getCname(), dst->getCname(), link->getCname(),
               (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
@@ -109,7 +115,7 @@ static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoin
                "of length 1.\n"
                "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
                "ignored.",
-               src->getCname(), dst->getCname(), link_list->size());
+               src->getCname(), dst->getCname(), link_list.size());
     warned_about_long_routes = true;
   }
 }
@@ -141,7 +147,11 @@ static simgrid::config::Flag<std::string>
 namespace simgrid {
 namespace surf {
 
-NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
+NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::Full)
+{
+  xbt_assert(not sg_link_energy_is_inited(),
+             "LinkEnergy plugin and NS3 network models are not compatible. Are you looking for Ecofen, maybe?");
+
   NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
 
   ns3_initialize(ns3_tcp_model.get().c_str());
@@ -151,6 +161,7 @@ NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
     XBT_VERB("SimGrid's %s is known as node %d within NS3", pt->getCname(), pt->extension<NetPointNs3>()->node_num);
   });
   simgrid::surf::on_cluster.connect(&clusterCreation_cb);
+
   simgrid::s4u::onPlatformCreated.connect(&postparse_cb);
   simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
 }
@@ -165,18 +176,18 @@ LinkImpl* NetworkNS3Model::createLink(const std::string& name, double bandwidth,
   return new LinkNS3(this, name, bandwidth, latency);
 }
 
-Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
+kernel::resource::Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 {
   return new NetworkNS3Action(this, size, src, dst);
 }
 
-double NetworkNS3Model::nextOccuringEvent(double now)
+double NetworkNS3Model::next_occuring_event(double now)
 {
   double time_to_next_flow_completion;
   XBT_DEBUG("ns3_next_occuring_event");
 
   //get the first relevant value from the running_actions list
-  if (not getRunningActionSet()->size() || now == 0.0)
+  if (not get_running_action_set()->size() || now == 0.0)
     return -1.0;
   else
     do {
@@ -192,12 +203,12 @@ double NetworkNS3Model::nextOccuringEvent(double now)
   return time_to_next_flow_completion;
 }
 
-void NetworkNS3Model::updateActionsState(double now, double delta)
+void NetworkNS3Model::update_actions_state(double now, double delta)
 {
   static std::vector<std::string> socket_to_destroy;
 
   /* If there are no running flows, advance the NS3 simulator and return */
-  if (getRunningActionSet()->empty()) {
+  if (get_running_action_set()->empty()) {
 
     while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
       ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
@@ -211,26 +222,28 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
     SgFlow* sgFlow            = elm.second;
     NetworkNS3Action * action = sgFlow->action_;
     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
-    action->setRemains(action->getCost() - sgFlow->sentBytes_);
+    action->set_remains(action->get_cost() - sgFlow->sentBytes_);
 
-    if (TRACE_is_enabled() &&
-        action->getState() == Action::State::running){
+    if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::running) {
       double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
 
       std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
 
-      action->src_->routeTo(action->dst_, &route, nullptr);
+      action->src_->routeTo(action->dst_, route, nullptr);
       for (auto const& link : route)
-        TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
-                                        delta);
+        TRACE_surf_link_set_utilization(link->getCname(), action->get_category(), (data_delta_sent) / delta,
+                                        now - delta, delta);
 
       action->lastSent_ = sgFlow->sentBytes_;
     }
 
     if(sgFlow->finished_){
       socket_to_destroy.push_back(ns3Socket);
-      XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
-      action->finish(Action::State::done);
+      XBT_DEBUG("Destroy socket %p of action %p", ns3Socket.c_str(), action);
+      action->finish(kernel::resource::Action::State::done);
+    } else {
+      XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3Socket.c_str(), sgFlow->sentBytes_,
+                sgFlow->totalBytes_, sgFlow->remaining_);
     }
   }
 
@@ -239,7 +252,7 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
     socket_to_destroy.pop_back();
     SgFlow* flow = flowFromSock.at(ns3Socket);
     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
-      XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
+      XBT_DEBUG("Removing socket %p of action %p", ns3Socket.c_str(), flow->action_);
     }
     delete flow;
     flowFromSock.erase(ns3Socket);
@@ -276,14 +289,41 @@ void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
  * Action *
  **********/
 
-NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
-    : NetworkAction(model, size, false)
+NetworkNS3Action::NetworkNS3Action(kernel::resource::Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
+    : NetworkAction(model, totalBytes, false)
 {
   XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname());
 
   src_ = src;
   dst_ = dst;
-  ns3_create_flow(src, dst, size, this);
+  static int port_number = 1025; // Port number is limited from 1025 to 65 000
+
+  unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
+  unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
+
+  ns3::Ptr<ns3::Node> src_node = src->pimpl_netpoint->extension<NetPointNs3>()->ns3Node_;
+  ns3::Ptr<ns3::Node> dst_node = dst->pimpl_netpoint->extension<NetPointNs3>()->ns3Node_;
+
+  xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
+             dst->pimpl_netpoint->getCname());
+  std::string& addr = IPV4addr[node2];
+  xbt_assert(not addr.empty(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
+             dst->pimpl_netpoint->getCname());
+
+  XBT_DEBUG("ns3: Create flow of %.0f Bytes from %u to %u with Interface %s", totalBytes, node1, node2, addr.c_str());
+  ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
+  sink.Install(dst_node);
+
+  ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
+
+  flowFromSock.insert({transformSocketPtr(sock), new SgFlow(totalBytes, this)});
+
+  sock->Bind(ns3::InetSocketAddress(port_number));
+
+  ns3::Simulator::ScheduleNow(&StartFlow, sock, addr.c_str(), port_number);
+
+  port_number++;
+  xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
 
   s4u::Link::onCommunicate(this, src, dst);
 }
@@ -300,24 +340,9 @@ std::list<LinkImpl*> NetworkNS3Action::links()
 {
   THROW_UNIMPLEMENTED;
 }
-
-/* Test whether a flow is suspended */
-bool NetworkNS3Action::isSuspended()
-{
-  return false;
-}
-
-int NetworkNS3Action::unref()
+void NetworkNS3Action::update_remains_lazy(double /*now*/)
 {
-  refcount_--;
-  if (not refcount_) {
-    if (action_hook.is_linked())
-      stateSet_->erase(stateSet_->iterator_to(*this));
-    XBT_DEBUG ("Removing action %p", this);
-    delete this;
-    return 1;
-  }
-  return 0;
+  THROW_IMPOSSIBLE;
 }
 
 }
@@ -331,68 +356,37 @@ void ns3_simulator(double maxSeconds)
   ns3::Simulator::Run ();
 }
 
-void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst,
-    u_int32_t TotalBytes,
-    simgrid::surf::NetworkNS3Action* action) {
-  unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
-  unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
-
-  ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
-  ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
-
-  xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
-             dst->pimpl_netpoint->getCname());
-  std::string& addr = IPV4addr[node2];
-  xbt_assert(not addr.empty(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
-             dst->pimpl_netpoint->getCname());
-
-  XBT_DEBUG("ns3_create_flow %u Bytes from %u to %u with Interface %s", TotalBytes, node1, node2, addr.c_str());
-  ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
-  sink.Install (dst_node);
-
-  ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
-
-  flowFromSock.insert({transformSocketPtr(sock), new SgFlow(TotalBytes, action)});
-
-  sock->Bind(ns3::InetSocketAddress(port_number));
-
-  ns3::Simulator::ScheduleNow(&StartFlow, sock, addr.c_str(), port_number);
-
-  port_number++;
-  xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
-}
 
 // initialize the NS3 interface and environment
-void ns3_initialize(const char* TcpProtocol){
-//  tcpModel are:
-//  "ns3::TcpNewReno"
-//  "ns3::TcpReno"
-//  "ns3::TcpTahoe"
+void ns3_initialize(std::string TcpProtocol)
+{
+  //  tcpModel are:
+  //  "ns3::TcpNewReno"
+  //  "ns3::TcpReno"
+  //  "ns3::TcpTahoe"
 
   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
   ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
 
-  if (not strcmp(TcpProtocol, "default"))
-    return;
+  if (TcpProtocol == "default") {
+    /* nothing to do */
 
-  if (not strcmp(TcpProtocol, "Reno")) {
-    XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
+  } else if (TcpProtocol == "Reno") {
+    XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
-    return;
-  }
-  if (not strcmp(TcpProtocol, "NewReno")) {
-    XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
+
+  } else if (TcpProtocol == "NewReno") {
+    XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
-    return;
-  }
-  if (not strcmp(TcpProtocol, "Tahoe")) {
-    XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
+
+  } else if (TcpProtocol == "Tahoe") {
+    XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
-    return;
-  }
 
-  xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
+  } else {
+    xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
+  }
 }
 
 void ns3_add_cluster(const char* id, double bw, double lat) {
@@ -409,7 +403,7 @@ void ns3_add_cluster(const char* id, double bw, double lat) {
 
   xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
   ns3::CsmaHelper csma;
-  csma.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
+  csma.SetChannelAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw * 8))); // NS3 takes bps, but we provide Bps
   csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
   ns3::NetDeviceContainer devices = csma.Install(Nodes);
   XBT_DEBUG("Create CSMA");
@@ -445,18 +439,14 @@ void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
   int srcNum = src->node_num;
   int dstNum = dst->node_num;
 
-  ns3::Ptr<ns3::Node> a = nodes.Get(srcNum);
-  ns3::Ptr<ns3::Node> b = nodes.Get(dstNum);
+  ns3::Ptr<ns3::Node> a = src->ns3Node_;
+  ns3::Ptr<ns3::Node> b = dst->ns3Node_;
 
   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
-  pointToPoint.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
+  pointToPoint.SetDeviceAttribute("DataRate",
+                                  ns3::DataRateValue(ns3::DataRate(bw * 8))); // NS3 takes bps, but we provide Bps
   pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 
-  std::string filename = simgrid::xbt::string_printf("link-%d-%d.tr", srcNum, dstNum);
-  ns3::AsciiTraceHelper ascii;
-  pointToPoint.EnableAsciiAll(ascii.CreateFileStream(filename));
-  pointToPoint.EnablePcapAll ("tcp-bulk-send", false);
-
   ns3::NetDeviceContainer netA;
   netA.Add(pointToPoint.Install (a, b));