Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doxygen fixups
[simgrid.git] / src / surf / network_ns3.cpp
index d8f4ba7..e42338e 100644 (file)
@@ -6,6 +6,8 @@
 
 #include <unordered_set>
 
+#include <xbt/config.hpp>
+
 #include "ns3/core-module.h"
 #include "ns3/node.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 *
@@ -48,7 +49,7 @@ static int port_number = 1025; //Port number is limited from 1025 to 65 000
  * 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);
@@ -62,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::surf::NetCard* netcard)
 {
   const char* id = netcard->name();
 
@@ -90,15 +91,14 @@ static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
 
   xbt_dynar_t radical_elements = xbt_str_split(cluster->radical, ",");
   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 *));
       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));
+      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;
@@ -109,8 +109,7 @@ static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
       for (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));
+        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);
       }
@@ -201,6 +200,9 @@ static void create_ns3_topology(void)
       xbt_free(link_lat);
     }
   }
+
+  ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
+  ns3::GlobalRouteManager::InitializeRoutes();
 }
 
 /*********
@@ -215,22 +217,27 @@ void surf_network_model_init_NS3()
   xbt_dynar_push(all_existing_models, &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);
+  simgrid::s4u::Host::onCreation.connect(ns3_add_host);
+  simgrid::surf::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() {
@@ -246,21 +253,12 @@ Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double lat
 
 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *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 time_to_next_flow_completion;
   XBT_DEBUG("ns3_next_occuring_event");
 
   //get the first relevant value from the running_actions list
@@ -303,16 +301,16 @@ 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*>();
 
-      routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
+      routing_platf->getRouteAndLatency (action->src_, action->dst_, route, NULL);
       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_){
@@ -332,7 +330,6 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
     }
     xbt_dict_remove(flowFromSock, ns3Socket);
   }
-  return;
 }
 
 /************
@@ -357,42 +354,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, NetCard *src, NetCard *dst)
+: NetworkAction(model, size, false)
 {
+  XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
+
+  src_ = src;
+  dst_ = dst;
+  ns3_create_flow(src->name(), dst->name(), 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;
@@ -404,10 +407,10 @@ int NetworkNS3Action::unref()
 }
 
 
-void ns3_simulator(double min){
-  if (min > 0.0) // If there is a maximum amount of time to run
-    ns3::Simulator::Stop(ns3::Seconds(min));
-  XBT_DEBUG("Start simulator for at most %fs",min);
+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 ();
 }
 
@@ -487,7 +490,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);
@@ -536,11 +538,6 @@ static char* transformIpv4Address (ns3::Ipv4Address from){
 
 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::PointToPointHelper pointToPoint;
 
   ns3::NetDeviceContainer netA;
@@ -552,7 +549,6 @@ void ns3_add_link(int src, int dst, char *bw, char *lat)
   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, b));
 
@@ -570,19 +566,11 @@ void ns3_add_link(int src, int dst, char *bw, char *lat)
   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();
-}