Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics in the creation of NS3 clusters
[simgrid.git] / src / surf / network_ns3.cpp
index d559716..148d737 100644 (file)
@@ -6,12 +6,14 @@
 
 #include <unordered_set>
 
+#include <xbt/config.hpp>
+
 #include "ns3/core-module.h"
 #include "ns3/node.h"
 
 #include "ns3/ns3_interface.h"
 #include "ns3/ns3_simulator.h"
-#include "src/surf/network_ns3.hpp"
+#include "network_ns3.hpp"
 
 #include "src/surf/HostImpl.hpp"
 #include "src/surf/surf_private.h"
@@ -25,7 +27,6 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network
 int NS3_EXTENSION_ID;
 
 xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
-static double time_to_next_flow_completion = -1;
 
 /*****************
  * Crude globals *
@@ -44,14 +45,11 @@ 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
 
-static NS3Sim* ns3_sim = 0;
-
-
 /*************
  * Callbacks *
  *************/
 
-static void simgrid_ns3_add_host(simgrid::s4u::Host& host)
+static void ns3_add_host(simgrid::s4u::Host& host)
 {
   const char* id = host.name().c_str();
   XBT_DEBUG("NS3_ADD_HOST '%s'", id);
@@ -65,7 +63,7 @@ static void simgrid_ns3_add_host(simgrid::s4u::Host& host)
   host.extension_set(NS3_EXTENSION_ID, ns3host);
 }
 
-static void simgrid_ns3_add_netcard(simgrid::surf::NetCard* netcard)
+static void ns3_add_netcard(simgrid::kernel::routing::NetCard* netcard)
 {
   const char* id = netcard->name();
 
@@ -76,51 +74,40 @@ static void simgrid_ns3_add_netcard(simgrid::surf::NetCard* netcard)
   nodes.Add(node);
   ns3netcard->node_num = number_of_nodes++;
 
-
   xbt_lib_set(as_router_lib, id, NS3_ASR_LEVEL, ns3netcard );
 }
 
 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
 {
-  const char *groups = NULL;
-
-  int start, end, i;
-  unsigned int iter;
-
-  xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
-
-  char *router_id,*host_id;
+  xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), nullptr);
 
   xbt_dynar_t radical_elements = xbt_str_split(cluster->radical, ",");
+  unsigned int iter;
+  const char* groups = nullptr;
   xbt_dynar_foreach(radical_elements, iter, groups) {
-  xbt_dynar_t radical_ends = xbt_str_split(groups, "-");
+    xbt_dynar_t radical_ends = xbt_str_split(groups, "-");
 
-    switch (xbt_dynar_length(radical_ends)) {
-    case 1:
-      start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
+    if (xbt_dynar_length(radical_ends) == 1) {
+      int start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char*));
       xbt_dynar_push_as(tab_elements_num, int, start);
-      router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
-      simgrid::s4u::Host::by_name_or_create(router_id)
-        ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
+      char* router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
+      simgrid::s4u::Host::by_name_or_create(router_id)->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
       XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
       free(router_id);
-      break;
 
-    case 2:
-      start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
-      end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
-      for (i = start; i <= end; i++){
+    } else if (xbt_dynar_length(radical_ends) == 2) {
+      int start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char*));
+      int end   = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char*));
+      for (int i = start; i <= end; i++) {
         xbt_dynar_push_as(tab_elements_num, int, i);
-        router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
-        simgrid::s4u::Host::by_name_or_create(router_id)
-          ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
+        char* router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
+        simgrid::s4u::Host::by_name_or_create(router_id)->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
         XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
         free(router_id);
       }
-      break;
 
-    default:
+    } else {
       XBT_DEBUG("Malformed radical");
     }
   }
