src/surf/network_ns3.cpp

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