src/surf/network_ns3.cpp

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