@@ -132,8 +119,8 @@ static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
   char * bw =  bprintf("%fBps", cluster->bw);
 
   xbt_dynar_foreach(tab_elements_num,cpt,elmts) {
-    host_id   = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
-    router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
+    char* host_id   = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
+    char* router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
     XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
 
     ns3_node_t host_src = ns3_find_host(host_id);
@@ -141,9 +128,7 @@ static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
 
     xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
 
-    ns3_add_link(host_src->node_num,NS3_NETWORK_ELEMENT_HOST,
-                 host_dst->node_num,NS3_NETWORK_ELEMENT_HOST,
-                 bw,lat);
+    ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
 
     free(router_id);
     free(host_id);
@@ -174,7 +159,7 @@ static void create_ns3_topology(void)
   std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
 
   XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
-  simgrid::surf::Onelink *onelink;
+  simgrid::kernel::routing::Onelink *onelink;
   unsigned int iter;
   xbt_dynar_foreach(onelink_routes, iter, onelink) {
     char *src = onelink->src_->name();
@@ -201,12 +186,15 @@ static void create_ns3_topology(void)
       if (!host_src || !host_dst)
           xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
 
-      ns3_add_link(host_src->node_num,NS3_NETWORK_ELEMENT_HOST,host_dst->node_num,NS3_NETWORK_ELEMENT_HOST,link_bdw,link_lat);
+      ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
 
       xbt_free(link_bdw);
       xbt_free(link_lat);
     }
   }
+
+  ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
+  ns3::GlobalRouteManager::InitializeRoutes();
 }
 
 /*********
@@ -218,29 +206,33 @@ void surf_network_model_init_NS3()
     return;
 
   surf_network_model = new simgrid::surf::NetworkNS3Model();
-  xbt_dynar_push(all_existing_models, &surf_network_model);
+  all_existing_models->push_back(surf_network_model);
 }
 
+static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
+  "The ns3 tcp model can be : NewReno or Reno or Tahoe",
+  "default");
+
 namespace simgrid {
 namespace surf {
 
 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
-  ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"));
+  ns3_initialize(ns3_tcp_model.get().c_str());
 
-  routing_model_create(NULL);
-  simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
-  simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_netcard);
-  simgrid::surf::on_link.connect(netlink_parse_init);
+  routing_model_create(nullptr);
+  simgrid::s4u::Host::onCreation.connect(ns3_add_host);
+  simgrid::kernel::routing::netcardCreatedCallbacks.connect(ns3_add_netcard);
   simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
-  simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
-  simgrid::surf::on_postparse.connect(&ns3_end_platform); //InitializeRoutes
+  simgrid::surf::on_postparse.connect(&create_ns3_topology);
 
   NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
   NS3_ASR_LEVEL  = xbt_lib_add_level(as_router_lib, xbt_free_f);
+
+  LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
+  LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
 }
 
 NetworkNS3Model::~NetworkNS3Model() {
-  delete ns3_sim;
   xbt_dynar_free_container(&IPV4addr);
   xbt_dict_free(&flowFromSock);
 }
@@ -251,23 +243,14 @@ Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double lat
   return new LinkNS3(this, name, properties, bandwidth, latency);
 }
 
-Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
+Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 {
-  XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
-  NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
-
-  ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
-
-  action->m_lastSent = 0;
-  action->p_srcElm = src;
-  action->p_dstElm = dst;
-  networkCommunicateCallbacks(action, src, dst, size, rate);
-
-  return action;
+  return new NetworkNS3Action(this, size, src, dst);
 }
 
-double NetworkNS3Model::next_occuring_event(double now)
+double NetworkNS3Model::nextOccuringEvent(double now)
 {
+  double time_to_next_flow_completion;
   XBT_DEBUG("ns3_next_occuring_event");
 
   //get the first relevant value from the running_actions list
@@ -276,7 +259,7 @@ double NetworkNS3Model::next_occuring_event(double now)
   else
     do {
       ns3_simulator(now);
-      time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
+      time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
     } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
 
   XBT_DEBUG("min       : %f", now);
@@ -289,7 +272,7 @@ double NetworkNS3Model::next_occuring_event(double now)
 
 void NetworkNS3Model::updateActionsState(double now, double delta)
 {
-  static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
+  static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
 
   /* If there are no running flows, advance the NS3 simulator and return */
   if (getRunningActionSet()->empty()) {
@@ -300,7 +283,7 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
     return;
   }
 
