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