Logo AND Algorithmique Numérique Distribuée

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