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