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