Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
dd5eb18b71d2609a43ae69a071d74680c87031b3
[simgrid.git] / src / surf / network_ns3.cpp
1 /* Copyright (c) 2007-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include <unordered_set>
8
9 #include "ns3/core-module.h"
10 #include "ns3/node.h"
11
12 #include "ns3/ns3_interface.h"
13 #include "ns3/ns3_simulator.h"
14 #include "src/surf/network_ns3.hpp"
15
16 #include "src/surf/HostImpl.hpp"
17 #include "src/surf/surf_private.h"
18 #include "simgrid/sg_config.h"
19 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
20
21 #include "simgrid/s4u/As.hpp"
22
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
24
25 int NS3_EXTENSION_ID;
26
27 xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
28 static double time_to_next_flow_completion = -1;
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 static NS3Sim* ns3_sim = 0;
48
49
50 /*************
51  * Callbacks *
52  *************/
53
54 static void simgrid_ns3_add_host(simgrid::s4u::Host& host)
55 {
56   const char* id = host.name().c_str();
57   XBT_DEBUG("NS3_ADD_HOST '%s'", id);
58
59   ns3_node_t ns3host  = xbt_new0(s_ns3_node_t,1);
60   ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
61   stack.Install(node);
62   nodes.Add(node);
63   ns3host->node_num = number_of_nodes ++;
64
65   host.extension_set(NS3_EXTENSION_ID, ns3host);
66 }
67
68 static void simgrid_ns3_add_netcard(simgrid::surf::NetCard* netcard)
69 {
70   const char* id = netcard->name();
71
72   ns3_node_t ns3netcard  = xbt_new0(s_ns3_node_t,1);
73   XBT_DEBUG("Interface ns3 add netcard[%d] '%s'",number_of_nodes,id);
74   ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
75   stack.Install(node);
76   nodes.Add(node);
77   ns3netcard->node_num = number_of_nodes++;
78
79   xbt_lib_set(as_router_lib, id, NS3_ASR_LEVEL, ns3netcard );
80 }
81
82 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
83 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
84 {
85   const char *groups = NULL;
86
87   int start, end, i;
88   unsigned int iter;
89
90   xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
91
92   char *router_id,*host_id;
93
94   xbt_dynar_t radical_elements = xbt_str_split(cluster->radical, ",");
95   xbt_dynar_foreach(radical_elements, iter, groups) {
96   xbt_dynar_t radical_ends = xbt_str_split(groups, "-");
97
98     switch (xbt_dynar_length(radical_ends)) {
99     case 1:
100       start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
101       xbt_dynar_push_as(tab_elements_num, int, start);
102       router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
103       simgrid::s4u::Host::by_name_or_create(router_id)
104         ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
105       XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
106       free(router_id);
107       break;
108
109     case 2:
110       start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
111       end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
112       for (i = start; i <= end; i++){
113         xbt_dynar_push_as(tab_elements_num, int, i);
114         router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
115         simgrid::s4u::Host::by_name_or_create(router_id)
116           ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
117         XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
118         free(router_id);
119       }
120       break;
121
122     default:
123       XBT_DEBUG("Malformed radical");
124     }
125   }
126
127   //Create links
128   unsigned int cpt;
129   int elmts;
130   char * lat = bprintf("%fs", cluster->lat);
131   char * bw =  bprintf("%fBps", cluster->bw);
132
133   xbt_dynar_foreach(tab_elements_num,cpt,elmts) {
134     host_id   = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
135     router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
136     XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
137
138     ns3_node_t host_src = ns3_find_host(host_id);
139     ns3_node_t host_dst = ns3_find_host(router_id);
140
141     xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
142
143     ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
144
145     free(router_id);
146     free(host_id);
147   }
148   xbt_free(lat);
149   xbt_free(bw);
150   xbt_dynar_free(&tab_elements_num);
151
152
153   //Create link backbone
154   lat = bprintf("%fs", cluster->bb_lat);
155   bw =  bprintf("%fBps", cluster->bb_bw);
156   ns3_add_cluster(bw,lat,cluster->id);
157   xbt_free(lat);
158   xbt_free(bw);
159 }
160
161 /* Create the ns3 topology based on routing strategy */
162 static void create_ns3_topology(void)
163 {
164   XBT_DEBUG("Starting topology generation");
165
166   xbt_dynar_shrink(IPV4addr,0);
167
168   //get the onelinks from the parsed platform
169   xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
170
171   std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
172
173   XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
174   simgrid::surf::Onelink *onelink;
175   unsigned int iter;
176   xbt_dynar_foreach(onelink_routes, iter, onelink) {
177     char *src = onelink->src_->name();
178     char *dst = onelink->dst_->name();
179     simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
180
181     if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
182       already_seen.insert(link);
183       XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
184       char * link_bdw = bprintf("%fBps", link->getBandwidth());
185       char * link_lat = bprintf("%fs", link->getLatency());
186
187       //   XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
188       XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
189
190       //create link ns3
191       ns3_node_t host_src = ns3_find_host(src);
192       if (!host_src)
193         host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
194       ns3_node_t host_dst = ns3_find_host(dst);
195       if(!host_dst)
196         host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
197
198       if (!host_src || !host_dst)
199           xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
200
201       ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
202
203       xbt_free(link_bdw);
204       xbt_free(link_lat);
205     }
206   }
207 }
208
209 /*********
210  * Model *
211  *********/
212 void surf_network_model_init_NS3()
213 {
214   if (surf_network_model)
215     return;
216
217   surf_network_model = new simgrid::surf::NetworkNS3Model();
218   xbt_dynar_push(all_existing_models, &surf_network_model);
219 }
220
221 namespace simgrid {
222 namespace surf {
223
224 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
225   ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"));
226
227   routing_model_create(NULL);
228   simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
229   simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_netcard);
230   simgrid::surf::on_link.connect(netlink_parse_init);
231   simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
232   simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
233   simgrid::surf::on_postparse.connect(&ns3_end_platform); //InitializeRoutes
234
235   NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
236   NS3_ASR_LEVEL  = xbt_lib_add_level(as_router_lib, xbt_free_f);
237 }
238
239 NetworkNS3Model::~NetworkNS3Model() {
240   delete ns3_sim;
241   xbt_dynar_free_container(&IPV4addr);
242   xbt_dict_free(&flowFromSock);
243 }
244
245 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
246     xbt_dict_t properties){
247
248   return new LinkNS3(this, name, properties, bandwidth, latency);
249 }
250
251 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
252 {
253   XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
254   NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
255
256   ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
257
258   action->m_lastSent = 0;
259   action->p_srcElm = src;
260   action->p_dstElm = dst;
261   networkCommunicateCallbacks(action, src, dst, size, rate);
262
263   return action;
264 }
265
266 double NetworkNS3Model::next_occuring_event(double now)
267 {
268   XBT_DEBUG("ns3_next_occuring_event");
269
270   //get the first relevant value from the running_actions list
271   if (!getRunningActionSet()->size() || now == 0.0)
272     return -1.0;
273   else
274     do {
275       ns3_simulator(now);
276       time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
277     } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
278
279   XBT_DEBUG("min       : %f", now);
280   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
281   XBT_DEBUG("surf time : %f", surf_get_clock());
282   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
283
284   return time_to_next_flow_completion;
285 }
286
287 void NetworkNS3Model::updateActionsState(double now, double delta)
288 {
289   static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
290
291   /* If there are no running flows, advance the NS3 simulator and return */
292   if (getRunningActionSet()->empty()) {
293
294     while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
295       ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
296
297     return;
298   }
299
300   xbt_dict_cursor_t cursor = NULL;
301   char *ns3Socket;
302   SgFlow *sgFlow;
303   xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
304     NetworkNS3Action * action = sgFlow->action_;
305     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
306     action->setRemains(action->getCost() - sgFlow->sentBytes_);
307
308     if (TRACE_is_enabled() &&
309         action->getState() == Action::State::running){
310       double data_delta_sent = sgFlow->sentBytes_ - action->m_lastSent;
311
312       std::vector<Link*> *route = new std::vector<Link*>();
313
314       routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
315       for (auto link : *route)
316         TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
317       delete route;
318
319       action->m_lastSent = sgFlow->sentBytes_;
320     }
321
322     if(sgFlow->finished_){
323       xbt_dynar_push(socket_to_destroy,&ns3Socket);
324       XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
325       action->finish();
326       action->setState(Action::State::done);
327     }
328   }
329
330   while (!xbt_dynar_is_empty(socket_to_destroy)){
331     xbt_dynar_pop(socket_to_destroy,&ns3Socket);
332
333     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
334       SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
335       XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
336     }
337     xbt_dict_remove(flowFromSock, ns3Socket);
338   }
339   return;
340 }
341
342 /************
343  * Resource *
344  ************/
345
346 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
347  : Link(model, name, props)
348 {
349   m_bandwidth.peak = bandwidth;
350   m_latency.peak = latency;
351
352   Link::onCreation(this);
353 }
354
355 LinkNS3::~LinkNS3()
356 {
357 }
358
359 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
360 {
361   THROW_UNIMPLEMENTED;
362 }
363 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
364   xbt_die("The NS3 network model doesn't support latency state traces");
365 }
366 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
367   xbt_die("The NS3 network model doesn't support latency state traces");
368 }
369
370 /**********
371  * Action *
372  **********/
373
374 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
375 : NetworkAction(model, cost, failed)
376 {}
377
378 void NetworkNS3Action::suspend()
379 {
380   THROW_UNIMPLEMENTED;
381 }
382
383 void NetworkNS3Action::resume()
384 {
385   THROW_UNIMPLEMENTED;
386 }
387
388   /* Test whether a flow is suspended */
389 bool NetworkNS3Action::isSuspended()
390 {
391   return 0;
392 }
393
394 int NetworkNS3Action::unref()
395 {
396   m_refcount--;
397   if (!m_refcount) {
398   if (action_hook.is_linked())
399     p_stateSet->erase(p_stateSet->iterator_to(*this));
400     XBT_DEBUG ("Removing action %p", this);
401     delete this;
402     return 1;
403   }
404   return 0;
405 }
406
407 }
408 }
409
410
411
412
413
414 void ns3_simulator(double min){
415   ns3_sim->simulator_start(min);
416 }
417
418 void ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
419 {
420   ns3_node_t node1 = ns3_find_host(a);
421   ns3_node_t node2 = ns3_find_host(b);
422
423   ns3::Ptr<ns3::Node> src_node = nodes.Get(node1->node_num);
424   ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
425
426   char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
427
428   XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1->node_num, node2->node_num,addr);
429   ns3_sim->create_flow_NS3(src_node, dst_node, port_number, start, addr, TotalBytes, action);
430
431   port_number++;
432   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
433 }
434
435 // initialize the NS3 interface and environment
436 void ns3_initialize(const char* TcpProtocol){
437   xbt_assert(!ns3_sim, "ns3 already initialized");
438   ns3_sim = new NS3Sim();
439
440 //  tcpModel are:
441 //  "ns3::TcpNewReno"
442 //  "ns3::TcpReno"
443 //  "ns3::TcpTahoe"
444
445   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
446   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
447
448   if (!strcmp(TcpProtocol,"default"))
449     return;
450
451   if (!strcmp(TcpProtocol,"Reno")) {
452     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
453     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
454     return;
455   }
456   if (!strcmp(TcpProtocol,"NewReno")) {
457     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
458     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
459     return;
460   }
461   if(!strcmp(TcpProtocol,"Tahoe")){
462     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
463     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
464     return;
465   }
466
467   xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
468 }
469
470 void * ns3_add_host_cluster(const char * id)
471 {
472   ns3_node_t host  = xbt_new0(s_ns3_node_t,1);
473   XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
474   ns3::Ptr<ns3::Node> node =  ns3::CreateObject<ns3::Node> (0);
475   stack.Install(node);
476   Cluster_nodes.Add(node);
477   nodes.Add(node);
478   host->node_num = number_of_nodes;
479   number_of_nodes++;
480   return host;
481 }
482
483 void ns3_add_cluster(char * bw,char * lat,const char *id)
484 {
485
486   XBT_DEBUG("cluster_id: %s",id);
487   XBT_DEBUG("bw: %s lat: %s",bw,lat);
488   XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
489
490   ns3::NodeContainer Nodes;
491
492   for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
493     Nodes.Add(Cluster_nodes.Get(i));
494     XBT_DEBUG("Add node %d to cluster",i);
495   }
496   number_of_clusters_nodes = Cluster_nodes.GetN();
497
498   XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
499   Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
500
501   if(Nodes.GetN() > 65000)
502     xbt_die("Cluster with NS3 is limited to 65000 nodes");
503   ns3::CsmaHelper csma;
504   csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
505   csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
506   ns3::NetDeviceContainer devices = csma.Install (Nodes);
507   XBT_DEBUG("Create CSMA");
508
509   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
510   XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
511   ns3::Ipv4AddressHelper ipv4;
512   ipv4.SetBase (adr, "255.255.0.0");
513   free(adr);
514   interfaces.Add(ipv4.Assign (devices));
515
516   if(number_of_links == 255){
517     if(number_of_networks == 255)
518       xbt_die("Number of links and networks exceed 255*255");
519     number_of_links = 1;
520     number_of_networks++;
521   }else{
522     number_of_links++;
523   }
524   XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
525 }
526
527 static char* transformIpv4Address (ns3::Ipv4Address from){
528   std::stringstream sstream;
529   sstream << from ;
530   std::string s = sstream.str();
531   return bprintf("%s",s.c_str());
532 }
533
534 void ns3_add_link(int src, int dst, char *bw, char *lat)
535 {
536   if(number_of_links == 1 ) {
537     LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
538     LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
539   }
540
541   ns3::PointToPointHelper pointToPoint;
542
543   ns3::NetDeviceContainer netA;
544   ns3::Ipv4AddressHelper address;
545
546   ns3::Ptr<ns3::Node> a = nodes.Get(src);
547   ns3::Ptr<ns3::Node> b = nodes.Get(dst);
548
549   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
550   pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
551   pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
552   //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
553
554   netA.Add(pointToPoint.Install (a, b));
555
556   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
557   address.SetBase (adr, "255.255.0.0");
558   XBT_DEBUG("\tInterface stack '%s'",adr);
559   free(adr);
560   interfaces.Add(address.Assign (netA));
561
562   char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
563   xbt_dynar_set_as(IPV4addr,src,char*,tmp);
564   XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
565
566   tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
567   xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
568   XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
569
570   if(number_of_links == 255){
571     if(number_of_networks == 255)
572       xbt_die("Number of links and networks exceed 255*255");
573     number_of_links = 1;
574     number_of_networks++;
575   }else{
576     number_of_links++;
577   }
578 }
579
580 void ns3_end_platform(void)
581 {
582   XBT_DEBUG("InitializeRoutes");
583   ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
584   ns3::GlobalRouteManager::InitializeRoutes();
585 }