src/surf/network_ns3.cpp

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