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 <unordered_set>
9 #include "ns3/core-module.h"
12 #include "ns3/ns3_interface.h"
13 #include "ns3/ns3_simulator.h"
14 #include "src/surf/network_ns3.hpp"
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
21 #include "simgrid/s4u/As.hpp"
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
27 xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
28 static double time_to_next_flow_completion = -1;
34 extern xbt_dict_t flowFromSock;
36 static ns3::InternetStackHelper stack;
37 static ns3::NodeContainer nodes;
38 static ns3::NodeContainer Cluster_nodes;
39 static ns3::Ipv4InterfaceContainer interfaces;
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
47 static NS3Sim* ns3_sim = 0;
54 static void simgrid_ns3_add_host(simgrid::s4u::Host& host)
56 const char* id = host.name().c_str();
57 XBT_DEBUG("NS3_ADD_HOST '%s'", id);
59 ns3_node_t ns3host = xbt_new0(s_ns3_node_t,1);
60 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
63 ns3host->node_num = number_of_nodes;
64 ns3host->type = NS3_NETWORK_ELEMENT_HOST;
67 host.extension_set(NS3_EXTENSION_ID, ns3host);
70 static void simgrid_ns3_add_router(simgrid::surf::NetCard* router)
72 const char* router_id = router->name();
73 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
74 xbt_lib_set(as_router_lib,
77 ns3_add_router(router_id)
81 static void parse_ns3_add_AS(simgrid::s4u::As* as)
83 const char* as_id = as->name();
84 XBT_DEBUG("NS3_ADD_AS '%s'", as_id);
85 xbt_lib_set(as_router_lib, as_id, NS3_ASR_LEVEL, ns3_add_AS(as_id) );
88 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
89 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
91 const char *groups = NULL;
96 xbt_dynar_t radical_elements;
97 xbt_dynar_t radical_ends;
98 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
100 char *router_id,*host_id;
102 radical_elements = xbt_str_split(cluster->radical, ",");
103 xbt_dynar_foreach(radical_elements, iter, groups) {
104 radical_ends = xbt_str_split(groups, "-");
106 switch (xbt_dynar_length(radical_ends)) {
108 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
109 xbt_dynar_push_as(tab_elements_num, int, start);
110 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
111 simgrid::s4u::Host::by_name_or_create(router_id)
112 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
113 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
118 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
119 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
120 for (i = start; i <= end; i++){
121 xbt_dynar_push_as(tab_elements_num, int, i);
122 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
123 simgrid::s4u::Host::by_name_or_create(router_id)
124 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
125 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
131 XBT_DEBUG("Malformed radical");
138 char * lat = bprintf("%fs", cluster->lat);
139 char * bw = bprintf("%fBps", cluster->bw);
141 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
143 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
144 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
145 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
147 ns3_node_t host_src = ns3_find_host(host_id);
148 ns3_node_t host_dst = ns3_find_host(router_id);
150 if(host_src && host_dst){}
151 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
153 ns3_add_link(host_src->node_num,host_src->type,
154 host_dst->node_num,host_dst->type,
162 xbt_dynar_free(&tab_elements_num);
165 //Create link backbone
166 lat = bprintf("%fs", cluster->bb_lat);
167 bw = bprintf("%fBps", cluster->bb_bw);
168 ns3_add_cluster(bw,lat,cluster->id);
173 /* Create the ns3 topology based on routing strategy */
174 static void create_ns3_topology(void)
176 XBT_DEBUG("Starting topology generation");
178 xbt_dynar_shrink(IPV4addr,0);
180 //get the onelinks from the parsed platform
181 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
183 std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
185 XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
186 simgrid::surf::Onelink *onelink;
188 xbt_dynar_foreach(onelink_routes, iter, onelink) {
189 char *src = onelink->src_->name();
190 char *dst = onelink->dst_->name();
191 simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
193 if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
194 already_seen.insert(link);
195 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
196 char * link_bdw = bprintf("%fBps", link->getBandwidth());
197 char * link_lat = bprintf("%fs", link->getLatency());
199 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
200 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
203 ns3_node_t host_src = ns3_find_host(src);
205 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
206 ns3_node_t host_dst = ns3_find_host(dst);
208 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
210 if (!host_src || !host_dst)
211 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
213 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
224 void surf_network_model_init_NS3()
226 if (surf_network_model)
229 surf_network_model = new simgrid::surf::NetworkNS3Model();
230 xbt_dynar_push(all_existing_models, &surf_network_model);
236 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
237 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
238 xbt_die("Impossible to initialize NS3 interface");
240 routing_model_create(NULL);
241 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
242 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_router);
243 simgrid::surf::on_link.connect(netlink_parse_init);
244 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
245 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
246 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
247 simgrid::surf::on_postparse.connect(&ns3_end_platform); //InitializeRoutes
249 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
250 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
253 NetworkNS3Model::~NetworkNS3Model() {
255 xbt_dynar_free_container(&IPV4addr);
256 xbt_dict_free(&flowFromSock);
259 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
260 xbt_dict_t properties){
262 return new LinkNS3(this, name, properties, bandwidth, latency);
265 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
267 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
268 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
270 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
272 action->m_lastSent = 0;
273 action->p_srcElm = src;
274 action->p_dstElm = dst;
275 networkCommunicateCallbacks(action, src, dst, size, rate);
277 return (surf_action_t) action;
280 double NetworkNS3Model::next_occuring_event(double now)
282 XBT_DEBUG("ns3_next_occuring_event");
284 //get the first relevant value from the running_actions list
285 if (!getRunningActionSet()->size() || now == 0.0)
290 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
291 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
293 XBT_DEBUG("min : %f", now);
294 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
295 XBT_DEBUG("surf time : %f", surf_get_clock());
296 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
298 return time_to_next_flow_completion;
301 void NetworkNS3Model::updateActionsState(double now, double delta)
303 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
305 /* If there are no running flows, advance the NS3 simulator and return */
306 if (getRunningActionSet()->empty()) {
308 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
309 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
314 xbt_dict_cursor_t cursor = NULL;
317 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
318 NetworkNS3Action * action = sgFlow->action_;
319 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
320 action->setRemains(action->getCost() - sgFlow->sentBytes_);
322 if (TRACE_is_enabled() &&
323 action->getState() == Action::State::running){
324 double data_delta_sent = sgFlow->sentBytes_ - action->m_lastSent;
326 std::vector<Link*> *route = new std::vector<Link*>();
328 routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
329 for (auto link : *route)
330 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
333 action->m_lastSent = sgFlow->sentBytes_;
336 if(sgFlow->finished_){
337 xbt_dynar_push(socket_to_destroy,&ns3Socket);
338 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
340 action->setState(Action::State::done);
344 while (!xbt_dynar_is_empty(socket_to_destroy)){
345 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
347 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
348 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
349 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
351 xbt_dict_remove(flowFromSock, ns3Socket);
360 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
361 : Link(model, name, props)
363 m_bandwidth.peak = bandwidth;
364 m_latency.peak = latency;
366 Link::onCreation(this);
373 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
377 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
378 xbt_die("The NS3 network model doesn't support latency state traces");
380 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
381 xbt_die("The NS3 network model doesn't support latency state traces");
388 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
389 : NetworkAction(model, cost, failed)
392 void NetworkNS3Action::suspend()
397 void NetworkNS3Action::resume()
402 /* Test whether a flow is suspended */
403 bool NetworkNS3Action::isSuspended()
408 int NetworkNS3Action::unref()
412 if (action_hook.is_linked())
413 p_stateSet->erase(p_stateSet->iterator_to(*this));
414 XBT_DEBUG ("Removing action %p", this);
428 void ns3_simulator(double min){
429 ns3_sim->simulator_start(min);
432 int ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
434 ns3_node_t node1 = ns3_find_host(a);
435 ns3_node_t node2 = ns3_find_host(b);
437 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1->node_num);
438 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
440 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
442 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1->node_num, node2->node_num,addr);
443 ns3_sim->create_flow_NS3(src_node, dst_node, port_number,
450 if(port_number >= 65001 ) xbt_die("Too many connections! Port number is saturated.");
454 // initialize the NS3 interface and environment
455 int ns3_initialize(const char* TcpProtocol){
456 xbt_assert(!ns3_sim, "ns3 already initialized");
457 ns3_sim = new NS3Sim();
464 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
465 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
467 if(!strcmp(TcpProtocol,"default")){
470 if(!strcmp(TcpProtocol,"Reno")){
471 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
472 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
475 if(!strcmp(TcpProtocol,"NewReno")){
476 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
477 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
480 if(!strcmp(TcpProtocol,"Tahoe")){
481 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
482 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
486 XBT_ERROR("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
490 void * ns3_add_host_cluster(const char * id)
492 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
493 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
494 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
496 Cluster_nodes.Add(node);
498 host->node_num = number_of_nodes;
499 host->type = NS3_NETWORK_ELEMENT_HOST;
504 void * ns3_add_router(const char * id)
506 ns3_node_t router = xbt_new0(s_ns3_node_t,1);
507 XBT_DEBUG("Interface ns3 add router[%d] '%s'",number_of_nodes,id);
508 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
511 router->node_num = number_of_nodes;
512 router->type = NS3_NETWORK_ELEMENT_ROUTER;
517 void ns3_add_cluster(char * bw,char * lat,const char *id)
520 XBT_DEBUG("cluster_id: %s",id);
521 XBT_DEBUG("bw: %s lat: %s",bw,lat);
522 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
524 ns3::NodeContainer Nodes;
526 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
527 Nodes.Add(Cluster_nodes.Get(i));
528 XBT_DEBUG("Add node %d to cluster",i);
530 number_of_clusters_nodes = Cluster_nodes.GetN();
532 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
533 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
535 if(Nodes.GetN() > 65000)
536 xbt_die("Cluster with NS3 is limited to 65000 nodes");
537 ns3::CsmaHelper csma;
538 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
539 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
540 ns3::NetDeviceContainer devices = csma.Install (Nodes);
541 XBT_DEBUG("Create CSMA");
543 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
544 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
545 ns3::Ipv4AddressHelper ipv4;
546 ipv4.SetBase (adr, "255.255.0.0");
548 interfaces.Add(ipv4.Assign (devices));
550 if(number_of_links == 255){
551 if(number_of_networks == 255)
552 xbt_die("Number of links and networks exceed 255*255");
554 number_of_networks++;
558 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
561 void * ns3_add_AS(const char * id)
563 XBT_DEBUG("Interface ns3 add AS '%s'",id);
567 static char* transformIpv4Address (ns3::Ipv4Address from){
568 std::stringstream sstream;
570 std::string s = sstream.str();
571 return bprintf("%s",s.c_str());
574 void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
575 int dst, e_ns3_network_element_type_t type_dst,
578 if(number_of_links == 1 ) {
579 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
580 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
583 ns3::MyPointToPointHelper pointToPoint;
585 ns3::NetDeviceContainer netA;
586 ns3::Ipv4AddressHelper address;
588 ns3::Ptr<ns3::Node> a = nodes.Get(src);
589 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
591 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
592 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
593 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
594 //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
596 netA.Add(pointToPoint.Install (a, type_src, b, type_dst));
598 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
599 address.SetBase (adr, "255.255.0.0");
600 XBT_DEBUG("\tInterface stack '%s'",adr);
602 interfaces.Add(address.Assign (netA));
604 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
605 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
606 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
608 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
609 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
610 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
612 if(number_of_links == 255){
613 if(number_of_networks == 255)
614 xbt_die("Number of links and networks exceed 255*255");
616 number_of_networks++;
622 void ns3_end_platform(void)
624 XBT_DEBUG("InitializeRoutes");
625 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
626 ns3::GlobalRouteManager::InitializeRoutes();