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_DEBUG("There is %ld one-link routes",onelink_routes->used);
194 //save them in trace file
195 simgrid::surf::Onelink *onelink;
197 xbt_dynar_foreach(onelink_routes, iter, onelink) {
198 char *src = onelink->src_->name();
199 char *dst = onelink->dst_->name();
200 simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
202 if (strcmp(src,dst) && link->m_created){
203 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
204 char * link_bdw = bprintf("%fBps", link->getBandwidth());
205 char * link_lat = bprintf("%fs", link->getLatency());
208 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
209 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
212 ns3_node_t host_src = ns3_find_host(src);
214 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
215 ns3_node_t host_dst = ns3_find_host(dst);
217 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
219 if (!host_src || !host_dst)
220 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
222 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
233 void surf_network_model_init_NS3()
235 if (surf_network_model)
238 surf_network_model = new simgrid::surf::NetworkNS3Model();
239 xbt_dynar_push(all_existing_models, &surf_network_model);
245 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
246 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
247 xbt_die("Impossible to initialize NS3 interface");
249 routing_model_create(NULL);
250 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
251 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_router);
252 simgrid::surf::on_link.connect (parse_ns3_add_link);
253 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
254 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
255 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
256 simgrid::surf::on_postparse.connect(&ns3_end_platform); //InitializeRoutes
258 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
259 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
262 NetworkNS3Model::~NetworkNS3Model() {
264 xbt_dynar_free_container(&IPV4addr);
265 xbt_dict_free(&flowFromSock);
268 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
269 xbt_dict_t properties){
271 return new LinkNS3(this, name, properties, bandwidth, latency);
274 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
276 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
277 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
279 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
281 action->m_lastSent = 0;
282 action->p_srcElm = src;
283 action->p_dstElm = dst;
284 networkCommunicateCallbacks(action, src, dst, size, rate);
286 return (surf_action_t) action;
289 double NetworkNS3Model::next_occuring_event(double now)
291 XBT_DEBUG("ns3_next_occuring_event");
293 //get the first relevant value from the running_actions list
294 if (!getRunningActionSet()->size() || now == 0.0)
299 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
300 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
302 XBT_DEBUG("min : %f", now);
303 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
304 XBT_DEBUG("surf time : %f", surf_get_clock());
305 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
307 return time_to_next_flow_completion;
310 void NetworkNS3Model::updateActionsState(double now, double delta)
312 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
314 /* If there are no running flows, advance the NS3 simulator and return */
315 if (getRunningActionSet()->empty()) {
317 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
318 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
323 xbt_dict_cursor_t cursor = NULL;
326 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
327 NetworkNS3Action * action = sgFlow->action_;
328 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
329 action->setRemains(action->getCost() - sgFlow->sentBytes_);
331 if (TRACE_is_enabled() &&
332 action->getState() == Action::State::running){
333 double data_delta_sent = sgFlow->sentBytes_ - action->m_lastSent;
335 std::vector<Link*> *route = new std::vector<Link*>();
337 routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
338 for (auto link : *route)
339 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
342 action->m_lastSent = sgFlow->sentBytes_;
345 if(sgFlow->finished_){
346 xbt_dynar_push(socket_to_destroy,&ns3Socket);
347 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
349 action->setState(Action::State::done);
353 while (!xbt_dynar_is_empty(socket_to_destroy)){
354 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
356 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
357 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
358 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
360 xbt_dict_remove(flowFromSock, ns3Socket);
369 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
370 : Link(model, name, props)
373 m_bandwidth.peak = bandwidth;
374 m_latency.peak = latency;
376 Link::onCreation(this);
383 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
387 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
388 xbt_die("The NS3 network model doesn't support latency state traces");
390 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
391 xbt_die("The NS3 network model doesn't support latency state traces");
398 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
399 : NetworkAction(model, cost, failed)
402 void NetworkNS3Action::suspend()
407 void NetworkNS3Action::resume()
412 /* Test whether a flow is suspended */
413 bool NetworkNS3Action::isSuspended()
418 int NetworkNS3Action::unref()
422 if (action_hook.is_linked())
423 p_stateSet->erase(p_stateSet->iterator_to(*this));
424 XBT_DEBUG ("Removing action %p", this);
438 void ns3_simulator(double min){
439 ns3_sim->simulator_start(min);
442 int ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
444 ns3_node_t node1 = ns3_find_host(a);
445 ns3_node_t node2 = ns3_find_host(b);
447 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1->node_num);
448 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
450 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
452 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1->node_num, node2->node_num,addr);
453 ns3_sim->create_flow_NS3(src_node, dst_node, port_number,
460 if(port_number >= 65001 ) xbt_die("Too many connections! Port number is saturated.");
464 // initialize the NS3 interface and environment
465 int ns3_initialize(const char* TcpProtocol){
466 xbt_assert(!ns3_sim, "ns3 already initialized");
467 ns3_sim = new NS3Sim();
474 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
475 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
477 if(!strcmp(TcpProtocol,"default")){
480 if(!strcmp(TcpProtocol,"Reno")){
481 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
482 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
485 if(!strcmp(TcpProtocol,"NewReno")){
486 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
487 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
490 if(!strcmp(TcpProtocol,"Tahoe")){
491 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
492 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
496 XBT_ERROR("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
500 void * ns3_add_host_cluster(const char * id)
502 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
503 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
504 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
506 Cluster_nodes.Add(node);
508 host->node_num = number_of_nodes;
509 host->type = NS3_NETWORK_ELEMENT_HOST;
514 void * ns3_add_router(const char * id)
516 ns3_node_t router = xbt_new0(s_ns3_node_t,1);
517 XBT_DEBUG("Interface ns3 add router[%d] '%s'",number_of_nodes,id);
518 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
521 router->node_num = number_of_nodes;
522 router->type = NS3_NETWORK_ELEMENT_ROUTER;
527 void ns3_add_cluster(char * bw,char * lat,const char *id)
530 XBT_DEBUG("cluster_id: %s",id);
531 XBT_DEBUG("bw: %s lat: %s",bw,lat);
532 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
534 ns3::NodeContainer Nodes;
536 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
537 Nodes.Add(Cluster_nodes.Get(i));
538 XBT_DEBUG("Add node %d to cluster",i);
540 number_of_clusters_nodes = Cluster_nodes.GetN();
542 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
543 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
545 if(Nodes.GetN() > 65000)
546 xbt_die("Cluster with NS3 is limited to 65000 nodes");
547 ns3::CsmaHelper csma;
548 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
549 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
550 ns3::NetDeviceContainer devices = csma.Install (Nodes);
551 XBT_DEBUG("Create CSMA");
553 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
554 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
555 ns3::Ipv4AddressHelper ipv4;
556 ipv4.SetBase (adr, "255.255.0.0");
558 interfaces.Add(ipv4.Assign (devices));
560 if(number_of_links == 255){
561 if(number_of_networks == 255)
562 xbt_die("Number of links and networks exceed 255*255");
564 number_of_networks++;
568 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
571 void * ns3_add_AS(const char * id)
573 XBT_DEBUG("Interface ns3 add AS '%s'",id);
577 static char* transformIpv4Address (ns3::Ipv4Address from){
578 std::stringstream sstream;
580 std::string s = sstream.str();
581 return bprintf("%s",s.c_str());
584 void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
585 int dst, e_ns3_network_element_type_t type_dst,
588 if(number_of_links == 1 ) {
589 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
590 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
593 ns3::MyPointToPointHelper pointToPoint;
595 ns3::NetDeviceContainer netA;
596 ns3::Ipv4AddressHelper address;
598 ns3::Ptr<ns3::Node> a = nodes.Get(src);
599 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
601 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
602 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
603 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
604 //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
606 netA.Add(pointToPoint.Install (a, type_src, b, type_dst));
608 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
609 address.SetBase (adr, "255.255.0.0");
610 XBT_DEBUG("\tInterface stack '%s'",adr);
612 interfaces.Add(address.Assign (netA));
614 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
615 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
616 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
618 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
619 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
620 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
622 if(number_of_links == 255){
623 if(number_of_networks == 255)
624 xbt_die("Number of links and networks exceed 255*255");
626 number_of_networks++;
632 void ns3_end_platform(void)
634 XBT_DEBUG("InitializeRoutes");
635 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
636 ns3::GlobalRouteManager::InitializeRoutes();