src/surf/network_ns3.cpp

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