Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
bf32756238fef659b3347c0347310dad78cf97dc
[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/string.hpp"
11 #include "xbt/utility.hpp"
12
13 #include <ns3/core-module.h>
14 #include <ns3/csma-helper.h>
15 #include <ns3/global-route-manager.h>
16 #include <ns3/internet-stack-helper.h>
17 #include <ns3/ipv4-address-helper.h>
18 #include <ns3/packet-sink-helper.h>
19 #include <ns3/point-to-point-helper.h>
20 #include <ns3/application-container.h>
21 #include <ns3/event-id.h>
22
23 #include "network_ns3.hpp"
24 #include "ns3/ns3_simulator.hpp"
25
26 #include "simgrid/kernel/routing/NetPoint.hpp"
27 #include "simgrid/plugins/energy.h"
28 #include "simgrid/s4u/Engine.hpp"
29 #include "simgrid/s4u/NetZone.hpp"
30 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
31 #include "src/surf/surf_interface.hpp"
32 #include "src/surf/xml/platf_private.hpp"
33 #include "surf/surf.hpp"
34
35 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network ns-3 module");
36
37 std::vector<std::string> IPV4addr;
38
39 /*****************
40  * Crude globals *
41  *****************/
42
43 extern std::map<std::string, SgFlow*> flow_from_sock;
44 extern std::map<std::string, ns3::ApplicationContainer> sink_from_sock;
45
46 static ns3::InternetStackHelper stack;
47 static ns3::NodeContainer nodes;
48 static ns3::NodeContainer Cluster_nodes;
49 static ns3::Ipv4InterfaceContainer interfaces;
50
51 static int number_of_nodes = 0;
52 static int number_of_clusters_nodes = 0;
53 static int number_of_links = 1;
54 static int number_of_networks = 1;
55
56 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
57
58 NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject<ns3::Node>(0))
59 {
60   stack.Install(ns3_node_);
61   Cluster_nodes.Add(ns3_node_);
62   nodes.Add(ns3_node_);
63   node_num = number_of_nodes++;
64 }
65
66 /*************
67  * Callbacks *
68  *************/
69
70 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
71 {
72   for (int const& i : *cluster.radicals) {
73     // Routers don't create a router on the other end of the private link by themselves.
74     // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
75     auto* host_dst = new NetPointNs3();
76
77     // Create private link
78     std::string host_id = cluster.prefix + std::to_string(i) + cluster.suffix;
79     auto* host_src      = simgrid::s4u::Host::by_name(host_id)->get_netpoint()->extension<NetPointNs3>();
80     xbt_assert(host_src, "Cannot find a ns-3 host of name %s", host_id.c_str());
81
82     // Any ns-3 route is symmetrical
83     ns3_add_direct_route(host_src, host_dst, cluster.bw, cluster.lat, cluster.sharing_policy);
84
85     delete host_dst;
86   }
87
88   //Create link backbone
89   ns3_add_cluster(cluster.id.c_str(), cluster.bb_bw, cluster.bb_lat);
90 }
91
92 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
93                              simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* /*gw_src*/,
94                              simgrid::kernel::routing::NetPoint* /*gw_dst*/,
95                              std::vector<simgrid::kernel::resource::LinkImpl*> const& link_list)
96 {
97   if (link_list.size() == 1) {
98     auto* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
99
100     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s %s", src->get_cname(), dst->get_cname(), link->get_cname(),
101               (link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI ? "(wifi)" : "(wired)"),
102               (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
103
104     //   XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
105     XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->get_cname(), link->get_bandwidth(), link->get_latency());
106
107     // create link ns3
108     auto* host_src = src->extension<NetPointNs3>();
109     auto* host_dst = dst->extension<NetPointNs3>();
110
111     xbt_assert(host_src != nullptr, "Network element %s does not seem to be ns-3-ready", src->get_cname());
112     xbt_assert(host_dst != nullptr, "Network element %s does not seem to be ns-3-ready", dst->get_cname());
113
114     ns3_add_direct_route(host_src, host_dst, link->get_bandwidth(), link->get_latency(), link->get_sharing_policy());
115   } else {
116     static bool warned_about_long_routes = false;
117
118     if (not warned_about_long_routes)
119       XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with ns-3.\n"
120                "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
121                "of length 1.\n"
122                "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
123                "ignored.",
124                src->get_cname(), dst->get_cname(), link_list.size());
125     warned_about_long_routes = true;
126   }
127 }
128
129 /* Create the ns3 topology based on routing strategy */
130 static void postparse_cb()
131 {
132   IPV4addr.shrink_to_fit();
133
134   ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
135   ns3::GlobalRouteManager::InitializeRoutes();
136 }
137
138 /*********
139  * Model *
140  *********/
141 void surf_network_model_init_NS3()
142 {
143   xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
144
145   surf_network_model = new simgrid::kernel::resource::NetworkNS3Model();
146 }
147
148 static simgrid::config::Flag<std::string>
149     ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be : NewReno or Reno or Tahoe", "default");
150
151 namespace simgrid {
152 namespace kernel {
153 namespace resource {
154
155 NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
156 {
157   xbt_assert(not sg_link_energy_is_inited(),
158              "LinkEnergy plugin and ns-3 network models are not compatible. Are you looking for Ecofen, maybe?");
159
160   all_existing_models.push_back(this);
161
162   NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create<NetPointNs3>();
163
164   ns3_initialize(ns3_tcp_model.get());
165
166   routing::NetPoint::on_creation.connect([](routing::NetPoint& pt) {
167     pt.extension_set<NetPointNs3>(new NetPointNs3());
168     XBT_VERB("SimGrid's %s is known as node %d within ns-3", pt.get_cname(), pt.extension<NetPointNs3>()->node_num);
169   });
170   routing::on_cluster_creation.connect(&clusterCreation_cb);
171
172   s4u::Engine::on_platform_created.connect(&postparse_cb);
173   s4u::NetZone::on_route_creation.connect(&routeCreation_cb);
174 }
175
176 NetworkNS3Model::~NetworkNS3Model() {
177   IPV4addr.clear();
178 }
179
180 LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
181                                        s4u::Link::SharingPolicy policy)
182 {
183   xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
184   return new LinkNS3(this, name, bandwidths[0], latency, policy);
185 }
186
187 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
188 {
189   xbt_assert(rate == -1,
190              "Communication over ns-3 links cannot specify a specific rate. Please use -1 as a value instead of %f.",
191              rate);
192   return new NetworkNS3Action(this, size, src, dst);
193 }
194
195 double NetworkNS3Model::next_occurring_event(double now)
196 {
197   double time_to_next_flow_completion = 0.0;
198   XBT_DEBUG("ns3_next_occurring_event");
199
200   //get the first relevant value from the running_actions list
201
202   // If there is no comms in NS-3, then we do not move it forward.
203   // We will synchronize NS-3 with SimGrid when starting a new communication.
204   // (see NetworkNS3Action::NetworkNS3Action() for more details on this point)
205   if (get_started_action_set()->empty() || now == 0.0)
206     return -1.0;
207
208   XBT_DEBUG("doing a ns3 simulation for a duration of %f", now);
209   ns3_simulator(now);  
210   time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
211   // NS-3 stops as soon as a flow ends,
212   // but it does not process the other flows that may finish at the same (simulated) time.
213   // If another flow ends at the same time, time_to_next_flow_completion = 0
214   if(double_equals(time_to_next_flow_completion, 0, sg_surf_precision))
215     time_to_next_flow_completion = 0.0; 
216  
217   XBT_DEBUG("min       : %f", now);
218   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
219   XBT_DEBUG("surf time : %f", surf_get_clock());
220   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
221
222   return time_to_next_flow_completion;
223 }
224
225 void NetworkNS3Model::update_actions_state(double now, double delta)
226 {
227   static std::vector<std::string> socket_to_destroy;
228
229   std::string ns3_socket;
230   for (const auto& elm : flow_from_sock) {
231     ns3_socket                = elm.first;
232     SgFlow* sgFlow            = elm.second;
233     NetworkNS3Action * action = sgFlow->action_;
234     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
235     // Because NS3 stops as soon as a flow is finished, the other flows that ends at the same time may remains in an
236     // inconsistent state (i.e. remains_ == 0 but finished_ == false).
237     // However, SimGrid considers sometimes that an action with remains_ == 0 is finished.
238     // Thus, to avoid inconsistencies between SimGrid and NS3, set remains to 0 only when the flow is finished in NS3
239     int remains = action->get_cost() - sgFlow->sent_bytes_;
240     if(remains > 0)
241       action->set_remains(remains);
242
243     if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) {
244       double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_;
245
246       std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
247
248       action->get_src().route_to(&action->get_dst(), route, nullptr);
249       for (auto const& link : route)
250         instr::resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(),
251                                         (data_delta_sent) / delta, now - delta, delta);
252
253       action->last_sent_ = sgFlow->sent_bytes_;
254     }
255
256     if(sgFlow->finished_){
257       socket_to_destroy.push_back(ns3_socket);
258       XBT_DEBUG("Destroy socket %p of action %p", ns3_socket.c_str(), action);
259       action->set_remains(0);
260       action->finish(Action::State::FINISHED);
261     } else {
262       XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
263                 sgFlow->total_bytes_, sgFlow->remaining_);
264     }
265   }
266
267   while (not socket_to_destroy.empty()) {
268     ns3_socket = socket_to_destroy.back();
269     socket_to_destroy.pop_back();
270     SgFlow* flow = flow_from_sock.at(ns3_socket);
271     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
272       XBT_DEBUG("Removing socket %p of action %p", ns3_socket.c_str(), flow->action_);
273     }
274     delete flow;
275     flow_from_sock.erase(ns3_socket);
276     sink_from_sock.erase(ns3_socket);
277   }
278 }
279
280 /************
281  * Resource *
282  ************/
283
284 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency,
285                  s4u::Link::SharingPolicy policy)
286     : LinkImpl(model, name, nullptr), sharing_policy_(policy)
287 {
288   bandwidth_.peak = bandwidth;
289   latency_.peak   = latency;
290
291   /* If wifi, create the wifizone now. If not, don't do anything: the links will be created in routeCreate_cb */
292
293   s4u::Link::on_creation(*this->get_iface());
294 }
295
296 LinkNS3::~LinkNS3() = default;
297
298 void LinkNS3::apply_event(profile::Event*, double)
299 {
300   THROW_UNIMPLEMENTED;
301 }
302 void LinkNS3::set_bandwidth_profile(profile::Profile*)
303 {
304   xbt_die("The ns-3 network model doesn't support bandwidth profiles");
305 }
306 void LinkNS3::set_latency_profile(profile::Profile*)
307 {
308   xbt_die("The ns-3 network model doesn't support latency profiles");
309 }
310
311 /**********
312  * Action *
313  **********/
314
315 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
316     : NetworkAction(model, *src, *dst, totalBytes, false)
317 {
318   // If there is no other started actions, we need to move NS-3 forward to be sync with SimGrid
319   if (model->get_started_action_set()->size()==1){
320     while(double_positive(surf_get_clock() - ns3::Simulator::Now().GetSeconds(), sg_surf_precision)){
321       XBT_DEBUG("Synchronizing NS-3 (time %f) with SimGrid (time %f)", ns3::Simulator::Now().GetSeconds(), surf_get_clock());
322       ns3_simulator(surf_get_clock() - ns3::Simulator::Now().GetSeconds());
323     }
324   }
325
326   XBT_DEBUG("Communicate from %s to %s", src->get_cname(), dst->get_cname());
327
328   static int port_number = 1025; // Port number is limited from 1025 to 65 000
329
330   unsigned int node1 = src->get_netpoint()->extension<NetPointNs3>()->node_num;
331   unsigned int node2 = dst->get_netpoint()->extension<NetPointNs3>()->node_num;
332
333   ns3::Ptr<ns3::Node> src_node = src->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
334   ns3::Ptr<ns3::Node> dst_node = dst->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
335
336   xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
337              dst->get_netpoint()->get_cname());
338   std::string& addr = IPV4addr[node2];
339   xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
340              dst->get_netpoint()->get_cname());
341
342   XBT_DEBUG("ns3: Create flow of %.0f Bytes from %u to %u with Interface %s", totalBytes, node1, node2, addr.c_str());
343   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
344   ns3::ApplicationContainer apps = sink.Install(dst_node);
345
346   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
347
348   flow_from_sock.insert({transform_socket_ptr(sock), new SgFlow(totalBytes, this)});
349   sink_from_sock.insert({transform_socket_ptr(sock), apps});
350
351   sock->Bind(ns3::InetSocketAddress(port_number));
352
353   ns3::Simulator::ScheduleNow(&start_flow, sock, addr.c_str(), port_number);
354
355   port_number++;
356   if(port_number > 65000){
357     port_number = 1025;
358     XBT_WARN("Too many connections! Port number is saturated. Trying to use the oldest ports.");
359   }
360   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
361
362   s4u::Link::on_communicate(*this);
363 }
364
365 void NetworkNS3Action::suspend() {
366   THROW_UNIMPLEMENTED;
367 }
368
369 void NetworkNS3Action::resume() {
370   THROW_UNIMPLEMENTED;
371 }
372
373 std::list<LinkImpl*> NetworkNS3Action::get_links() const
374 {
375   THROW_UNIMPLEMENTED;
376 }
377 void NetworkNS3Action::update_remains_lazy(double /*now*/)
378 {
379   THROW_IMPOSSIBLE;
380 }
381
382 } // namespace resource
383 } // namespace kernel
384 } // namespace simgrid
385
386 void ns3_simulator(double maxSeconds)
387 {
388   ns3::EventId id; 
389   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
390     id = ns3::Simulator::Schedule(ns3::Seconds(maxSeconds), &ns3::Simulator::Stop);
391
392   XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
393   ns3::Simulator::Run ();
394   XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds());
395
396   if(maxSeconds > 0.0)
397     id.Cancel();
398 }
399
400 // initialize the ns-3 interface and environment
401 void ns3_initialize(std::string TcpProtocol)
402 {
403   //  tcpModel are:
404   //  "ns3::TcpNewReno"
405   //  "ns3::TcpReno"
406   //  "ns3::TcpTahoe"
407
408   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
409   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
410   ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
411
412   if (TcpProtocol == "default") {
413     /* nothing to do */
414
415   } else if (TcpProtocol == "Reno") {
416     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
417     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
418
419   } else if (TcpProtocol == "NewReno") {
420     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
421     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
422
423   } else if (TcpProtocol == "Tahoe") {
424     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
425     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
426
427   } else {
428     xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
429   }
430 }
431
432 void ns3_add_cluster(const char* /*id*/, double bw, double lat)
433 {
434   ns3::NodeContainer Nodes;
435
436   for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
437     Nodes.Add(Cluster_nodes.Get(i));
438     XBT_DEBUG("Add node %u to cluster", i);
439   }
440   number_of_clusters_nodes = Cluster_nodes.GetN();
441
442   // XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
443   // Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
444
445   xbt_assert(Nodes.GetN() <= 65000, "Cluster with ns-3 is limited to 65000 nodes");
446   ns3::CsmaHelper csma;
447   csma.SetChannelAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
448   csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
449   ns3::NetDeviceContainer devices = csma.Install(Nodes);
450   XBT_DEBUG("Create CSMA");
451
452   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
453   XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
454   ns3::Ipv4AddressHelper ipv4;
455   ipv4.SetBase(addr.c_str(), "255.255.0.0");
456   interfaces.Add(ipv4.Assign (devices));
457
458   if(number_of_links == 255){
459     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
460     number_of_links = 1;
461     number_of_networks++;
462   }else{
463     number_of_links++;
464   }
465   XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
466 }
467
468 static std::string transformIpv4Address(ns3::Ipv4Address from)
469 {
470   std::stringstream sstream;
471   sstream << from ;
472   return sstream.str();
473 }
474
475 void ns3_add_direct_route(NetPointNs3* src, NetPointNs3* dst, double bw, double lat,
476                           simgrid::s4u::Link::SharingPolicy policy)
477 {
478   ns3::Ipv4AddressHelper address;
479   ns3::NetDeviceContainer netA;
480
481   int srcNum = src->node_num;
482   int dstNum = dst->node_num;
483
484   ns3::Ptr<ns3::Node> a = src->ns3_node_;
485   ns3::Ptr<ns3::Node> b = dst->ns3_node_;
486
487   if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
488     /* Install a ns3::WifiHelper */
489   } else {
490     ns3::PointToPointHelper pointToPoint;
491
492     XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
493     pointToPoint.SetDeviceAttribute("DataRate",
494                                     ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
495     pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
496
497     netA.Add(pointToPoint.Install(a, b));
498   }
499
500   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
501   address.SetBase(addr.c_str(), "255.255.0.0");
502   XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
503   interfaces.Add(address.Assign (netA));
504
505   if (IPV4addr.size() <= (unsigned)srcNum)
506     IPV4addr.resize(srcNum + 1);
507   IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
508
509   if (IPV4addr.size() <= (unsigned)dstNum)
510     IPV4addr.resize(dstNum + 1);
511   IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
512
513   if (number_of_links == 255){
514     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
515     number_of_links = 1;
516     number_of_networks++;
517   } else {
518     number_of_links++;
519   }
520 }