src/kernel/resource/models/network_ns3.cpp

   1 /* Copyright (c) 2007-2023. 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 "simgrid/plugins/ns3.hpp"
   7
   8 #include <random>
   9 #include <string>
  10 #include <unordered_set>
  11
  12 #include "xbt/config.hpp"
  13 #include "xbt/str.h"
  14 #include "xbt/string.hpp"
  15 #include "xbt/utility.hpp"
  16
  17 #include <ns3/application-container.h>
  18 #include <ns3/core-module.h>
  19 #include <ns3/csma-helper.h>
  20 #include <ns3/event-id.h>
  21 #include <ns3/global-route-manager.h>
  22 #include <ns3/internet-stack-helper.h>
  23 #include <ns3/ipv4-address-helper.h>
  24 #include <ns3/ipv4-global-routing-helper.h>
  25 #include <ns3/packet-sink-helper.h>
  26 #include <ns3/point-to-point-helper.h>
  27
  28 #include "ns3/mobility-module.h"
  29 #include "ns3/wifi-module.h"
  30
  31 #include "network_ns3.hpp"
  32 #include "src/kernel/resource/models/ns3/ns3_simulator.hpp"
  33
  34 #include "simgrid/kernel/routing/NetPoint.hpp"
  35 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
  36 #include "simgrid/kernel/routing/WifiZone.hpp"
  37 #include "simgrid/plugins/energy.h"
  38 #include "simgrid/s4u/Engine.hpp"
  39 #include "simgrid/s4u/NetZone.hpp"
  40 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the signals
  41 #include "src/kernel/EngineImpl.hpp"
  42 #include "src/kernel/xml/platf_private.hpp" // ClusterCreationArgs
  43
  44 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_ns3, res_network, "Network model based on ns-3");
  45
  46 /*****************
  47  * Crude globals *
  48  *****************/
  49
  50 extern std::map<std::string, SgFlow*, std::less<>> flow_from_sock;
  51 extern std::map<std::string, ns3::ApplicationContainer, std::less<>> sink_from_sock;
  52
  53 static int number_of_links    = 1;
  54 static int number_of_networks = 1;
  55
  56 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
  57
  58 static std::string transformIpv4Address(ns3::Ipv4Address from)
  59 {
  60   std::stringstream sstream;
  61   sstream << from;
  62   return sstream.str();
  63 }
  64
  65 NetPointNs3::NetPointNs3()
  66 {
  67   static ns3::InternetStackHelper stack;
  68   stack.Install(ns3_node_);
  69 }
  70
  71 static void resumeWifiDevice(ns3::Ptr<ns3::WifiNetDevice> device)
  72 {
  73   device->GetPhy()->ResumeFromOff();
  74 }
  75
  76 /*************
  77  * Callbacks *
  78  *************/
  79
  80 static void zoneCreation_cb(simgrid::s4u::NetZone const& zone)
  81 {
  82   auto const* wifizone = dynamic_cast<simgrid::kernel::routing::WifiZone*>(zone.get_impl());
  83   if (wifizone == nullptr)
  84     return;
  85
  86   /* wifi globals */
  87   static ns3::WifiHelper wifi;
  88 #if NS3_MINOR_VERSION < 33
  89   static ns3::YansWifiPhyHelper wifiPhy = ns3::YansWifiPhyHelper::Default();
  90 #else
  91   static ns3::YansWifiPhyHelper wifiPhy;
  92 #endif
  93   static ns3::YansWifiChannelHelper wifiChannel = ns3::YansWifiChannelHelper::Default();
  94   static ns3::WifiMacHelper wifiMac;
  95   static ns3::MobilityHelper mobility;
  96
  97 #if NS3_MINOR_VERSION < 32
  98   wifi.SetStandard(ns3::WIFI_PHY_STANDARD_80211n_5GHZ);
  99 #elif NS3_MINOR_VERSION < 36
 100   wifi.SetStandard(ns3::WIFI_STANDARD_80211n_5GHZ);
 101 #else
 102   wifi.SetStandard(ns3::WIFI_STANDARD_80211n);
 103   wifiPhy.Set("ChannelSettings", ns3::StringValue("{0, 0, BAND_5GHZ, 0}"));
 104 #endif
 105
 106   std::string ssid = wifizone->get_name();
 107   const char* mcs  = wifizone->get_property("mcs");
 108   const char* nss  = wifizone->get_property("nss");
 109   int mcs_value    = mcs ? atoi(mcs) : 3;
 110   int nss_value    = nss ? atoi(nss) : 1;
 111 #if NS3_MINOR_VERSION < 30
 112   xbt_assert(nss_value == 1 + (mcs_value / 8),
 113              "On NS3 < 3.30, NSS value has to satisfy NSS == 1+(MCS/8) constraint. Bailing out");
 114 #endif
 115   wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager", "ControlMode", ns3::StringValue("HtMcs0"), "DataMode",
 116                                ns3::StringValue("HtMcs" + std::to_string(mcs_value)));
 117   wifiPhy.SetChannel(wifiChannel.Create());
 118   wifiPhy.Set("Antennas", ns3::UintegerValue(nss_value));
 119   wifiPhy.Set("MaxSupportedTxSpatialStreams", ns3::UintegerValue(nss_value));
 120   wifiPhy.Set("MaxSupportedRxSpatialStreams", ns3::UintegerValue(nss_value));
 121 #if NS3_MINOR_VERSION > 33
 122   wifiPhy.Set("ChannelWidth", ns3::UintegerValue(40));
 123 #endif
 124   wifiMac.SetType("ns3::ApWifiMac", "Ssid", ns3::SsidValue(ssid));
 125
 126   mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
 127   ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator>();
 128   positionAllocS->Add(ns3::Vector(0, 0, 255 * 100 * number_of_networks + 100 * number_of_links));
 129
 130   ns3::NetDeviceContainer netDevices;
 131   NetPointNs3* access_point_netpoint_ns3 = wifizone->get_access_point()->extension<NetPointNs3>();
 132
 133   ns3::Ptr<ns3::Node> access_point_ns3_node = access_point_netpoint_ns3->ns3_node_;
 134   ns3::NodeContainer nodes                  = {access_point_ns3_node};
 135   std::vector<NetPointNs3*> hosts_netpoints = {access_point_netpoint_ns3};
 136   netDevices.Add(wifi.Install(wifiPhy, wifiMac, access_point_ns3_node));
 137
 138   wifiMac.SetType("ns3::StaWifiMac", "Ssid", ns3::SsidValue(ssid), "ActiveProbing", ns3::BooleanValue(false));
 139
 140   NetPointNs3* station_netpoint_ns3    = nullptr;
 141   ns3::Ptr<ns3::Node> station_ns3_node = nullptr;
 142   double distance;
 143   double angle     = 0;
 144   auto nb_stations = static_cast<double>(wifizone->get_all_hosts().size() - 1);
 145   double step      = 2 * M_PI / nb_stations;
 146   for (const auto* station_host : wifizone->get_all_hosts()) {
 147     station_netpoint_ns3 = station_host->get_netpoint()->extension<NetPointNs3>();
 148     if (station_netpoint_ns3 == access_point_netpoint_ns3)
 149       continue;
 150     hosts_netpoints.push_back(station_netpoint_ns3);
 151     distance = station_host->get_property("wifi_distance") ? atof(station_host->get_property("wifi_distance")) : 10.0;
 152     positionAllocS->Add(ns3::Vector(distance * std::cos(angle), distance * std::sin(angle),
 153                                     255 * 100 * number_of_networks + 100 * number_of_links));
 154     angle += step;
 155     station_ns3_node = station_netpoint_ns3->ns3_node_;
 156     nodes.Add(station_ns3_node);
 157     netDevices.Add(wifi.Install(wifiPhy, wifiMac, station_ns3_node));
 158   }
 159
 160   const char* start_time = wifizone->get_property("start_time");
 161   int start_time_value   = start_time ? atoi(start_time) : 0;
 162   for (uint32_t i = 0; i < netDevices.GetN(); i++) {
 163     ns3::Ptr<ns3::WifiNetDevice> device = ns3::StaticCast<ns3::WifiNetDevice>(netDevices.Get(i));
 164     device->GetPhy()->SetOffMode();
 165     ns3::Simulator::Schedule(ns3::Seconds(start_time_value), &resumeWifiDevice, device);
 166   }
 167
 168 #if NS3_MINOR_VERSION < 33
 169   // This fails with "The channel width does not uniquely identify an operating channel" on v3.34,
 170   // so we specified the ChannelWidth of wifiPhy to 40, above, when creating wifiPhy with v3.34 and higher
 171   ns3::Config::Set("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue(40));
 172 #endif
 173
 174   mobility.SetPositionAllocator(positionAllocS);
 175   mobility.Install(nodes);
 176   ns3::Ipv4AddressHelper address;
 177   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 178   address.SetBase(addr.c_str(), "255.255.0.0");
 179   XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
 180   ns3::Ipv4InterfaceContainer addresses = address.Assign(netDevices);
 181   for (unsigned int i = 0; i < hosts_netpoints.size(); i++) {
 182     hosts_netpoints[i]->ipv4_address_ = transformIpv4Address(addresses.GetAddress(i));
 183   }
 184
 185   if (number_of_links == 255) {
 186     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 187     number_of_links = 1;
 188     number_of_networks++;
 189   } else {
 190     number_of_links++;
 191   }
 192   /* in theory we can compute the routing table only only once at the platform seal
 193    *  however put it here since or platform_created signal is called before the seal right now */
 194   ns3::Ipv4GlobalRoutingHelper::RecomputeRoutingTables();
 195 }
 196
 197 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
 198 {
 199   ns3::NodeContainer Nodes;
 200
 201   xbt_assert(cluster.topology == simgrid::kernel::routing::ClusterTopology::FLAT,
 202              "NS-3 is supported only by flat clusters. Do not use with other topologies");
 203
 204   for (int const& i : cluster.radicals) {
 205     // Create private link
 206     std::string host_id = cluster.prefix + std::to_string(i) + cluster.suffix;
 207     auto const* src     = simgrid::s4u::Host::by_name(host_id)->get_netpoint();
 208     auto const* dst     = simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(cluster.router_id);
 209     xbt_assert(dst != nullptr, "No router named %s", cluster.router_id.c_str());
 210
 211     ns3_add_direct_route(src, dst, cluster.bw, cluster.lat, cluster.sharing_policy); // Any ns-3 route is symmetrical
 212
 213     // Also add the host to the list of hosts that will be connected to the backbone
 214     Nodes.Add(src->extension<NetPointNs3>()->ns3_node_);
 215   }
 216
 217   // Create link backbone
 218
 219   xbt_assert(Nodes.GetN() <= 65000, "Cluster with ns-3 is limited to 65000 nodes");
 220   ns3::CsmaHelper csma;
 221   csma.SetChannelAttribute("DataRate",
 222                            ns3::DataRateValue(ns3::DataRate(
 223                                static_cast<uint64_t>(cluster.bb_bw * 8)))); // ns-3 takes bps, but we provide Bps
 224   csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(cluster.bb_lat)));
 225   ns3::NetDeviceContainer devices = csma.Install(Nodes);
 226   XBT_DEBUG("Create CSMA");
 227
 228   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 229   XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
 230   ns3::Ipv4AddressHelper ipv4;
 231   ipv4.SetBase(addr.c_str(), "255.255.0.0");
 232   ipv4.Assign(devices);
 233
 234   if (number_of_links == 255) {
 235     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 236     number_of_links = 1;
 237     number_of_networks++;
 238   } else {
 239     number_of_links++;
 240   }
 241 }
 242
 243 static void routeCreation_cb(bool symmetrical, const simgrid::kernel::routing::NetPoint* src,
 244                              const simgrid::kernel::routing::NetPoint* dst,
 245                              const simgrid::kernel::routing::NetPoint* /*gw_src*/,
 246                              const simgrid::kernel::routing::NetPoint* /*gw_dst*/,
 247                              std::vector<simgrid::kernel::resource::StandardLinkImpl*> const& link_list)
 248 {
 249   /* ignoring routes from StarZone, not supported */
 250   if (not src || not dst)
 251     return;
 252
 253   if (link_list.size() == 1) {
 254     auto const* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
 255
 256     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s %s", src->get_cname(), dst->get_cname(), link->get_cname(),
 257               (link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI ? "(wifi)" : "(wired)"),
 258               (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
 259
 260     XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->get_cname(), link->get_bandwidth(), link->get_latency());
 261
 262     ns3_add_direct_route(src, dst, link->get_bandwidth(), link->get_latency(), link->get_sharing_policy());
 263   } else if (static bool warned_about_long_routes = false; not warned_about_long_routes) {
 264     XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with ns-3.\n"
 265              "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
 266              "of length 1.\n"
 267              "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
 268              "ignored.",
 269              src->get_cname(), dst->get_cname(), link_list.size());
 270     warned_about_long_routes = true;
 271   }
 272 }
 273
 274 /*********
 275  * Model *
 276  *********/
 277 // We can't use SIMGRID_REGISTER_NETWORK_MODEL here because ns-3 has a dash in its name
 278 static void XBT_ATTRIB_CONSTRUCTOR(800) simgrid_ns3_network_model_register()
 279 {
 280   simgrid_network_models().add(
 281       "ns-3", "Network pseudo-model using the real ns-3 simulator instead of an analytic model", []() {
 282         auto net_model = std::make_shared<simgrid::kernel::resource::NetworkNS3Model>("NS3 network model");
 283         auto* engine   = simgrid::kernel::EngineImpl::get_instance();
 284         engine->add_model(net_model);
 285         engine->get_netzone_root()->set_network_model(net_model);
 286       });
 287 }
 288
 289 static simgrid::config::Flag<std::string>
 290     ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be: NewReno or Reno or Tahoe", "default");
 291 static simgrid::config::Flag<std::string> ns3_seed(
 292     "ns3/seed",
 293     "The random seed provided to ns-3. Either 'time' to seed with time(), blank to not set (default), or a number.", "",
 294     [](const std::string& val) {
 295       if (val.length() == 0)
 296         return;
 297       if (strcasecmp(val.c_str(), "time") == 0) {
 298         std::default_random_engine prng(time(nullptr));
 299         ns3::RngSeedManager::SetSeed(static_cast<uint32_t>(prng()));
 300         ns3::RngSeedManager::SetRun(static_cast<uint64_t>(prng()));
 301       } else {
 302         auto v = static_cast<int>(xbt_str_parse_int(
 303             val.c_str(), "Invalid value for option ns3/seed. It must be either 'time', a number, or left empty."));
 304         ns3::RngSeedManager::SetSeed(v);
 305         ns3::RngSeedManager::SetRun(v);
 306       }
 307     });
 308
 309 namespace simgrid {
 310 namespace kernel::resource {
 311
 312 NetworkNS3Model::NetworkNS3Model(const std::string& name) : NetworkModel(name)
 313 {
 314   xbt_assert(not sg_link_energy_is_inited(),
 315              "LinkEnergy plugin and ns-3 network models are not compatible. Are you looking for Ecofen, maybe?");
 316
 317   NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create<NetPointNs3>();
 318
 319   ns3::Config::SetDefault("ns3::TcpSocket::SegmentSize", ns3::UintegerValue(1000));
 320   ns3::Config::SetDefault("ns3::TcpSocket::DelAckCount", ns3::UintegerValue(1));
 321   ns3::Config::SetDefault("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue(false));
 322
 323   if (auto const& TcpProtocol = ns3_tcp_model.get(); TcpProtocol == "default") {
 324     /* nothing to do */
 325
 326   } else if (TcpProtocol == "Reno" || TcpProtocol == "NewReno" || TcpProtocol == "Tahoe") {
 327     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 328     ns3::Config::SetDefault("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::Tcp" + TcpProtocol));
 329
 330   } else {
 331     xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
 332   }
 333
 334   routing::NetPoint::on_creation.connect([](routing::NetPoint& pt) {
 335     pt.extension_set<NetPointNs3>(new NetPointNs3());
 336     XBT_VERB("Declare SimGrid's %s within ns-3", pt.get_cname());
 337   });
 338
 339   s4u::Engine::on_platform_created_cb([]() {
 340     /* Create the ns3 topology based on routing strategy */
 341     ns3::GlobalRouteManager::DeleteGlobalRoutes(); // just in case this callback is called twice
 342     ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
 343     ns3::GlobalRouteManager::InitializeRoutes();
 344   });
 345   routing::on_cluster_creation.connect(&clusterCreation_cb);
 346   routing::NetZoneImpl::on_route_creation.connect(&routeCreation_cb);
 347   s4u::NetZone::on_seal_cb(&zoneCreation_cb);
 348 }
 349
 350 NetworkNS3Model::~NetworkNS3Model()
 351 {
 352   ns3::Simulator::Destroy();
 353 }
 354
 355 StandardLinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
 356 {
 357   xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
 358   auto* link = new LinkNS3(name, bandwidths[0]);
 359   link->set_model(this);
 360   return link;
 361 }
 362
 363 StandardLinkImpl* NetworkNS3Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
 364 {
 365   auto* link = create_link(name, bandwidths);
 366   link->set_sharing_policy(s4u::Link::SharingPolicy::WIFI, {});
 367   return link;
 368 }
 369
 370 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate, bool /*streamed*/)
 371 {
 372   xbt_assert(rate == -1,
 373              "Communication over ns-3 links cannot specify a specific rate. Please use -1 as a value instead of %f.",
 374              rate);
 375   return new NetworkNS3Action(this, size, src, dst);
 376 }
 377
 378 double NetworkNS3Model::next_occurring_event(double now)
 379 {
 380   double time_to_next_flow_completion = 0.0;
 381   XBT_DEBUG("ns3_next_occurring_event");
 382
 383   // get the first relevant value from the running_actions list
 384
 385   // If there is no comms in NS-3, then we do not move it forward.
 386   // We will synchronize NS-3 with SimGrid when starting a new communication.
 387   // (see NetworkNS3Action::NetworkNS3Action() for more details on this point)
 388   if (get_started_action_set()->empty() || now == 0.0)
 389     return -1.0;
 390
 391   XBT_DEBUG("doing a ns3 simulation for a duration of %f", now);
 392   ns3_simulator(now);
 393   time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - EngineImpl::get_clock();
 394   // NS-3 stops as soon as a flow ends,
 395   // but it does not process the other flows that may finish at the same (simulated) time.
 396   // If another flow ends at the same time, time_to_next_flow_completion = 0
 397   if (double_equals(time_to_next_flow_completion, 0, sg_precision_timing))
 398     time_to_next_flow_completion = 0.0;
 399
 400   XBT_DEBUG("min         : %f", now);
 401   XBT_DEBUG("ns-3 time   : %f", ns3::Simulator::Now().GetSeconds());
 402   XBT_DEBUG("simgrid time: %f", EngineImpl::get_clock());
 403   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
 404
 405   return time_to_next_flow_completion;
 406 }
 407
 408 void NetworkNS3Model::update_actions_state(double now, double delta)
 409 {
 410   static std::vector<std::string> socket_to_destroy;
 411
 412   for (const auto& [ns3_socket, sgFlow] : flow_from_sock) {
 413     NetworkNS3Action* action = sgFlow->action_;
 414     XBT_DEBUG("Processing flow %p (socket %s, action %p)", sgFlow, ns3_socket.c_str(), action);
 415     // Because NS3 stops as soon as a flow is finished, the other flows that ends at the same time may remains in an
 416     // inconsistent state (i.e. remains_ == 0 but finished_ == false).
 417     // However, SimGrid considers sometimes that an action with remains_ == 0 is finished.
 418     // Thus, to avoid inconsistencies between SimGrid and NS3, set remains to 0 only when the flow is finished in NS3
 419     double remains = action->get_cost() - sgFlow->sent_bytes_;
 420     if (remains > 0)
 421       action->set_remains(remains);
 422
 423     if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) {
 424       double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_;
 425
 426       std::vector<StandardLinkImpl*> route;
 427       action->get_src().route_to(&action->get_dst(), route, nullptr);
 428       for (auto const& link : route)
 429         instr::resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(),
 430                                         data_delta_sent / delta, now - delta, delta);
 431
 432       action->last_sent_ = sgFlow->sent_bytes_;
 433     }
 434
 435     if ((sgFlow->finished_) && (remains <= 0)) { // finished_ should not become true before remains gets to 0, but it
 436                                                  // sometimes does. Let's play safe, here.
 437       socket_to_destroy.push_back(ns3_socket);
 438       XBT_DEBUG("Destroy socket %s of action %p", ns3_socket.c_str(), action);
 439       action->set_remains(0);
 440       action->finish(Action::State::FINISHED);
 441     } else {
 442       XBT_DEBUG("Socket %s sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
 443                 sgFlow->total_bytes_, sgFlow->remaining_);
 444     }
 445   }
 446
 447   while (not socket_to_destroy.empty()) {
 448     std::string ns3_socket = socket_to_destroy.back();
 449     socket_to_destroy.pop_back();
 450     SgFlow* flow = flow_from_sock.at(ns3_socket);
 451     if (XBT_LOG_ISENABLED(res_ns3, xbt_log_priority_debug)) {
 452       XBT_DEBUG("Removing socket %s of action %p", ns3_socket.c_str(), flow->action_);
 453     }
 454     delete flow;
 455     flow_from_sock.erase(ns3_socket);
 456     sink_from_sock.erase(ns3_socket);
 457   }
 458 }
 459
 460 /************
 461  * Resource *
 462  ************/
 463
 464 LinkNS3::LinkNS3(const std::string& name, double bandwidth) : StandardLinkImpl(name)
 465 {
 466   bandwidth_.peak = bandwidth;
 467 }
 468
 469 LinkNS3::~LinkNS3() = default;
 470
 471 void LinkNS3::apply_event(profile::Event*, double)
 472 {
 473   THROW_UNIMPLEMENTED;
 474 }
 475
 476 void LinkNS3::set_bandwidth_profile(profile::Profile* profile)
 477 {
 478   xbt_assert(profile == nullptr, "The ns-3 network model doesn't support bandwidth profiles");
 479 }
 480
 481 void LinkNS3::set_latency_profile(profile::Profile* profile)
 482 {
 483   xbt_assert(profile == nullptr, "The ns-3 network model doesn't support latency profiles");
 484 }
 485
 486 void LinkNS3::set_latency(double latency)
 487 {
 488   latency_.peak = latency;
 489 }
 490
 491 void LinkNS3::set_sharing_policy(s4u::Link::SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
 492 {
 493   sharing_policy_ = policy;
 494 }
 495 /**********
 496  * Action *
 497  **********/
 498
 499 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
 500     : NetworkAction(model, *src, *dst, totalBytes, false)
 501 {
 502   // ns-3 fails when src = dst, so avoid the problem by considering that communications are infinitely fast on the
 503   // loopback that does not exists
 504   if (src == dst) {
 505     if (static bool warned = false; not warned) {
 506       XBT_WARN("Sending from a host %s to itself is not supported by ns-3. Every such communication finishes "
 507                "immediately upon startup.",
 508                src->get_cname());
 509       warned = true;
 510     }
 511     finish(Action::State::FINISHED);
 512     return;
 513   }
 514
 515   // If there is no other started actions, we need to move NS-3 forward to be sync with SimGrid
 516   if (model->get_started_action_set()->size() == 1) {
 517     while (double_positive(EngineImpl::get_clock() - ns3::Simulator::Now().GetSeconds(), sg_precision_timing)) {
 518       XBT_DEBUG("Synchronizing NS-3 (time %f) with SimGrid (time %f)", ns3::Simulator::Now().GetSeconds(),
 519                 EngineImpl::get_clock());
 520       ns3_simulator(EngineImpl::get_clock() - ns3::Simulator::Now().GetSeconds());
 521     }
 522   }
 523
 524   static uint16_t port_number = 1;
 525
 526   ns3::Ptr<ns3::Node> src_node = get_ns3node_from_sghost(src);
 527   ns3::Ptr<ns3::Node> dst_node = get_ns3node_from_sghost(dst);
 528
 529   const std::string& addr = dst->get_netpoint()->extension<NetPointNs3>()->ipv4_address_;
 530   xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
 531              dst->get_netpoint()->get_cname());
 532
 533   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
 534   ns3::ApplicationContainer apps = sink.Install(dst_node);
 535
 536   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
 537
 538   XBT_DEBUG("Create socket %s for a flow of %.0f Bytes from %s to %s with Interface %s",
 539             transform_socket_ptr(sock).c_str(), totalBytes, src->get_cname(), dst->get_cname(), addr.c_str());
 540
 541   flow_from_sock.try_emplace(transform_socket_ptr(sock), new SgFlow(static_cast<uint32_t>(totalBytes), this));
 542   sink_from_sock.try_emplace(transform_socket_ptr(sock), apps);
 543
 544   sock->Bind(ns3::InetSocketAddress(port_number));
 545   ns3::Simulator::ScheduleNow(&start_flow, sock, addr.c_str(), port_number);
 546
 547   port_number = 1 + (port_number % UINT16_MAX);
 548   if (port_number == 1)
 549     XBT_WARN("Too many connections! Port number is saturated. Trying to use the oldest ports.");
 550 }
 551
 552 void NetworkNS3Action::suspend()
 553 {
 554   THROW_UNIMPLEMENTED;
 555 }
 556
 557 void NetworkNS3Action::resume()
 558 {
 559   THROW_UNIMPLEMENTED;
 560 }
 561
 562 std::list<StandardLinkImpl*> NetworkNS3Action::get_links() const
 563 {
 564   THROW_UNIMPLEMENTED;
 565 }
 566 void NetworkNS3Action::update_remains_lazy(double /*now*/)
 567 {
 568   THROW_IMPOSSIBLE;
 569 }
 570
 571 } // namespace kernel::resource
 572
 573 ns3::Ptr<ns3::Node> get_ns3node_from_sghost(const simgrid::s4u::Host* host)
 574 {
 575   xbt_assert(host->get_netpoint()->extension<NetPointNs3>() != nullptr, "Please only use this function on ns-3 nodes");
 576   return host->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
 577 }
 578 } // namespace simgrid
 579
 580 void ns3_simulator(double maxSeconds)
 581 {
 582   ns3::EventId id;
 583   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
 584     id = ns3::Simulator::Schedule(ns3::Seconds(maxSeconds), &ns3::Simulator::Stop);
 585
 586   XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, simgrid::kernel::EngineImpl::get_clock());
 587   ns3::Simulator::Run();
 588   XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds());
 589
 590   if (maxSeconds > 0.0)
 591     id.Cancel();
 592 }
 593
 594 void ns3_add_direct_route(const simgrid::kernel::routing::NetPoint* src, const simgrid::kernel::routing::NetPoint* dst,
 595                           double bw, double lat, simgrid::s4u::Link::SharingPolicy policy)
 596 {
 597   ns3::Ipv4AddressHelper address;
 598   ns3::NetDeviceContainer netA;
 599
 600   // create link ns3
 601   auto* host_src = src->extension<NetPointNs3>();
 602   auto* host_dst = dst->extension<NetPointNs3>();
 603
 604   xbt_assert(host_src != nullptr, "Network element %s does not seem to be ns-3-ready", src->get_cname());
 605   xbt_assert(host_dst != nullptr, "Network element %s does not seem to be ns-3-ready", dst->get_cname());
 606
 607   xbt_assert(policy != simgrid::s4u::Link::SharingPolicy::WIFI,
 608              "The wifi sharing policy is not supported for links. You want to use a wifi zone (see documentation).");
 609
 610   ns3::PointToPointHelper pointToPoint;
 611
 612   XBT_DEBUG("\tAdd PTP from %s to %s bw:'%f Bps' lat:'%fs'", src->get_cname(), dst->get_cname(), bw, lat);
 613   pointToPoint.SetDeviceAttribute(
 614       "DataRate",
 615       ns3::DataRateValue(ns3::DataRate(static_cast<uint64_t>(bw * 8)))); // ns-3 takes bps, but we provide Bps
 616   pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 617
 618   netA.Add(pointToPoint.Install(host_src->ns3_node_, host_dst->ns3_node_));
 619
 620   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 621   address.SetBase(addr.c_str(), "255.255.0.0");
 622   XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
 623
 624   auto addresses = address.Assign(netA);
 625
 626   host_src->ipv4_address_ = transformIpv4Address(addresses.GetAddress(0));
 627   host_dst->ipv4_address_ = transformIpv4Address(addresses.GetAddress(1));
 628
 629   if (number_of_links == 255) {
 630     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 631     number_of_links = 1;
 632     number_of_networks++;
 633   } else {
 634     number_of_links++;
 635   }
 636 }