Logo AND Algorithmique Numérique Distribuée

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