Logo AND Algorithmique Numérique Distribuée

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