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 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetCard* src,
 105                              simgrid::kernel::routing::NetCard* dst, simgrid::kernel::routing::NetCard* gw_src,
 106                              simgrid::kernel::routing::NetCard* gw_dst, std::vector<Link*>* link_list)
 107 {
 108   if (link_list->size() == 1) {
 109     simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
 110
 111     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->cname(), dst->cname(), link->getName(),
 112               (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
 113     char* link_bdw = bprintf("%fBps", link->bandwidth());
 114     char* link_lat = bprintf("%fs", link->latency());
 115
 116     //   XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
 117     XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
 118
 119     // create link ns3
 120     HostNs3* host_src = nullptr;
 121     HostNs3* host_dst = nullptr;
 122     if (src->isHost())
 123       host_src = sg_host_by_name(src->cname())->extension<HostNs3>();
 124     else
 125       host_src = static_cast<HostNs3*>(xbt_lib_get_or_null(as_router_lib, src->cname(), NS3_ASR_LEVEL));
 126
 127     if (dst->isHost())
 128       host_dst = sg_host_by_name(dst->cname())->extension<HostNs3>();
 129     else
 130       host_dst = static_cast<HostNs3*>(xbt_lib_get_or_null(as_router_lib, dst->cname(), NS3_ASR_LEVEL));
 131
 132     xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->cname());
 133     xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->cname());
 134
 135     ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
 136     if (symmetrical)
 137       ns3_add_link(host_dst->node_num, host_src->node_num, link_bdw, link_lat);
 138
 139     xbt_free(link_bdw);
 140     xbt_free(link_lat);
 141   }
 142 }
 143
 144 /* Create the ns3 topology based on routing strategy */
 145 static void postparse_cb(void)
 146 {
 147   XBT_DEBUG("Starting topology generation");
 148
 149   xbt_dynar_shrink(IPV4addr,0);
 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::NetCard::onCreation.connect(ns3_add_netcard);
 181   simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
 182   simgrid::surf::on_postparse.connect(&postparse_cb);
 183   simgrid::s4u::As::onRouteCreation.connect(&routeCreation_cb);
 184
 185   HostNs3::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostNs3>();
 186
 187   NS3_ASR_LEVEL  = xbt_lib_add_level(as_router_lib, xbt_free_f);
 188
 189   LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
 190   LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
 191 }
 192
 193 NetworkNS3Model::~NetworkNS3Model() {
 194   xbt_dynar_free_container(&IPV4addr);
 195   xbt_dict_free(&flowFromSock);
 196 }
 197
 198 Link* NetworkNS3Model::createLink(const char* name, double bandwidth, double latency,
 199                                   e_surf_link_sharing_policy_t policy)
 200 {
 201   return new LinkNS3(this, name, bandwidth, latency);
 202 }
 203
 204 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 205 {
 206   return new NetworkNS3Action(this, size, src, dst);
 207 }
 208
 209 double NetworkNS3Model::nextOccuringEvent(double now)
 210 {
 211   double time_to_next_flow_completion;
 212   XBT_DEBUG("ns3_next_occuring_event");
 213
 214   //get the first relevant value from the running_actions list
 215   if (!getRunningActionSet()->size() || now == 0.0)
 216     return -1.0;
 217   else
 218     do {
 219       ns3_simulator(now);
 220       time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
 221     } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
 222
 223   XBT_DEBUG("min       : %f", now);
 224   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
 225   XBT_DEBUG("surf time : %f", surf_get_clock());
 226   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
 227
 228   return time_to_next_flow_completion;
 229 }
 230
 231 void NetworkNS3Model::updateActionsState(double now, double delta)
 232 {
 233   static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
 234
 235   /* If there are no running flows, advance the NS3 simulator and return */
 236   if (getRunningActionSet()->empty()) {
 237
 238     while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
 239       ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
 240
 241     return;
 242   }
 243
 244   xbt_dict_cursor_t cursor = nullptr;
 245   char *ns3Socket;
 246   SgFlow *sgFlow;
 247   xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
 248     NetworkNS3Action * action = sgFlow->action_;
 249     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
 250     action->setRemains(action->getCost() - sgFlow->sentBytes_);
 251
 252     if (TRACE_is_enabled() &&
 253         action->getState() == Action::State::running){
 254       double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
 255
 256       std::vector<Link*> route = std::vector<Link*>();
 257
 258       action->src_->routeTo(action->dst_, &route, nullptr);
 259       for (auto link : route)
 260         TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
 261
 262       action->lastSent_ = sgFlow->sentBytes_;
 263     }
 264
 265     if(sgFlow->finished_){
 266       xbt_dynar_push(socket_to_destroy,&ns3Socket);
 267       XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
 268       action->finish();
 269       action->setState(Action::State::done);
 270     }
 271   }
 272
 273   while (!xbt_dynar_is_empty(socket_to_destroy)){
 274     xbt_dynar_pop(socket_to_destroy,&ns3Socket);
 275
 276     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
 277       SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
 278       XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
 279     }
 280     xbt_dict_remove(flowFromSock, ns3Socket);
 281   }
 282 }
 283
 284 /************
 285  * Resource *
 286  ************/
 287
 288 LinkNS3::LinkNS3(NetworkNS3Model* model, const char* name, double bandwidth, double latency)
 289     : Link(model, name, nullptr)
 290 {
 291   bandwidth_.peak = bandwidth;
 292   latency_.peak   = latency;
 293
 294   Link::onCreation(this);
 295 }
 296
 297 LinkNS3::~LinkNS3()
 298 {
 299 }
 300
 301 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
 302 {
 303   THROW_UNIMPLEMENTED;
 304 }
 305 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
 306   xbt_die("The NS3 network model doesn't support bandwidth traces");
 307 }
 308 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
 309   xbt_die("The NS3 network model doesn't support latency traces");
 310 }
 311
 312 /**********
 313  * Action *
 314  **********/
 315
 316 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
 317     : NetworkAction(model, size, false)
 318 {
 319   XBT_DEBUG("Communicate from %s to %s", src->cname(), dst->cname());
 320
 321   src_ = src;
 322   dst_ = dst;
 323   ns3_create_flow(src, dst, surf_get_clock(), size, this);
 324
 325   Link::onCommunicate(this, src, dst);
 326 }
 327
 328 void NetworkNS3Action::suspend() {
 329   THROW_UNIMPLEMENTED;
 330 }
 331
 332 void NetworkNS3Action::resume() {
 333   THROW_UNIMPLEMENTED;
 334 }
 335
 336   /* Test whether a flow is suspended */
 337 bool NetworkNS3Action::isSuspended()
 338 {
 339   return false;
 340 }
 341
 342 int NetworkNS3Action::unref()
 343 {
 344   refcount_--;
 345   if (!refcount_) {
 346     if (action_hook.is_linked())
 347       stateSet_->erase(stateSet_->iterator_to(*this));
 348     XBT_DEBUG ("Removing action %p", this);
 349     delete this;
 350     return 1;
 351   }
 352   return 0;
 353 }
 354
 355 }
 356 }
 357
 358 void ns3_simulator(double maxSeconds)
 359 {
 360   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
 361     ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
 362   XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
 363   ns3::Simulator::Run ();
 364 }
 365
 366 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double startTime, u_int32_t TotalBytes,
 367                      simgrid::surf::NetworkNS3Action* action)
 368 {
 369   int node1 = src->extension<HostNs3>()->node_num;
 370   int node2 = dst->extension<HostNs3>()->node_num;
 371
 372   ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
 373   ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
 374
 375   char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2,char*);
 376
 377   XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
 378   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
 379   sink.Install (dst_node);
 380
 381   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket (src_node, ns3::TcpSocketFactory::GetTypeId());
 382
 383   xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr);
 384
 385   sock->Bind(ns3::InetSocketAddress(port_number));
 386   XBT_DEBUG("Create flow starting to %fs + %fs = %fs",
 387       startTime-ns3::Simulator::Now().GetSeconds(), ns3::Simulator::Now().GetSeconds(), startTime);
 388
 389   ns3::Simulator::Schedule (ns3::Seconds(startTime-ns3::Simulator::Now().GetSeconds()),
 390       &StartFlow, sock, addr, port_number);
 391
 392   port_number++;
 393   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
 394 }
 395
 396 // initialize the NS3 interface and environment
 397 void ns3_initialize(const char* TcpProtocol){
 398 //  tcpModel are:
 399 //  "ns3::TcpNewReno"
 400 //  "ns3::TcpReno"
 401 //  "ns3::TcpTahoe"
 402
 403   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
 404   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
 405
 406   if (!strcmp(TcpProtocol,"default"))
 407     return;
 408
 409   if (!strcmp(TcpProtocol,"Reno")) {
 410     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 411     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
 412     return;
 413   }
 414   if (!strcmp(TcpProtocol,"NewReno")) {
 415     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 416     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
 417     return;
 418   }
 419   if(!strcmp(TcpProtocol,"Tahoe")){
 420     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 421     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
 422     return;
 423   }
 424
 425   xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
 426 }
 427
 428 void ns3_add_cluster(const char* id, char* bw, char* lat)
 429 {
 430   ns3::NodeContainer Nodes;
 431
 432   for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
 433     Nodes.Add(Cluster_nodes.Get(i));
 434     XBT_DEBUG("Add node %d to cluster",i);
 435   }
 436   number_of_clusters_nodes = Cluster_nodes.GetN();
 437
 438   XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
 439   Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
 440
 441   xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
 442   ns3::CsmaHelper csma;
 443   csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
 444   csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
 445   ns3::NetDeviceContainer devices = csma.Install (Nodes);
 446   XBT_DEBUG("Create CSMA");
 447
 448   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
 449   XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
 450   ns3::Ipv4AddressHelper ipv4;
 451   ipv4.SetBase (adr, "255.255.0.0");
 452   free(adr);
 453   interfaces.Add(ipv4.Assign (devices));
 454
 455   if(number_of_links == 255){
 456     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 457     number_of_links = 1;
 458     number_of_networks++;
 459   }else{
 460     number_of_links++;
 461   }
 462   XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
 463 }
 464
 465 static char* transformIpv4Address (ns3::Ipv4Address from){
 466   std::stringstream sstream;
 467   sstream << from ;
 468   std::string s = sstream.str();
 469   return bprintf("%s",s.c_str());
 470 }
 471
 472 void ns3_add_link(int src, int dst, char *bw, char *lat)
 473 {
 474   ns3::PointToPointHelper pointToPoint;
 475
 476   ns3::NetDeviceContainer netA;
 477   ns3::Ipv4AddressHelper address;
 478
 479   ns3::Ptr<ns3::Node> a = nodes.Get(src);
 480   ns3::Ptr<ns3::Node> b = nodes.Get(dst);
 481
 482   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
 483   pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
 484   pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
 485
 486   netA.Add(pointToPoint.Install (a, b));
 487
 488   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
 489   address.SetBase (adr, "255.255.0.0");
 490   XBT_DEBUG("\tInterface stack '%s'",adr);
 491   free(adr);
 492   interfaces.Add(address.Assign (netA));
 493
 494   char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
 495   xbt_dynar_set_as(IPV4addr,src,char*,tmp);
 496   XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
 497
 498   tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
 499   xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
 500   XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
 501
 502   if (number_of_links == 255){
 503     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 504     number_of_links = 1;
 505     number_of_networks++;
 506   } else {
 507     number_of_links++;
 508   }
 509 }