Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ns3: further cleanups
[simgrid.git] / src / surf / network_ns3.cpp
index 2072922..cd4e51b 100644 (file)
@@ -4,6 +4,11 @@
 /* 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 "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 "src/surf/HostImpl.hpp"
 
 #include "simgrid/s4u/As.hpp"
 
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ns3);
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
 
 int NS3_EXTENSION_ID;
 
-xbt_dynar_t IPV4addr;
+xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
 static double time_to_next_flow_completion = -1;
 
-extern xbt_dict_t dict_socket;
+/*****************
+ * Crude globals *
+ *****************/
+
+extern xbt_dict_t flowFromSock;
+
+static ns3::InternetStackHelper stack;
+static ns3::NodeContainer nodes;
+static ns3::NodeContainer Cluster_nodes;
+static ns3::Ipv4InterfaceContainer interfaces;
+
+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
+
+static NS3Sim* ns3_sim = 0;
+
 
 /*************
  * Callbacks *
@@ -30,24 +53,30 @@ static void simgrid_ns3_add_host(simgrid::s4u::Host& host)
 {
   const char* id = host.name().c_str();
   XBT_DEBUG("NS3_ADD_HOST '%s'", id);
-  host.extension_set(NS3_EXTENSION_ID, ns3_add_host(id));
+
+  ns3_node_t ns3host  = xbt_new0(s_ns3_node_t,1);
+  ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
+  stack.Install(node);
+  nodes.Add(node);
+  ns3host->node_num = number_of_nodes;
+  ns3host->type = NS3_NETWORK_ELEMENT_HOST;
+  number_of_nodes++;
+
+  host.extension_set(NS3_EXTENSION_ID, ns3host);
 }
 
 static void parse_ns3_add_link(sg_platf_link_cbarg_t link)
 {
   XBT_DEBUG("NS3_ADD_LINK '%s'",link->id);
 
-  if(!IPV4addr)
-    IPV4addr = xbt_dynar_new(sizeof(char*),free);
-
-  Link *l = surf_network_model->createLink(link->id,
-      link->bandwidth, link->bandwidth_trace,
-      link->latency, link->latency_trace,
-      link->policy, link->properties);
+  Link *l = surf_network_model->createLink(link->id, link->bandwidth, link->latency, link->policy, link->properties);
+  if (link->bandwidth_trace)
+    l->setBandwidthTrace(link->latency_trace);
+  if (link->latency_trace)
+    l->setLatencyTrace(link->latency_trace);
   if (link->state_trace)
     l->setStateTrace(link->state_trace);
 }
-
 static void simgrid_ns3_add_router(simgrid::surf::NetCard* router)
 {
   const char* router_id = router->name();
@@ -125,8 +154,8 @@ static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
     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_nodes_t host_src = ns3_find_host(host_id);
-    ns3_nodes_t host_dst = ns3_find_host(router_id);
+    ns3_node_t host_src = ns3_find_host(host_id);
+    ns3_node_t host_dst = ns3_find_host(router_id);
 
     if(host_src && host_dst){}
     else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
@@ -169,8 +198,8 @@ static void create_ns3_topology(void)
   xbt_dynar_foreach(onelink_routes, iter, onelink) {
     char *src = onelink->src_->name();
     char *dst = onelink->dst_->name();
-    simgrid::surf::NetworkNS3Link *link =
-      static_cast<simgrid::surf::NetworkNS3Link *>(onelink->link_);
+    simgrid::surf::LinkNS3 *link =
+      static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
 
     if (strcmp(src,dst) && link->m_created){
       XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
@@ -182,12 +211,12 @@ static void create_ns3_topology(void)
       XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
 
       //create link ns3
-      ns3_nodes_t host_src = ns3_find_host(src);
+      ns3_node_t host_src = ns3_find_host(src);
       if (!host_src)
-        host_src = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
-      ns3_nodes_t host_dst = ns3_find_host(dst);
+        host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
+      ns3_node_t host_dst = ns3_find_host(dst);
       if(!host_dst)
-        host_dst = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
+        host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
 
       if (!host_src || !host_dst)
           xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
@@ -209,7 +238,7 @@ static void define_callbacks_ns3(void)
 {
   simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
   simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_router);
-  simgrid::surf::on_link.connect (&parse_ns3_add_link);
+  simgrid::surf::on_link.connect (parse_ns3_add_link);
   simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
   simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
   simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
@@ -221,12 +250,12 @@ static void define_callbacks_ns3(void)
  *********/
 static void free_ns3_link(void * elmts)
 {
-  delete static_cast<simgrid::surf::NetworkNS3Link*>(elmts);
+  delete static_cast<simgrid::surf::LinkNS3*>(elmts);
 }
 
 static void free_ns3_host(void * elmts)
 {
-  ns3_nodes_t host = static_cast<ns3_nodes_t>(elmts);
+  ns3_node_t host = static_cast<ns3_node_t>(elmts);
   free(host);
 }
 
