src/surf/network_ns3.cpp

   1 /* Copyright (c) 2007-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <unordered_set>
   8
   9 #include <xbt/config.hpp>
  10
  11 #include "ns3/core-module.h"
  12 #include "ns3/node.h"
  13
  14 #include "ns3/ns3_interface.h"
  15 #include "ns3/ns3_simulator.h"
  16 #include "network_ns3.hpp"
  17
  18 #include "src/surf/HostImpl.hpp"
  19 #include "src/surf/surf_private.h"
  20 #include "simgrid/sg_config.h"
  21 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  22
  23 #include "simgrid/s4u/As.hpp"
  24
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
  26
  27 int NS3_EXTENSION_ID;
  28
  29 xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
  30
  31 /*****************
  32  * Crude globals *
  33  *****************/
  34
  35 extern xbt_dict_t flowFromSock;
  36
  37 static ns3::InternetStackHelper stack;
  38 static ns3::NodeContainer nodes;
  39 static ns3::NodeContainer Cluster_nodes;
  40 static ns3::Ipv4InterfaceContainer interfaces;
  41
  42 static int number_of_nodes = 0;
  43 static int number_of_clusters_nodes = 0;
  44 static int number_of_links = 1;
  45 static int number_of_networks = 1;
  46 static int port_number = 1025; //Port number is limited from 1025 to 65 000
  47
  48 /*************
  49  * Callbacks *
  50  *************/
  51
  52 static void ns3_add_host(simgrid::s4u::Host& host)
  53 {
  54   const char* id = host.name().c_str();
  55   XBT_DEBUG("NS3_ADD_HOST '%s'", id);
  56
  57   ns3_node_t ns3host  = xbt_new0(s_ns3_node_t,1);
  58   ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
  59   stack.Install(node);
  60   nodes.Add(node);
  61   ns3host->node_num = number_of_nodes ++;
  62
  63   host.extension_set(NS3_EXTENSION_ID, ns3host);
  64 }
  65
  66 static void ns3_add_netcard(simgrid::kernel::routing::NetCard* netcard)
  67 {
  68   const char* id = netcard->name();
  69
  70   ns3_node_t ns3netcard  = xbt_new0(s_ns3_node_t,1);
  71   XBT_DEBUG("Interface ns3 add netcard[%d] '%s'",number_of_nodes,id);
  72   ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
  73   stack.Install(node);
  74   nodes.Add(node);
  75   ns3netcard->node_num = number_of_nodes++;
  76
  77   xbt_lib_set(as_router_lib, id, NS3_ASR_LEVEL, ns3netcard );
  78 }
  79
  80 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
  81 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
  82 {
  83   char* lat = bprintf("%fs", cluster->lat);
  84   char* bw  = bprintf("%fBps", cluster->bw);
  85
  86   for (int i : *cluster->radicals) {
  87     char* router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
  88     simgrid::s4u::Host::by_name_or_create(router_id)->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
  89     XBT_DEBUG("NS3_ADD_ROUTER '%s'", router_id);
  90
  91     // Create private link
  92     char* host_id = bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
  93     XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
  94
  95     ns3_node_t host_src = ns3_find_host(host_id);
  96     ns3_node_t host_dst = ns3_find_host(router_id);
  97
  98     xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
  99
 100     ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
 101
 102     free(router_id);
 103     free(host_id);
 104   }
 105   xbt_free(lat);
 106   xbt_free(bw);
 107
 108   //Create link backbone
 109   lat = bprintf("%fs", cluster->bb_lat);
 110   bw =  bprintf("%fBps", cluster->bb_bw);
 111   ns3_add_cluster(bw,lat,cluster->id);
 112   xbt_free(lat);
 113
 114   xbt_free(bw);
 115 }
 116
 117 /* Create the ns3 topology based on routing strategy */
 118 static void create_ns3_topology(void)
 119 {
 120   XBT_DEBUG("Starting topology generation");
 121
 122   xbt_dynar_shrink(IPV4addr,0);
 123
 124   //get the onelinks from the parsed platform
 125   xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
 126
 127   std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
 128
 129   XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
 130   simgrid::kernel::routing::Onelink *onelink;
 131   unsigned int iter;
 132   xbt_dynar_foreach(onelink_routes, iter, onelink) {
 133     char *src = onelink->src_->name();
 134     char *dst = onelink->dst_->name();
 135     simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
 136
 137     if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
 138       already_seen.insert(link);
 139       XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
 140       char * link_bdw = bprintf("%fBps", link->getBandwidth());
 141       char * link_lat = bprintf("%fs", link->getLatency());
 142
 143       //   XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
 144       XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
 145
 146       //create link ns3
 147       ns3_node_t host_src = ns3_find_host(src);
 148       if (!host_src)
 149         host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
 150       ns3_node_t host_dst = ns3_find_host(dst);
 151       if(!host_dst)
 152         host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
 153
 154       if (!host_src || !host_dst)
 155           xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
 156
 157       ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
 158
 159       xbt_free(link_bdw);
 160       xbt_free(link_lat);
 161     }
 162   }
 163
 164   ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
 165   ns3::GlobalRouteManager::InitializeRoutes();
 166 }
 167
 168 /*********
 169  * Model *
 170  *********/
 171 void surf_network_model_init_NS3()
 172 {
 173   if (surf_network_model)
 174     return;
 175
 176   surf_network_model = new simgrid::surf::NetworkNS3Model();
 177   all_existing_models->push_back(surf_network_model);
 178 }
 179
 180 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
 181   "The ns3 tcp model can be : NewReno or Reno or Tahoe",
 182   "default");
 183
 184 namespace simgrid {
 185 namespace surf {
 186
 187 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
 188   ns3_initialize(ns3_tcp_model.get().c_str());
 189
 190   routing_model_create(nullptr);
 191   simgrid::s4u::Host::onCreation.connect(ns3_add_host);
 192   simgrid::kernel::routing::netcardCreatedCallbacks.connect(ns3_add_netcard);
 193   simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
 194   simgrid::surf::on_postparse.connect(&create_ns3_topology);
 195
 196   NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
 197   NS3_ASR_LEVEL  = xbt_lib_add_level(as_router_lib, xbt_free_f);
 198
 199   LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
 200   LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
 201 }
 202
 203 NetworkNS3Model::~NetworkNS3Model() {
 204   xbt_dynar_free_container(&IPV4addr);
 205   xbt_dict_free(&flowFromSock);
 206 }
 207
 208 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
 209     xbt_dict_t properties){
 210
 211   return new LinkNS3(this, name, properties, bandwidth, latency);
 212 }
 213
 214 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 215 {
 216   return new NetworkNS3Action(this, size, src, dst);
 217 }
 218
 219 double NetworkNS3Model::nextOccuringEvent(double now)
 220 {
 221   double time_to_next_flow_completion;
 222   XBT_DEBUG("ns3_next_occuring_event");
 223
 224   //get the first relevant value from the running_actions list
 225   if (!getRunningActionSet()->size() || now == 0.0)
 226     return -1.0;
 227   else
 228     do {
 229       ns3_simulator(now);
 230       time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
 231     } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
 232
 233   XBT_DEBUG("min       : %f", now);
 234   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
 235   XBT_DEBUG("surf time : %f", surf_get_clock());
 236   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
 237
 238   return time_to_next_flow_completion;
 239 }
 240
 241 void NetworkNS3Model::updateActionsState(double now, double delta)
 242 {
 243   static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
 244
 245   /* If there are no running flows, advance the NS3 simulator and return */
 246   if (getRunningActionSet()->empty()) {
 247
 248     while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
 249       ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
 250
 251     return;
 252   }
 253
 254   xbt_dict_cursor_t cursor = nullptr;
 255   char *ns3Socket;
 256   SgFlow *sgFlow;
 257   xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
 258     NetworkNS3Action * action = sgFlow->action_;
 259     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
 260     action->setRemains(action->getCost() - sgFlow->sentBytes_);
 261
 262     if (TRACE_is_enabled() &&
 263         action->getState() == Action::State::running){
 264       double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
 265
 266       std::vector<Link*> route = std::vector<Link*>();
 267
 268       routing_platf->getRouteAndLatency(action->src_->pimpl_netcard, action->dst_->pimpl_netcard, &route, nullptr);
 269       for (auto link : route)
 270         TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
 271
 272       action->lastSent_ = sgFlow->sentBytes_;
 273     }
 274
 275     if(sgFlow->finished_){
 276       xbt_dynar_push(socket_to_destroy,&ns3Socket);
 277       XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
 278       action->finish();
 279       action->setState(Action::State::done);
 280     }
 281   }
 282
 283   while (!xbt_dynar_is_empty(socket_to_destroy)){
 284     xbt_dynar_pop(socket_to_destroy,&ns3Socket);
 285
 286     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
 287       SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
 288       XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
 289     }
 290     xbt_dict_remove(flowFromSock, ns3Socket);
 291   }
 292 }
 293
 294 /************
 295  * Resource *
 296  ************/
 297
 298 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
 299  : Link(model, name, props)
 300 {
 301   m_bandwidth.peak = bandwidth;
 302   m_latency.peak = latency;
 303
 304   Link::onCreation(this);
 305 }
 306
 307 LinkNS3::~LinkNS3()
 308 {
 309 }
 310
 311 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
 312 {
 313   THROW_UNIMPLEMENTED;
 314 }
 315 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
 316   xbt_die("The NS3 network model doesn't support bandwidth traces");
 317 }
 318 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
 319   xbt_die("The NS3 network model doesn't support latency traces");
 320 }
 321
 322 /**********
 323  * Action *
 324  **********/
 325
 326 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
 327     : NetworkAction(model, size, false)
 328 {
 329   XBT_DEBUG("Communicate from %s to %s", src->name().c_str(), dst->name().c_str());
 330
 331   src_ = src;
 332   dst_ = dst;
 333   ns3_create_flow(src->name().c_str(), dst->name().c_str(), surf_get_clock(), size, this);
 334
 335   Link::onCommunicate(this, src, dst);
 336 }
 337
 338 void NetworkNS3Action::suspend() {
 339   THROW_UNIMPLEMENTED;
 340 }
 341
 342 void NetworkNS3Action::resume() {
 343   THROW_UNIMPLEMENTED;
 344 }
 345
 346   /* Test whether a flow is suspended */
 347 bool NetworkNS3Action::isSuspended()
 348 {
 349   return false;
 350 }
 351
 352 int NetworkNS3Action::unref()
 353 {
 354   refcount_--;
 355   if (!refcount_) {
 356     if (action_hook.is_linked())
 357       stateSet_->erase(stateSet_->iterator_to(*this));
 358     XBT_DEBUG ("Removing action %p", this);
 359     delete this;
 360     return 1;
 361   }
 362   return 0;
 363 }
 364
 365 }
 366 }
 367
 368
 369 void ns3_simulator(double maxSeconds){
 370   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
 371     ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
 372   XBT_DEBUG("Start simulator for at most %fs",maxSeconds);
 373   ns3::Simulator::Run ();
 374 }
 375
 376 void ns3_create_flow(const char* a,const char *b,double startTime,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
 377 {
 378   int node1 = ns3_find_host(a)->node_num;
 379   int node2 = ns3_find_host(b)->node_num;
 380
 381   ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
 382   ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
 383
 384   char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2,char*);
 385
 386   XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
 387   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
 388   sink.Install (dst_node);
 389
 390   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket (src_node, ns3::TcpSocketFactory::GetTypeId());
 391
 392   xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr);
 393
 394   sock->Bind(ns3::InetSocketAddress(port_number));
 395   XBT_DEBUG("Create flow starting to %fs + %fs = %fs",
 396       startTime-ns3::Simulator::Now().GetSeconds(), ns3::Simulator::Now().GetSeconds(), startTime);
 397
 398   ns3::Simulator::Schedule (ns3::Seconds(startTime-ns3::Simulator::Now().GetSeconds()),
 399       &StartFlow, sock, addr, port_number);
 400
 401   port_number++;
 402   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
 403 }
 404
 405 // initialize the NS3 interface and environment
 406 void ns3_initialize(const char* TcpProtocol){
 407 //  tcpModel are:
 408 //  "ns3::TcpNewReno"
 409 //  "ns3::TcpReno"
 410 //  "ns3::TcpTahoe"
 411
 412   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
 413   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
 414
 415   if (!strcmp(TcpProtocol,"default"))
 416     return;
 417
 418   if (!strcmp(TcpProtocol,"Reno")) {
 419     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 420     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
 421     return;
 422   }
 423   if (!strcmp(TcpProtocol,"NewReno")) {
 424     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 425     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
 426     return;
 427   }
 428   if(!strcmp(TcpProtocol,"Tahoe")){
 429     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 430     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
 431     return;
 432   }
 433
 434   xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
 435 }
 436
 437 void * ns3_add_host_cluster(const char * id)
 438 {
 439   ns3_node_t host  = xbt_new0(s_ns3_node_t,1);
 440   XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
 441   ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
 442   stack.Install(node);
 443   Cluster_nodes.Add(node);
 444   nodes.Add(node);
 445   host->node_num = number_of_nodes;
 446   number_of_nodes++;
 447   return host;
 448 }
 449
 450 void ns3_add_cluster(char * bw,char * lat,const char *id)
 451 {
 452   XBT_DEBUG("cluster_id: %s",id);
 453   XBT_DEBUG("bw: %s lat: %s",bw,lat);
 454   XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
 455
 456   ns3::NodeContainer Nodes;
 457
 458   for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
 459     Nodes.Add(Cluster_nodes.Get(i));
 460     XBT_DEBUG("Add node %d to cluster",i);
 461   }
 462   number_of_clusters_nodes = Cluster_nodes.GetN();
 463
 464   XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
 465   Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
 466
 467   xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
 468   ns3::CsmaHelper csma;
 469   csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
 470   csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
 471   ns3::NetDeviceContainer devices = csma.Install (Nodes);
 472   XBT_DEBUG("Create CSMA");
 473
 474   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
 475   XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
 476   ns3::Ipv4AddressHelper ipv4;
 477   ipv4.SetBase (adr, "255.255.0.0");
 478   free(adr);
 479   interfaces.Add(ipv4.Assign (devices));
 480
 481   if(number_of_links == 255){
 482     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 483     number_of_links = 1;
 484     number_of_networks++;
 485   }else{
 486     number_of_links++;
 487   }
 488   XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
 489 }
 490
 491 static char* transformIpv4Address (ns3::Ipv4Address from){
 492   std::stringstream sstream;
 493   sstream << from ;
 494   std::string s = sstream.str();
 495   return bprintf("%s",s.c_str());
 496 }
 497
 498 void ns3_add_link(int src, int dst, char *bw, char *lat)
 499 {
 500   ns3::PointToPointHelper pointToPoint;
 501
 502   ns3::NetDeviceContainer netA;
 503   ns3::Ipv4AddressHelper address;
 504
 505   ns3::Ptr<ns3::Node> a = nodes.Get(src);
 506   ns3::Ptr<ns3::Node> b = nodes.Get(dst);
 507
 508   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
 509   pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
 510   pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
 511
 512   netA.Add(pointToPoint.Install (a, b));
 513
 514   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
 515   address.SetBase (adr, "255.255.0.0");
 516   XBT_DEBUG("\tInterface stack '%s'",adr);
 517   free(adr);
 518   interfaces.Add(address.Assign (netA));
 519
 520   char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
 521   xbt_dynar_set_as(IPV4addr,src,char*,tmp);
 522   XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
 523
 524   tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
 525   xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
 526   XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
 527
 528   if (number_of_links == 255){
 529     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 530     number_of_links = 1;
 531     number_of_networks++;
 532   } else {
 533     number_of_links++;
 534   }
 535 }