src/surf/network_ns3.cpp

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