Logo AND Algorithmique Numérique Distribuée

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