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