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