@@ -255,28 +284,18 @@ NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
 }
 
 NetworkNS3Model::~NetworkNS3Model() {
-  ns3_finalize();
+  delete ns3_sim;
   xbt_dynar_free_container(&IPV4addr);
-  xbt_dict_free(&dict_socket);
+  xbt_dict_free(&flowFromSock);
 }
 
-Link* NetworkNS3Model::createLink(const char *name,
-    double bw_initial, tmgr_trace_t bw_trace,
-    double lat_initial, tmgr_trace_t lat_trace,
-    e_surf_link_sharing_policy_t policy,
+Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
     xbt_dict_t properties){
-  if (bw_trace)
-    XBT_INFO("The NS3 network model doesn't support bandwidth state traces");
-  if (lat_trace)
-    XBT_INFO("The NS3 network model doesn't support latency state traces");
 
-  Link* link = new NetworkNS3Link(this, name, properties, bw_initial, lat_initial);
-  Link::onCreation(link);
-  return link;
+  return new LinkNS3(this, name, properties, bandwidth, latency);
 }
 
-Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst,
-                                   double size, double rate)
+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);
@@ -301,11 +320,11 @@ double NetworkNS3Model::next_occuring_event(double now)
   else
     do {
       ns3_simulator(now);
-      time_to_next_flow_completion = ns3_time() - surf_get_clock();//FIXME: use now instead ?
+      time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
     } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
 
   XBT_DEBUG("min       : %f", now);
-  XBT_DEBUG("ns3  time : %f", ns3_time());
+  XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
   XBT_DEBUG("surf time : %f", surf_get_clock());
   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
 
