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(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->cname(), dst->cname(), link->cname(),
  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->cname(), link->bandwidth(),
  92         link->latency());
  93
  94     // create link ns3
  95     NetPointNs3* host_src = src->extension<NetPointNs3>();
  96     NetPointNs3* host_dst = dst->extension<NetPointNs3>();
  97
  98     xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->cname());
  99     xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->cname());
 100
 101     ns3_add_link(host_src, host_dst, link->bandwidth(), link->latency());
 102   } else {
 103     static bool warned_about_long_routes = false;
 104
 105     if (not warned_about_long_routes)
 106       XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with NS3.\n"
 107                "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
 108                "of length 1.\n"
 109                "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
 110                "ignored.",
 111                src->cname(), dst->cname(), link_list->size());
 112     warned_about_long_routes = true;
 113   }
 114 }
 115
 116 /* Create the ns3 topology based on routing strategy */
 117 static void postparse_cb()
 118 {
 119   IPV4addr.shrink_to_fit();
 120
 121   ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
 122   ns3::GlobalRouteManager::InitializeRoutes();
 123 }
 124
 125 /*********
 126  * Model *
 127  *********/
 128 void surf_network_model_init_NS3()
 129 {
 130   if (surf_network_model)
 131     return;
 132
 133   surf_network_model = new simgrid::surf::NetworkNS3Model();
 134   all_existing_models->push_back(surf_network_model);
 135 }
 136
 137 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
 138     "The ns3 tcp model can be : NewReno or Reno or Tahoe", "NewReno");
 139
 140 namespace simgrid {
 141 namespace surf {
 142
 143 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
 144   NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
 145
 146   ns3_initialize(ns3_tcp_model.get().c_str());
 147
 148   simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint* pt) {
 149     pt->extension_set<NetPointNs3>(new NetPointNs3());
 150     XBT_VERB("SimGrid's %s is known as node %d within NS3", pt->cname(), pt->extension<NetPointNs3>()->node_num);
 151   });
 152   simgrid::surf::on_cluster.connect(&clusterCreation_cb);
 153   simgrid::s4u::onPlatformCreated.connect(&postparse_cb);
 154   simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
 155
 156   LogComponentEnable("PacketSink", ns3::LOG_LEVEL_INFO);
 157   LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
 158   LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
 159 }
 160
 161 NetworkNS3Model::~NetworkNS3Model() {
 162   for (auto const& addr : IPV4addr)
 163     free(addr);
 164   IPV4addr.clear();
 165   xbt_dict_free(&flowFromSock);
 166 }
 167
 168 LinkImpl* NetworkNS3Model::createLink(const char* name, double bandwidth, double latency,
 169                                       e_surf_link_sharing_policy_t policy)
 170 {
 171   return new LinkNS3(this, name, bandwidth, latency);
 172 }
 173
 174 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 175 {
 176   return new NetworkNS3Action(this, size, src, dst);
 177 }
 178
 179 double NetworkNS3Model::nextOccuringEvent(double now)
 180 {
 181   double time_to_next_flow_completion;
 182   XBT_DEBUG("ns3_next_occuring_event");
 183
 184   //get the first relevant value from the running_actions list
 185   if (not getRunningActionSet()->size() || now == 0.0)
 186     return -1.0;
 187   else
 188     do {
 189       ns3_simulator(now);
 190       time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
 191     } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
 192
 193   XBT_DEBUG("min       : %f", now);
 194   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
 195   XBT_DEBUG("surf time : %f", surf_get_clock());
 196   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
 197
 198   return time_to_next_flow_completion;
 199 }
 200
 201 void NetworkNS3Model::updateActionsState(double now, double delta)
 202 {
 203   static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
 204
 205   /* If there are no running flows, advance the NS3 simulator and return */
 206   if (getRunningActionSet()->empty()) {
 207
 208     while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
 209       ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
 210
 211     return;
 212   }
 213
 214   xbt_dict_cursor_t cursor = nullptr;
 215   char *ns3Socket;
 216   SgFlow *sgFlow;
 217   xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
 218     NetworkNS3Action * action = sgFlow->action_;
 219     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
 220     action->setRemains(action->getCost() - sgFlow->sentBytes_);
 221
 222     if (TRACE_is_enabled() &&
 223         action->getState() == Action::State::running){
 224       double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
 225
 226       std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
 227
 228       action->src_->routeTo(action->dst_, &route, nullptr);
 229       for (auto const& link : route)
 230         TRACE_surf_link_set_utilization(link->cname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
 231                                         delta);
 232
 233       action->lastSent_ = sgFlow->sentBytes_;
 234     }
 235
 236     if(sgFlow->finished_){
 237       xbt_dynar_push(socket_to_destroy,&ns3Socket);
 238       XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
 239       action->finish();
 240       action->setState(Action::State::done);
 241     }
 242   }
 243
 244   while (not xbt_dynar_is_empty(socket_to_destroy)) {
 245     xbt_dynar_pop(socket_to_destroy,&ns3Socket);
 246
 247     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
 248       SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
 249       XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
 250     }
 251     xbt_dict_remove(flowFromSock, ns3Socket);
 252   }
 253 }
 254
 255 /************
 256  * Resource *
 257  ************/
 258
 259 LinkNS3::LinkNS3(NetworkNS3Model* model, const char* name, double bandwidth, double latency)
 260     : LinkImpl(model, name, nullptr)
 261 {
 262   bandwidth_.peak = bandwidth;
 263   latency_.peak   = latency;
 264
 265   s4u::Link::onCreation(this->piface_);
 266 }
 267
 268 LinkNS3::~LinkNS3() = default;
 269
 270 void LinkNS3::apply_event(tmgr_trace_event_t event, double value)
 271 {
 272   THROW_UNIMPLEMENTED;
 273 }
 274 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
 275   xbt_die("The NS3 network model doesn't support bandwidth traces");
 276 }
 277 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
 278   xbt_die("The NS3 network model doesn't support latency traces");
 279 }
 280
 281 /**********
 282  * Action *
 283  **********/
 284
 285 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
 286     : NetworkAction(model, size, false)
 287 {
 288   XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname());
 289
 290   src_ = src;
 291   dst_ = dst;
 292   ns3_create_flow(src, dst, size, this);
 293
 294   s4u::Link::onCommunicate(this, src, dst);
 295 }
 296
 297 void NetworkNS3Action::suspend() {
 298   THROW_UNIMPLEMENTED;
 299 }
 300
 301 void NetworkNS3Action::resume() {
 302   THROW_UNIMPLEMENTED;
 303 }
 304
 305 std::list<LinkImpl*> NetworkNS3Action::links()
 306 {
 307   THROW_UNIMPLEMENTED;
 308 }
 309
 310 /* Test whether a flow is suspended */
 311 bool NetworkNS3Action::isSuspended()
 312 {
 313   return false;
 314 }
 315
 316 int NetworkNS3Action::unref()
 317 {
 318   refcount_--;
 319   if (not refcount_) {
 320     if (action_hook.is_linked())
 321       stateSet_->erase(stateSet_->iterator_to(*this));
 322     XBT_DEBUG ("Removing action %p", this);
 323     delete this;
 324     return 1;
 325   }
 326   return 0;
 327 }
 328
 329 }
 330 }
 331
 332 void ns3_simulator(double maxSeconds)
 333 {
 334   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
 335     ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
 336   XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
 337   ns3::Simulator::Run ();
 338 }
 339
 340 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst,
 341     u_int32_t TotalBytes,
 342     simgrid::surf::NetworkNS3Action* action) {
 343   unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
 344   unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
 345
 346   ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
 347   ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
 348
 349   xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
 350              dst->pimpl_netpoint->cname());
 351   char* addr = IPV4addr.at(node2);
 352   xbt_assert(addr != nullptr, "Element %s is unknown to NS3. Is it connected to any one-hop link?",
 353              dst->pimpl_netpoint->cname());
 354
 355   XBT_DEBUG("ns3_create_flow %u Bytes from %u to %u with Interface %s", TotalBytes, node1, node2, addr);
 356   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
 357   sink.Install (dst_node);
 358
 359   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
 360
 361   xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr);
 362
 363   sock->Bind(ns3::InetSocketAddress(port_number));
 364
 365   ns3::Simulator::ScheduleNow(&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 (1000));
 379   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
 380   ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
 381
 382   if (not strcmp(TcpProtocol, "default"))
 383     return;
 384
 385   if (not 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 (not 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 (not 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, double bw, double lat) {
 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 %u to cluster", i);
 410   }
 411   number_of_clusters_nodes = Cluster_nodes.GetN();
 412
 413   XBT_DEBUG("Add router %u 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.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
 419   csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(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: %u", 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(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
 448   ns3::PointToPointHelper pointToPoint;
 449
 450   ns3::Ipv4AddressHelper address;
 451
 452   int srcNum = src->node_num;
 453   int dstNum = dst->node_num;
 454
 455   ns3::Ptr<ns3::Node> a = nodes.Get(srcNum);
 456   ns3::Ptr<ns3::Node> b = nodes.Get(dstNum);
 457
 458   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
 459   pointToPoint.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
 460   pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 461
 462   char *filename = bprintf("link-%d-%d.tr", srcNum, dstNum);
 463   ns3::AsciiTraceHelper ascii;
 464   pointToPoint.EnableAsciiAll (ascii.CreateFileStream (filename));
 465   pointToPoint.EnablePcapAll ("tcp-bulk-send", false);
 466   xbt_free(filename);
 467
 468   ns3::NetDeviceContainer netA;
 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)srcNum)
 478     IPV4addr.resize(srcNum + 1, nullptr);
 479   IPV4addr.at(srcNum) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
 480
 481   if (IPV4addr.size() <= (unsigned)dstNum)
 482     IPV4addr.resize(dstNum + 1, nullptr);
 483   IPV4addr.at(dstNum) = 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 }