src/surf/network_ns3.cpp

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