1 /* Copyright (c) 2007-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "ns3/core-module.h"
10 #include "ns3/ns3_interface.h"
11 #include "ns3/ns3_simulator.h"
12 #include "src/surf/network_ns3.hpp"
14 #include "src/surf/HostImpl.hpp"
15 #include "src/surf/surf_private.h"
16 #include "simgrid/sg_config.h"
17 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
19 #include "simgrid/s4u/As.hpp"
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
25 xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
26 static double time_to_next_flow_completion = -1;
32 extern xbt_dict_t flowFromSock;
34 static ns3::InternetStackHelper stack;
35 static ns3::NodeContainer nodes;
36 static ns3::NodeContainer Cluster_nodes;
37 static ns3::Ipv4InterfaceContainer interfaces;
39 static int number_of_nodes = 0;
40 static int number_of_clusters_nodes = 0;
41 static int number_of_links = 1;
42 static int number_of_networks = 1;
43 static int port_number = 1025; //Port number is limited from 1025 to 65 000
45 static NS3Sim* ns3_sim = 0;
52 static void simgrid_ns3_add_host(simgrid::s4u::Host& host)
54 const char* id = host.name().c_str();
55 XBT_DEBUG("NS3_ADD_HOST '%s'", id);
57 ns3_node_t ns3host = xbt_new0(s_ns3_node_t,1);
58 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
61 ns3host->node_num = number_of_nodes;
62 ns3host->type = NS3_NETWORK_ELEMENT_HOST;
65 host.extension_set(NS3_EXTENSION_ID, ns3host);
68 static void parse_ns3_add_link(sg_platf_link_cbarg_t link)
70 XBT_DEBUG("NS3_ADD_LINK '%s'",link->id);
72 Link *l = surf_network_model->createLink(link->id, link->bandwidth, link->latency, link->policy, link->properties);
73 if (link->bandwidth_trace)
74 l->setBandwidthTrace(link->latency_trace);
75 if (link->latency_trace)
76 l->setLatencyTrace(link->latency_trace);
77 if (link->state_trace)
78 l->setStateTrace(link->state_trace);
80 static void simgrid_ns3_add_router(simgrid::surf::NetCard* router)
82 const char* router_id = router->name();
83 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
84 xbt_lib_set(as_router_lib,
87 ns3_add_router(router_id)
91 static void parse_ns3_add_AS(simgrid::s4u::As* as)
93 const char* as_id = as->name();
94 XBT_DEBUG("NS3_ADD_AS '%s'", as_id);
95 xbt_lib_set(as_router_lib, as_id, NS3_ASR_LEVEL, ns3_add_AS(as_id) );
98 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
99 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
101 const char *groups = NULL;
106 xbt_dynar_t radical_elements;
107 xbt_dynar_t radical_ends;
108 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
110 char *router_id,*host_id;
112 radical_elements = xbt_str_split(cluster->radical, ",");
113 xbt_dynar_foreach(radical_elements, iter, groups) {
114 radical_ends = xbt_str_split(groups, "-");
116 switch (xbt_dynar_length(radical_ends)) {
118 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
119 xbt_dynar_push_as(tab_elements_num, int, start);
120 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
121 simgrid::s4u::Host::by_name_or_create(router_id)
122 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
123 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
128 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
129 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
130 for (i = start; i <= end; i++){
131 xbt_dynar_push_as(tab_elements_num, int, i);
132 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
133 simgrid::s4u::Host::by_name_or_create(router_id)
134 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
135 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
141 XBT_DEBUG("Malformed radical");
148 char * lat = bprintf("%fs", cluster->lat);
149 char * bw = bprintf("%fBps", cluster->bw);
151 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
153 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
154 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
155 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
157 ns3_node_t host_src = ns3_find_host(host_id);
158 ns3_node_t host_dst = ns3_find_host(router_id);
160 if(host_src && host_dst){}
161 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
163 ns3_add_link(host_src->node_num,host_src->type,
164 host_dst->node_num,host_dst->type,
172 xbt_dynar_free(&tab_elements_num);
175 //Create link backbone
176 lat = bprintf("%fs", cluster->bb_lat);
177 bw = bprintf("%fBps", cluster->bb_bw);
178 ns3_add_cluster(bw,lat,cluster->id);
183 /* Create the ns3 topology based on routing strategy */
184 static void create_ns3_topology(void)
186 XBT_DEBUG("Starting topology generation");
188 xbt_dynar_shrink(IPV4addr,0);
190 //get the onelinks from the parsed platform
191 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
193 xbt_die("There is no routes!");
194 XBT_DEBUG("Have get_onelink_routes, found %ld routes",onelink_routes->used);
195 //save them in trace file
196 simgrid::surf::Onelink *onelink;
198 xbt_dynar_foreach(onelink_routes, iter, onelink) {
199 char *src = onelink->src_->name();
200 char *dst = onelink->dst_->name();
201 simgrid::surf::LinkNS3 *link =
202 static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
204 if (strcmp(src,dst) && link->m_created){
205 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
206 char * link_bdw = bprintf("%fBps", link->getBandwidth());
207 char * link_lat = bprintf("%fs", link->getLatency());
210 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
211 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
214 ns3_node_t host_src = ns3_find_host(src);
216 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
217 ns3_node_t host_dst = ns3_find_host(dst);
219 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
221 if (!host_src || !host_dst)
222 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
224 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
232 static void parse_ns3_end_platform(void)
237 static void define_callbacks_ns3(void)
239 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
240 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_router);
241 simgrid::surf::on_link.connect (parse_ns3_add_link);
242 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
243 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
244 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
245 simgrid::surf::on_postparse.connect(&parse_ns3_end_platform); //InitializeRoutes
251 static void free_ns3_link(void * elmts)
253 delete static_cast<simgrid::surf::LinkNS3*>(elmts);
256 static void free_ns3_host(void * elmts)
258 ns3_node_t host = static_cast<ns3_node_t>(elmts);
262 void surf_network_model_init_NS3()
264 if (surf_network_model)
267 surf_network_model = new simgrid::surf::NetworkNS3Model();
269 xbt_dynar_push(all_existing_models, &surf_network_model);
275 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
276 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
277 xbt_die("Impossible to initialize NS3 interface");
279 routing_model_create(NULL);
280 define_callbacks_ns3();
282 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(free_ns3_host);
283 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, free_ns3_host);
286 NetworkNS3Model::~NetworkNS3Model() {
288 xbt_dynar_free_container(&IPV4addr);
289 xbt_dict_free(&flowFromSock);
292 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
293 xbt_dict_t properties){
295 return new LinkNS3(this, name, properties, bandwidth, latency);
298 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
300 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
301 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
303 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
305 action->m_lastSent = 0;
306 action->p_srcElm = src;
307 action->p_dstElm = dst;
308 networkCommunicateCallbacks(action, src, dst, size, rate);
310 return (surf_action_t) action;
313 double NetworkNS3Model::next_occuring_event(double now)
315 XBT_DEBUG("ns3_next_occuring_event");
317 //get the first relevant value from the running_actions list
318 if (!getRunningActionSet()->size() || now == 0.0)
323 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
324 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
326 XBT_DEBUG("min : %f", now);
327 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
328 XBT_DEBUG("surf time : %f", surf_get_clock());
329 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
331 return time_to_next_flow_completion;
334 void NetworkNS3Model::updateActionsState(double now, double delta)
336 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
338 /* If there are no running flows, advance the NS3 simulator and return */
339 if (getRunningActionSet()->empty()) {
341 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
342 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
347 xbt_dict_cursor_t cursor = NULL;
350 xbt_dict_foreach(flowFromSock,cursor,key,data){
351 NetworkNS3Action * action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
352 XBT_DEBUG("Processing socket %p (action %p)",data,action);
353 action->setRemains(action->getCost() - ns3_get_socket_sent(data));
355 if (TRACE_is_enabled() &&
356 action->getState() == Action::State::running){
357 double data_sent = ns3_get_socket_sent(data);
358 double data_delta_sent = data_sent - action->m_lastSent;
360 std::vector<Link*> *route = new std::vector<Link*>();
362 routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
363 for (auto link : *route)
364 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
367 action->m_lastSent = data_sent;
370 if(ns3_get_socket_is_finished(data) == 1){
371 xbt_dynar_push(socket_to_destroy,&key);
372 XBT_DEBUG("Destroy socket %p of action %p", key, action);
374 action->setState(Action::State::done);
378 while (!xbt_dynar_is_empty(socket_to_destroy)){
379 xbt_dynar_pop(socket_to_destroy,&key);
381 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
382 SgFlow *data = (SgFlow*)xbt_dict_get (flowFromSock, key);
383 NetworkNS3Action * action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
384 XBT_DEBUG ("Removing socket %p of action %p", key, action);
386 xbt_dict_remove(flowFromSock, key);
395 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
396 : Link(model, name, props)
399 m_bandwidth.peak = bandwidth;
400 m_latency.peak = latency;
402 Link::onCreation(this);
409 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
413 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
414 xbt_die("The NS3 network model doesn't support latency state traces");
416 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
417 xbt_die("The NS3 network model doesn't support latency state traces");
424 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
425 : NetworkAction(model, cost, failed)
428 void NetworkNS3Action::suspend()
433 void NetworkNS3Action::resume()
438 /* Test whether a flow is suspended */
439 bool NetworkNS3Action::isSuspended()
444 int NetworkNS3Action::unref()
448 if (action_hook.is_linked())
449 p_stateSet->erase(p_stateSet->iterator_to(*this));
450 XBT_DEBUG ("Removing action %p", this);
464 void ns3_simulator(double min){
465 ns3_sim->simulator_start(min);
468 simgrid::surf::NetworkNS3Action* ns3_get_socket_action(void *socket){
469 return ((SgFlow *)socket)->action_;
472 double ns3_get_socket_remains(void *socket){
473 return ((SgFlow *)socket)->remaining_;
476 double ns3_get_socket_sent(void *socket){
477 return ((SgFlow *)socket)->sentBytes_;
480 bool ns3_get_socket_is_finished(void *socket){
481 return ((SgFlow *)socket)->finished_;
484 int ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
486 ns3_node_t node1 = ns3_find_host(a);
487 ns3_node_t node2 = ns3_find_host(b);
489 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1->node_num);
490 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
492 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
494 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1->node_num, node2->node_num,addr);
495 ns3_sim->create_flow_NS3(src_node, dst_node, port_number,
502 if(port_number >= 65001 ) xbt_die("Too many connections! Port number is saturated.");
506 // initialize the NS3 interface and environment
507 int ns3_initialize(const char* TcpProtocol){
508 xbt_assert(!ns3_sim, "ns3 already initialized");
509 ns3_sim = new NS3Sim();
516 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
517 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
519 if(!strcmp(TcpProtocol,"default")){
522 if(!strcmp(TcpProtocol,"Reno")){
523 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
524 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
527 if(!strcmp(TcpProtocol,"NewReno")){
528 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
529 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
532 if(!strcmp(TcpProtocol,"Tahoe")){
533 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
534 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
538 XBT_ERROR("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
542 void * ns3_add_host_cluster(const char * id)
544 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
545 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
546 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
548 Cluster_nodes.Add(node);
550 host->node_num = number_of_nodes;
551 host->type = NS3_NETWORK_ELEMENT_HOST;
556 void * ns3_add_router(const char * id)
558 ns3_node_t router = xbt_new0(s_ns3_node_t,1);
559 XBT_DEBUG("Interface ns3 add router[%d] '%s'",number_of_nodes,id);
560 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
563 router->node_num = number_of_nodes;
564 router->type = NS3_NETWORK_ELEMENT_ROUTER;
569 void ns3_add_cluster(char * bw,char * lat,const char *id)
572 XBT_DEBUG("cluster_id: %s",id);
573 XBT_DEBUG("bw: %s lat: %s",bw,lat);
574 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
576 ns3::NodeContainer Nodes;
578 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
579 Nodes.Add(Cluster_nodes.Get(i));
580 XBT_DEBUG("Add node %d to cluster",i);
582 number_of_clusters_nodes = Cluster_nodes.GetN();
584 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
585 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
587 if(Nodes.GetN() > 65000)
588 xbt_die("Cluster with NS3 is limited to 65000 nodes");
589 ns3::CsmaHelper csma;
590 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
591 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
592 ns3::NetDeviceContainer devices = csma.Install (Nodes);
593 XBT_DEBUG("Create CSMA");
595 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
596 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
597 ns3::Ipv4AddressHelper ipv4;
598 ipv4.SetBase (adr, "255.255.0.0");
600 interfaces.Add(ipv4.Assign (devices));
602 if(number_of_links == 255){
603 if(number_of_networks == 255)
604 xbt_die("Number of links and networks exceed 255*255");
606 number_of_networks++;
610 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
613 void * ns3_add_AS(const char * id)
615 XBT_DEBUG("Interface ns3 add AS '%s'",id);
619 static char* transformIpv4Address (ns3::Ipv4Address from){
620 std::stringstream sstream;
622 std::string s = sstream.str();
623 return bprintf("%s",s.c_str());
626 void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
627 int dst, e_ns3_network_element_type_t type_dst,
630 if(number_of_links == 1 ) {
631 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
632 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
635 ns3::MyPointToPointHelper pointToPoint;
637 ns3::NetDeviceContainer netA;
638 ns3::Ipv4AddressHelper address;
640 ns3::Ptr<ns3::Node> a = nodes.Get(src);
641 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
643 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
644 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
645 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
646 //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
648 netA.Add(pointToPoint.Install (a, type_src, b, type_dst));
650 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
651 address.SetBase (adr, "255.255.0.0");
652 XBT_DEBUG("\tInterface stack '%s'",adr);
654 interfaces.Add(address.Assign (netA));
656 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
657 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
658 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
660 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
661 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
662 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
664 if(number_of_links == 255){
665 if(number_of_networks == 255)
666 xbt_die("Number of links and networks exceed 255*255");
668 number_of_networks++;
674 void ns3_end_platform(void)
676 XBT_DEBUG("InitializeRoutes");
677 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
678 ns3::GlobalRouteManager::InitializeRoutes();