@@ -323,20 +342,20 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
 
   /* If there are no running flows, just return */
   if (!getRunningActionSet()->size()) {
-    while(double_positive(now-ns3_time(), sg_surf_precision)) {
-      ns3_simulator(now-ns3_time());
+    while(double_positive(now-ns3::Simulator::Now().GetSeconds(), sg_surf_precision)) {
+      ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
     }
     return;
   }
 
   NetworkNS3Action *action;
-  xbt_dict_foreach(dict_socket,cursor,key,data){
+  xbt_dict_foreach(flowFromSock,cursor,key,data){
     action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
     XBT_DEBUG("Processing socket %p (action %p)",data,action);
     action->setRemains(action->getCost() - ns3_get_socket_sent(data));
 
     if (TRACE_is_enabled() &&
-        action->getState() == SURF_ACTION_RUNNING){
+        action->getState() == Action::State::running){
       double data_sent = ns3_get_socket_sent(data);
       double data_delta_sent = data_sent - action->m_lastSent;
 
@@ -354,17 +373,17 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
       xbt_dynar_push(socket_to_destroy,&key);
       XBT_DEBUG("Destroy socket %p of action %p", key, action);
       action->finish();
-      action->setState(SURF_ACTION_DONE);
+      action->setState(Action::State::done);
     }
   }
 
   while (!xbt_dynar_is_empty(socket_to_destroy)){
     xbt_dynar_pop(socket_to_destroy,&key);
 
-    void *data = xbt_dict_get (dict_socket, key);
+    void *data = xbt_dict_get (flowFromSock, key);
     action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
     XBT_DEBUG ("Removing socket %p of action %p", key, action);
-    xbt_dict_remove(dict_socket, key);
+    xbt_dict_remove(flowFromSock, key);
   }
   return;
 }
@@ -373,23 +392,30 @@ void NetworkNS3Model::updateActionsState(double now, double delta)
  * Resource *
  ************/
 
-NetworkNS3Link::NetworkNS3Link(NetworkNS3Model *model, const char *name, xbt_dict_t props,
-                           double bw_initial, double lat_initial)
+LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
  : Link(model, name, props)
  , m_created(1)
 {
-  m_bandwidth.peak = bw_initial;
-  m_latency.peak = lat_initial;
+  m_bandwidth.peak = bandwidth;
+  m_latency.peak = latency;
+
+  Link::onCreation(this);
 }
 
-NetworkNS3Link::~NetworkNS3Link()
+LinkNS3::~LinkNS3()
 {
 }
 
-void NetworkNS3Link::apply_event(tmgr_trace_iterator_t event, double value)
+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");
+}
+void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
+  xbt_die("The NS3 network model doesn't support latency state traces");
+}
 
 /**********
  * Action *
@@ -430,3 +456,224 @@ int NetworkNS3Action::unref()
 
 }
 }
+
+
+
+
+
+void ns3_simulator(double min){
+  ns3_sim->simulator_start(min);
+}
+
+simgrid::surf::NetworkNS3Action* ns3_get_socket_action(void *socket){
+  return ((SgFlow *)socket)->action_;
+}
+
+double ns3_get_socket_remains(void *socket){
+  return ((SgFlow *)socket)->remaining_;
+}
+
+double ns3_get_socket_sent(void *socket){
+  return ((SgFlow *)socket)->sentBytes_;
+}
+
+bool ns3_get_socket_is_finished(void *socket){
+  return ((SgFlow *)socket)->finished_;
+}
+
+int 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::Node> src_node = nodes.Get(node1->node_num);
+  ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
+
+  char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
+
+  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);
+
+  port_number++;
+  if(port_number >= 65001 ) xbt_die("Too many connections! Port number is saturated.");
+  return 0;
+}
+
+// initialize the NS3 interface and environment
+int ns3_initialize(const char* TcpProtocol){
+  xbt_assert(!ns3_sim, "ns3 already initialized");
+  ns3_sim = new NS3Sim();
+
+//  tcpModel are:
+//  "ns3::TcpNewReno"
+//  "ns3::TcpReno"
+//  "ns3::TcpTahoe"
+
+  ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
+  ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
+
+  if(!strcmp(TcpProtocol,"default")){
+    return 0;
+  }
+  if(!strcmp(TcpProtocol,"Reno")){
+    XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
+    ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
+    return 0;
+  }
+  if(!strcmp(TcpProtocol,"NewReno")){
+    XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
+    ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
+    return 0;
+  }
+  if(!strcmp(TcpProtocol,"Tahoe")){
+    XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
+    ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
+    return 0;
+  }
+
+  XBT_ERROR("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
+  return 0;
+}
+
+void * ns3_add_host_cluster(const char * id)
+{
+  ns3_node_t host  = xbt_new0(s_ns3_node_t,1);
+  XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
+  ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
+  stack.Install(node);
+  Cluster_nodes.Add(node);
+  nodes.Add(node);
+  host->node_num = number_of_nodes;
+  host->type = NS3_NETWORK_ELEMENT_HOST;
+  number_of_nodes++;
+  return host;
+}
+
+void * ns3_add_router(const char * id)
+{
+  ns3_node_t router  = xbt_new0(s_ns3_node_t,1);
+  XBT_DEBUG("Interface ns3 add router[%d] '%s'",number_of_nodes,id);
+  ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
+  stack.Install(node);
+  nodes.Add(node);
+  router->node_num = number_of_nodes;
+  router->type = NS3_NETWORK_ELEMENT_ROUTER;
+  number_of_nodes++;
+  return router;
+}
+
+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);
+
+  ns3::NodeContainer Nodes;
+
+  for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
+    Nodes.Add(Cluster_nodes.Get(i));
+    XBT_DEBUG("Add node %d to cluster",i);
+  }
+  number_of_clusters_nodes = Cluster_nodes.GetN();
+
+  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");
+  ns3::CsmaHelper csma;
+  csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
+  csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
+  ns3::NetDeviceContainer devices = csma.Install (Nodes);
+  XBT_DEBUG("Create CSMA");
+
+  char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
+  XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
+  ns3::Ipv4AddressHelper ipv4;
+  ipv4.SetBase (adr, "255.255.0.0");
+  free(adr);
+  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");
+    number_of_links = 1;
+    number_of_networks++;
+  }else{
+    number_of_links++;
+  }
+  XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
+}
+
+void * ns3_add_AS(const char * id)
+{
+  XBT_DEBUG("Interface ns3 add AS '%s'",id);
+  return NULL;
+}
+
+static char* transformIpv4Address (ns3::Ipv4Address from){
+  std::stringstream sstream;
+    sstream << from ;
+    std::string s = sstream.str();
+    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)
+{
+  if(number_of_links == 1 ) {
+    LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
+    LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
+  }
+
+  ns3::MyPointToPointHelper pointToPoint;
+
+  ns3::NetDeviceContainer netA;
+  ns3::Ipv4AddressHelper address;
+
+  ns3::Ptr<ns3::Node> a = nodes.Get(src);
+  ns3::Ptr<ns3::Node> b = nodes.Get(dst);
+
+  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));
+
+  char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
+  address.SetBase (adr, "255.255.0.0");
+  XBT_DEBUG("\tInterface stack '%s'",adr);
+  free(adr);
+  interfaces.Add(address.Assign (netA));
+
+  char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
+  xbt_dynar_set_as(IPV4addr,src,char*,tmp);
+  XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
+
+  tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
+  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");
+    number_of_links = 1;
+    number_of_networks++;
+  }else{
+    number_of_links++;
+  }
+}
+
+void ns3_end_platform(void)
+{
+  XBT_DEBUG("InitializeRoutes");
+  ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
+  ns3::GlobalRouteManager::InitializeRoutes();
+}