-  xbt_dict_cursor_t cursor = NULL;
+  xbt_dict_cursor_t cursor = nullptr;
   char *ns3Socket;
   SgFlow *sgFlow;
   xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
@@ -310,16 +293,15 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
 
     if (TRACE_is_enabled() &&
         action->getState() == Action::State::running){
-      double data_delta_sent = sgFlow->sentBytes_ - action->m_lastSent;
+      double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
 
-      std::vector<Link*> *route = new std::vector<Link*>();
+      std::vector<Link*> route = std::vector<Link*>();
 
-      routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
-      for (auto link : *route)
+      routing_platf->getRouteAndLatency(action->src_->pimpl_netcard, action->dst_->pimpl_netcard, &route, nullptr);
+      for (auto link : route)
         TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
-      delete route;
 
-      action->m_lastSent = sgFlow->sentBytes_;
+      action->lastSent_ = sgFlow->sentBytes_;
     }
 
     if(sgFlow->finished_){
@@ -339,7 +321,6 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
     }
     xbt_dict_remove(flowFromSock, ns3Socket);
   }
-  return;
 }
 
 /************
@@ -364,42 +345,48 @@ void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
   THROW_UNIMPLEMENTED;
 }
 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
-  xbt_die("The NS3 network model doesn't support latency state traces");
+  xbt_die("The NS3 network model doesn't support bandwidth traces");
 }
 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
-  xbt_die("The NS3 network model doesn't support latency state traces");
+  xbt_die("The NS3 network model doesn't support latency traces");
 }
 
 /**********
  * Action *
  **********/
 
-NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
-: NetworkAction(model, cost, failed)
-{}
-
-void NetworkNS3Action::suspend()
+NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
+    : NetworkAction(model, size, false)
 {
+  XBT_DEBUG("Communicate from %s to %s", src->name().c_str(), dst->name().c_str());
+
+  src_ = src;
+  dst_ = dst;
+  ns3_create_flow(src->name().c_str(), dst->name().c_str(), surf_get_clock(), size, this);
+
+  Link::onCommunicate(this, src, dst);
+}
+
+void NetworkNS3Action::suspend() {
   THROW_UNIMPLEMENTED;
 }
 
