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