Logo AND Algorithmique Numérique Distribuée

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