Logo AND Algorithmique Numérique Distribuée

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