Logo AND Algorithmique Numérique Distribuée

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