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