-void NetworkNS3Action::resume()
-{
+void NetworkNS3Action::resume() {
   THROW_UNIMPLEMENTED;
 }
 
   /* Test whether a flow is suspended */
 bool NetworkNS3Action::isSuspended()
 {
-  return 0;
+  return false;
 }
 
 int NetworkNS3Action::unref()
 {
-  m_refcount--;
-  if (!m_refcount) {
-  if (action_hook.is_linked())
-    p_stateSet->erase(p_stateSet->iterator_to(*this));
+  refcount_--;
+  if (!refcount_) {
+    if (action_hook.is_linked())
+      stateSet_->erase(stateSet_->iterator_to(*this));
     XBT_DEBUG ("Removing action %p", this);
     delete this;
     return 1;
@@ -411,25 +398,37 @@ int NetworkNS3Action::unref()
 }
 
 
+void ns3_simulator(double maxSeconds){
+  if (maxSeconds > 0.0) // If there is a maximum amount of time to run
+    ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
+  XBT_DEBUG("Start simulator for at most %fs",maxSeconds);
+  ns3::Simulator::Run ();
+}
+
+void ns3_create_flow(const char* a,const char *b,double startTime,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
+{
+  int node1 = ns3_find_host(a)->node_num;
+  int node2 = ns3_find_host(b)->node_num;
 
+  ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
+  ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
 
+  char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2,char*);
 
-void ns3_simulator(double min){
-  ns3_sim->simulator_start(min);
-}
+  XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
+  ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
+  sink.Install (dst_node);
 
-void ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
-{
-  ns3_node_t node1 = ns3_find_host(a);
-  ns3_node_t node2 = ns3_find_host(b);
+  ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket (src_node, ns3::TcpSocketFactory::GetTypeId());
 
-  ns3::Ptr<ns3::Node> src_node = nodes.Get(node1->node_num);
-  ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
+  xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr);
 
-  char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
+  sock->Bind(ns3::InetSocketAddress(port_number));
+  XBT_DEBUG("Create flow starting to %fs + %fs = %fs",
+      startTime-ns3::Simulator::Now().GetSeconds(), ns3::Simulator::Now().GetSeconds(), startTime);
 
-  XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1->node_num, node2->node_num,addr);
-  ns3_sim->create_flow_NS3(src_node, dst_node, port_number, start, addr, TotalBytes, action);
+  ns3::Simulator::Schedule (ns3::Seconds(startTime-ns3::Simulator::Now().GetSeconds()),
+      &StartFlow, sock, addr, port_number);
 
   port_number++;
   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
@@ -437,9 +436,6 @@ void ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalByt
 
 // initialize the NS3 interface and environment
 void ns3_initialize(const char* TcpProtocol){
-  xbt_assert(!ns3_sim, "ns3 already initialized");
-  ns3_sim = new NS3Sim();
-
 //  tcpModel are:
 //  "ns3::TcpNewReno"
 //  "ns3::TcpReno"
@@ -485,7 +481,6 @@ void * ns3_add_host_cluster(const char * id)
 
 void ns3_add_cluster(char * bw,char * lat,const char *id)
 {
-
   XBT_DEBUG("cluster_id: %s",id);
   XBT_DEBUG("bw: %s lat: %s",bw,lat);
   XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
@@ -501,8 +496,7 @@ void ns3_add_cluster(char * bw,char * lat,const char *id)
   XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
   Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
 
-  if(Nodes.GetN() > 65000)
-    xbt_die("Cluster with NS3 is limited to 65000 nodes");
+  xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
   ns3::CsmaHelper csma;
   csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
   csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
@@ -517,8 +511,7 @@ void ns3_add_cluster(char * bw,char * lat,const char *id)
   interfaces.Add(ipv4.Assign (devices));
 
   if(number_of_links == 255){
-    if(number_of_networks == 255)
-      xbt_die("Number of links and networks exceed 255*255");
+    xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
     number_of_links = 1;
     number_of_networks++;
   }else{
@@ -534,16 +527,9 @@ static char* transformIpv4Address (ns3::Ipv4Address from){
   return bprintf("%s",s.c_str());
 }
 
-void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
-          int dst, e_ns3_network_element_type_t type_dst,
-          char *bw, char *lat)
+void ns3_add_link(int src, int dst, char *bw, char *lat)
 {
-  if(number_of_links == 1 ) {
-    LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
-    LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
-  }
-
-  ns3::MyPointToPointHelper pointToPoint;
+  ns3::PointToPointHelper pointToPoint;
 
   ns3::NetDeviceContainer netA;
   ns3::Ipv4AddressHelper address;
@@ -554,9 +540,8 @@ void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
   pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
   pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
-  //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
 
-  netA.Add(pointToPoint.Install (a, type_src, b, type_dst));
+  netA.Add(pointToPoint.Install (a, b));
 
   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
   address.SetBase (adr, "255.255.0.0");
@@ -572,19 +557,11 @@ void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
   xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
   XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
 
-  if(number_of_links == 255){
-    if(number_of_networks == 255)
-      xbt_die("Number of links and networks exceed 255*255");
+  if (number_of_links == 255){
+    xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
     number_of_links = 1;
     number_of_networks++;
-  }else{
+  } else {
     number_of_links++;
   }
 }
-
-void ns3_end_platform(void)
-{
-  XBT_DEBUG("InitializeRoutes");
-  ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
-  ns3::GlobalRouteManager::InitializeRoutes();
-}