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