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 simgrid_ns3_add_router(simgrid::surf::NetCard* router)
70 const char* router_id = router->name();
71 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
72 xbt_lib_set(as_router_lib,
75 ns3_add_router(router_id)
79 static void parse_ns3_add_AS(simgrid::s4u::As* as)
81 const char* as_id = as->name();
82 XBT_DEBUG("NS3_ADD_AS '%s'", as_id);
83 xbt_lib_set(as_router_lib, as_id, NS3_ASR_LEVEL, ns3_add_AS(as_id) );
86 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
87 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
89 const char *groups = NULL;
94 xbt_dynar_t radical_elements;
95 xbt_dynar_t radical_ends;
96 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
98 char *router_id,*host_id;
100 radical_elements = xbt_str_split(cluster->radical, ",");
101 xbt_dynar_foreach(radical_elements, iter, groups) {
102 radical_ends = xbt_str_split(groups, "-");
104 switch (xbt_dynar_length(radical_ends)) {
106 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
107 xbt_dynar_push_as(tab_elements_num, int, start);
108 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
109 simgrid::s4u::Host::by_name_or_create(router_id)
110 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
111 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
116 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
117 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
118 for (i = start; i <= end; i++){
119 xbt_dynar_push_as(tab_elements_num, int, i);
120 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, 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);
129 XBT_DEBUG("Malformed radical");
136 char * lat = bprintf("%fs", cluster->lat);
137 char * bw = bprintf("%fBps", cluster->bw);
139 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
141 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
142 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
143 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
145 ns3_node_t host_src = ns3_find_host(host_id);
146 ns3_node_t host_dst = ns3_find_host(router_id);
148 if(host_src && host_dst){}
149 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
151 ns3_add_link(host_src->node_num,host_src->type,
152 host_dst->node_num,host_dst->type,
160 xbt_dynar_free(&tab_elements_num);
163 //Create link backbone
164 lat = bprintf("%fs", cluster->bb_lat);
165 bw = bprintf("%fBps", cluster->bb_bw);
166 ns3_add_cluster(bw,lat,cluster->id);
171 /* Create the ns3 topology based on routing strategy */
172 static void create_ns3_topology(void)
174 XBT_DEBUG("Starting topology generation");
176 xbt_dynar_shrink(IPV4addr,0);
178 //get the onelinks from the parsed platform
179 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
181 XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
182 //save them in trace file
183 simgrid::surf::Onelink *onelink;
185 xbt_dynar_foreach(onelink_routes, iter, onelink) {
186 char *src = onelink->src_->name();
187 char *dst = onelink->dst_->name();
188 simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
190 if (strcmp(src,dst) && link->m_created){
191 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
192 char * link_bdw = bprintf("%fBps", link->getBandwidth());
193 char * link_lat = bprintf("%fs", link->getLatency());
196 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
197 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
200 ns3_node_t host_src = ns3_find_host(src);
202 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
203 ns3_node_t host_dst = ns3_find_host(dst);
205 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
207 if (!host_src || !host_dst)
208 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
210 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
221 void surf_network_model_init_NS3()
223 if (surf_network_model)
226 surf_network_model = new simgrid::surf::NetworkNS3Model();
227 xbt_dynar_push(all_existing_models, &surf_network_model);
233 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
234 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
235 xbt_die("Impossible to initialize NS3 interface");
237 routing_model_create(NULL);
238 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
239 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_router);
240 simgrid::surf::on_link.connect(netlink_parse_init);
241 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
242 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
243 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
244 simgrid::surf::on_postparse.connect(&ns3_end_platform); //InitializeRoutes
246 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
247 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
250 NetworkNS3Model::~NetworkNS3Model() {
252 xbt_dynar_free_container(&IPV4addr);
253 xbt_dict_free(&flowFromSock);
256 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
257 xbt_dict_t properties){
259 return new LinkNS3(this, name, properties, bandwidth, latency);
262 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
264 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
265 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
267 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
269 action->m_lastSent = 0;
270 action->p_srcElm = src;
271 action->p_dstElm = dst;
272 networkCommunicateCallbacks(action, src, dst, size, rate);
274 return (surf_action_t) action;
277 double NetworkNS3Model::next_occuring_event(double now)
279 XBT_DEBUG("ns3_next_occuring_event");
281 //get the first relevant value from the running_actions list
282 if (!getRunningActionSet()->size() || now == 0.0)
287 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
288 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
290 XBT_DEBUG("min : %f", now);
291 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
292 XBT_DEBUG("surf time : %f", surf_get_clock());
293 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
295 return time_to_next_flow_completion;
298 void NetworkNS3Model::updateActionsState(double now, double delta)
300 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
302 /* If there are no running flows, advance the NS3 simulator and return */
303 if (getRunningActionSet()->empty()) {
305 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
306 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
311 xbt_dict_cursor_t cursor = NULL;
314 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
315 NetworkNS3Action * action = sgFlow->action_;
316 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
317 action->setRemains(action->getCost() - sgFlow->sentBytes_);
319 if (TRACE_is_enabled() &&
320 action->getState() == Action::State::running){
321 double data_delta_sent = sgFlow->sentBytes_ - action->m_lastSent;
323 std::vector<Link*> *route = new std::vector<Link*>();
325 routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
326 for (auto link : *route)
327 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
330 action->m_lastSent = sgFlow->sentBytes_;
333 if(sgFlow->finished_){
334 xbt_dynar_push(socket_to_destroy,&ns3Socket);
335 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
337 action->setState(Action::State::done);
341 while (!xbt_dynar_is_empty(socket_to_destroy)){
342 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
344 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
345 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
346 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
348 xbt_dict_remove(flowFromSock, ns3Socket);
357 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
358 : Link(model, name, props)
361 m_bandwidth.peak = bandwidth;
362 m_latency.peak = latency;
364 Link::onCreation(this);
371 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
375 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
376 xbt_die("The NS3 network model doesn't support latency state traces");
378 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
379 xbt_die("The NS3 network model doesn't support latency state traces");
386 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
387 : NetworkAction(model, cost, failed)
390 void NetworkNS3Action::suspend()
395 void NetworkNS3Action::resume()
400 /* Test whether a flow is suspended */
401 bool NetworkNS3Action::isSuspended()
406 int NetworkNS3Action::unref()
410 if (action_hook.is_linked())
411 p_stateSet->erase(p_stateSet->iterator_to(*this));
412 XBT_DEBUG ("Removing action %p", this);
426 void ns3_simulator(double min){
427 ns3_sim->simulator_start(min);
430 int ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
432 ns3_node_t node1 = ns3_find_host(a);
433 ns3_node_t node2 = ns3_find_host(b);
435 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1->node_num);
436 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
438 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
440 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1->node_num, node2->node_num,addr);
441 ns3_sim->create_flow_NS3(src_node, dst_node, port_number,
448 if(port_number >= 65001 ) xbt_die("Too many connections! Port number is saturated.");
452 // initialize the NS3 interface and environment
453 int ns3_initialize(const char* TcpProtocol){
454 xbt_assert(!ns3_sim, "ns3 already initialized");
455 ns3_sim = new NS3Sim();
462 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
463 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
465 if(!strcmp(TcpProtocol,"default")){
468 if(!strcmp(TcpProtocol,"Reno")){
469 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
470 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
473 if(!strcmp(TcpProtocol,"NewReno")){
474 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
475 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
478 if(!strcmp(TcpProtocol,"Tahoe")){
479 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
480 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
484 XBT_ERROR("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
488 void * ns3_add_host_cluster(const char * id)
490 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
491 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
492 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
494 Cluster_nodes.Add(node);
496 host->node_num = number_of_nodes;
497 host->type = NS3_NETWORK_ELEMENT_HOST;
502 void * ns3_add_router(const char * id)
504 ns3_node_t router = xbt_new0(s_ns3_node_t,1);
505 XBT_DEBUG("Interface ns3 add router[%d] '%s'",number_of_nodes,id);
506 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
509 router->node_num = number_of_nodes;
510 router->type = NS3_NETWORK_ELEMENT_ROUTER;
515 void ns3_add_cluster(char * bw,char * lat,const char *id)
518 XBT_DEBUG("cluster_id: %s",id);
519 XBT_DEBUG("bw: %s lat: %s",bw,lat);
520 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
522 ns3::NodeContainer Nodes;
524 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
525 Nodes.Add(Cluster_nodes.Get(i));
526 XBT_DEBUG("Add node %d to cluster",i);
528 number_of_clusters_nodes = Cluster_nodes.GetN();
530 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
531 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
533 if(Nodes.GetN() > 65000)
534 xbt_die("Cluster with NS3 is limited to 65000 nodes");
535 ns3::CsmaHelper csma;
536 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
537 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
538 ns3::NetDeviceContainer devices = csma.Install (Nodes);
539 XBT_DEBUG("Create CSMA");
541 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
542 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
543 ns3::Ipv4AddressHelper ipv4;
544 ipv4.SetBase (adr, "255.255.0.0");
546 interfaces.Add(ipv4.Assign (devices));
548 if(number_of_links == 255){
549 if(number_of_networks == 255)
550 xbt_die("Number of links and networks exceed 255*255");
552 number_of_networks++;
556 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
559 void * ns3_add_AS(const char * id)
561 XBT_DEBUG("Interface ns3 add AS '%s'",id);
565 static char* transformIpv4Address (ns3::Ipv4Address from){
566 std::stringstream sstream;
568 std::string s = sstream.str();
569 return bprintf("%s",s.c_str());
572 void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
573 int dst, e_ns3_network_element_type_t type_dst,
576 if(number_of_links == 1 ) {
577 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
578 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
581 ns3::MyPointToPointHelper pointToPoint;
583 ns3::NetDeviceContainer netA;
584 ns3::Ipv4AddressHelper address;
586 ns3::Ptr<ns3::Node> a = nodes.Get(src);
587 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
589 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
590 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
591 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
592 //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
594 netA.Add(pointToPoint.Install (a, type_src, b, type_dst));
596 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
597 address.SetBase (adr, "255.255.0.0");
598 XBT_DEBUG("\tInterface stack '%s'",adr);
600 interfaces.Add(address.Assign (netA));
602 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
603 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
604 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
606 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
607 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
608 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
610 if(number_of_links == 255){
611 if(number_of_networks == 255)
612 xbt_die("Number of links and networks exceed 255*255");
614 number_of_networks++;
620 void ns3_end_platform(void)
622 XBT_DEBUG("InitializeRoutes");
623 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
624 ns3::GlobalRouteManager::InitializeRoutes();