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, router_id, NS3_ASR_LEVEL, ns3_add_router(router_id)
78 static void parse_ns3_add_AS(simgrid::s4u::As* as)
80 const char* as_id = as->name();
81 XBT_DEBUG("NS3_ADD_AS '%s'", as_id);
82 xbt_lib_set(as_router_lib, as_id, NS3_ASR_LEVEL, ns3_add_AS(as_id) );
85 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
86 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
88 const char *groups = NULL;
93 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
95 char *router_id,*host_id;
97 xbt_dynar_t radical_elements = xbt_str_split(cluster->radical, ",");
98 xbt_dynar_foreach(radical_elements, iter, groups) {
99 xbt_dynar_t radical_ends = xbt_str_split(groups, "-");
101 switch (xbt_dynar_length(radical_ends)) {
103 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
104 xbt_dynar_push_as(tab_elements_num, int, start);
105 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
106 simgrid::s4u::Host::by_name_or_create(router_id)
107 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
108 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
113 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
114 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
115 for (i = start; i <= end; i++){
116 xbt_dynar_push_as(tab_elements_num, int, i);
117 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
118 simgrid::s4u::Host::by_name_or_create(router_id)
119 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
120 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
126 XBT_DEBUG("Malformed radical");
133 char * lat = bprintf("%fs", cluster->lat);
134 char * bw = bprintf("%fBps", cluster->bw);
136 xbt_dynar_foreach(tab_elements_num,cpt,elmts) {
137 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
138 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
139 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
141 ns3_node_t host_src = ns3_find_host(host_id);
142 ns3_node_t host_dst = ns3_find_host(router_id);
144 xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
146 ns3_add_link(host_src->node_num,host_src->type,
147 host_dst->node_num,host_dst->type,
155 xbt_dynar_free(&tab_elements_num);
158 //Create link backbone
159 lat = bprintf("%fs", cluster->bb_lat);
160 bw = bprintf("%fBps", cluster->bb_bw);
161 ns3_add_cluster(bw,lat,cluster->id);
166 /* Create the ns3 topology based on routing strategy */
167 static void create_ns3_topology(void)
169 XBT_DEBUG("Starting topology generation");
171 xbt_dynar_shrink(IPV4addr,0);
173 //get the onelinks from the parsed platform
174 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
176 std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
178 XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
179 simgrid::surf::Onelink *onelink;
181 xbt_dynar_foreach(onelink_routes, iter, onelink) {
182 char *src = onelink->src_->name();
183 char *dst = onelink->dst_->name();
184 simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
186 if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
187 already_seen.insert(link);
188 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
189 char * link_bdw = bprintf("%fBps", link->getBandwidth());
190 char * link_lat = bprintf("%fs", link->getLatency());
192 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
193 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
196 ns3_node_t host_src = ns3_find_host(src);
198 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
199 ns3_node_t host_dst = ns3_find_host(dst);
201 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
203 if (!host_src || !host_dst)
204 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
206 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
217 void surf_network_model_init_NS3()
219 if (surf_network_model)
222 surf_network_model = new simgrid::surf::NetworkNS3Model();
223 xbt_dynar_push(all_existing_models, &surf_network_model);
229 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
230 ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"));
232 routing_model_create(NULL);
233 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
234 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_router);
235 simgrid::surf::on_link.connect(netlink_parse_init);
236 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
237 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
238 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
239 simgrid::surf::on_postparse.connect(&ns3_end_platform); //InitializeRoutes
241 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
242 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
245 NetworkNS3Model::~NetworkNS3Model() {
247 xbt_dynar_free_container(&IPV4addr);
248 xbt_dict_free(&flowFromSock);
251 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
252 xbt_dict_t properties){
254 return new LinkNS3(this, name, properties, bandwidth, latency);
257 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
259 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
260 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
262 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
264 action->m_lastSent = 0;
265 action->p_srcElm = src;
266 action->p_dstElm = dst;
267 networkCommunicateCallbacks(action, src, dst, size, rate);
272 double NetworkNS3Model::next_occuring_event(double now)
274 XBT_DEBUG("ns3_next_occuring_event");
276 //get the first relevant value from the running_actions list
277 if (!getRunningActionSet()->size() || now == 0.0)
282 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
283 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
285 XBT_DEBUG("min : %f", now);
286 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
287 XBT_DEBUG("surf time : %f", surf_get_clock());
288 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
290 return time_to_next_flow_completion;
293 void NetworkNS3Model::updateActionsState(double now, double delta)
295 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
297 /* If there are no running flows, advance the NS3 simulator and return */
298 if (getRunningActionSet()->empty()) {
300 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
301 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
306 xbt_dict_cursor_t cursor = NULL;
309 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
310 NetworkNS3Action * action = sgFlow->action_;
311 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
312 action->setRemains(action->getCost() - sgFlow->sentBytes_);
314 if (TRACE_is_enabled() &&
315 action->getState() == Action::State::running){
316 double data_delta_sent = sgFlow->sentBytes_ - action->m_lastSent;
318 std::vector<Link*> *route = new std::vector<Link*>();
320 routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
321 for (auto link : *route)
322 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
325 action->m_lastSent = sgFlow->sentBytes_;
328 if(sgFlow->finished_){
329 xbt_dynar_push(socket_to_destroy,&ns3Socket);
330 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
332 action->setState(Action::State::done);
336 while (!xbt_dynar_is_empty(socket_to_destroy)){
337 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
339 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
340 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
341 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
343 xbt_dict_remove(flowFromSock, ns3Socket);
352 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
353 : Link(model, name, props)
355 m_bandwidth.peak = bandwidth;
356 m_latency.peak = latency;
358 Link::onCreation(this);
365 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
369 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
370 xbt_die("The NS3 network model doesn't support latency state traces");
372 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
373 xbt_die("The NS3 network model doesn't support latency state traces");
380 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
381 : NetworkAction(model, cost, failed)
384 void NetworkNS3Action::suspend()
389 void NetworkNS3Action::resume()
394 /* Test whether a flow is suspended */
395 bool NetworkNS3Action::isSuspended()
400 int NetworkNS3Action::unref()
404 if (action_hook.is_linked())
405 p_stateSet->erase(p_stateSet->iterator_to(*this));
406 XBT_DEBUG ("Removing action %p", this);
420 void ns3_simulator(double min){
421 ns3_sim->simulator_start(min);
424 void ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
426 ns3_node_t node1 = ns3_find_host(a);
427 ns3_node_t node2 = ns3_find_host(b);
429 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1->node_num);
430 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
432 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
434 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1->node_num, node2->node_num,addr);
435 ns3_sim->create_flow_NS3(src_node, dst_node, port_number, start, addr, TotalBytes, action);
438 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
441 // initialize the NS3 interface and environment
442 void ns3_initialize(const char* TcpProtocol){
443 xbt_assert(!ns3_sim, "ns3 already initialized");
444 ns3_sim = new NS3Sim();
451 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
452 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
454 if (!strcmp(TcpProtocol,"default"))
457 if (!strcmp(TcpProtocol,"Reno")) {
458 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
459 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
462 if (!strcmp(TcpProtocol,"NewReno")) {
463 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
464 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
467 if(!strcmp(TcpProtocol,"Tahoe")){
468 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
469 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
473 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
476 void * ns3_add_host_cluster(const char * id)
478 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
479 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
480 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
482 Cluster_nodes.Add(node);
484 host->node_num = number_of_nodes;
485 host->type = NS3_NETWORK_ELEMENT_HOST;
490 void * ns3_add_router(const char * id)
492 ns3_node_t router = xbt_new0(s_ns3_node_t,1);
493 XBT_DEBUG("Interface ns3 add router[%d] '%s'",number_of_nodes,id);
494 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
497 router->node_num = number_of_nodes;
498 router->type = NS3_NETWORK_ELEMENT_ROUTER;
503 void ns3_add_cluster(char * bw,char * lat,const char *id)
506 XBT_DEBUG("cluster_id: %s",id);
507 XBT_DEBUG("bw: %s lat: %s",bw,lat);
508 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
510 ns3::NodeContainer Nodes;
512 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
513 Nodes.Add(Cluster_nodes.Get(i));
514 XBT_DEBUG("Add node %d to cluster",i);
516 number_of_clusters_nodes = Cluster_nodes.GetN();
518 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
519 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
521 if(Nodes.GetN() > 65000)
522 xbt_die("Cluster with NS3 is limited to 65000 nodes");
523 ns3::CsmaHelper csma;
524 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
525 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
526 ns3::NetDeviceContainer devices = csma.Install (Nodes);
527 XBT_DEBUG("Create CSMA");
529 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
530 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
531 ns3::Ipv4AddressHelper ipv4;
532 ipv4.SetBase (adr, "255.255.0.0");
534 interfaces.Add(ipv4.Assign (devices));
536 if(number_of_links == 255){
537 if(number_of_networks == 255)
538 xbt_die("Number of links and networks exceed 255*255");
540 number_of_networks++;
544 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
547 void * ns3_add_AS(const char * id)
549 XBT_DEBUG("Interface ns3 add AS '%s'",id);
553 static char* transformIpv4Address (ns3::Ipv4Address from){
554 std::stringstream sstream;
556 std::string s = sstream.str();
557 return bprintf("%s",s.c_str());
560 void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
561 int dst, e_ns3_network_element_type_t type_dst,
564 if(number_of_links == 1 ) {
565 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
566 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
569 ns3::MyPointToPointHelper pointToPoint;
571 ns3::NetDeviceContainer netA;
572 ns3::Ipv4AddressHelper address;
574 ns3::Ptr<ns3::Node> a = nodes.Get(src);
575 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
577 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
578 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
579 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
580 //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
582 netA.Add(pointToPoint.Install (a, type_src, b, type_dst));
584 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
585 address.SetBase (adr, "255.255.0.0");
586 XBT_DEBUG("\tInterface stack '%s'",adr);
588 interfaces.Add(address.Assign (netA));
590 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
591 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
592 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
594 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
595 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
596 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
598 if(number_of_links == 255){
599 if(number_of_networks == 255)
600 xbt_die("Number of links and networks exceed 255*255");
602 number_of_networks++;
608 void ns3_end_platform(void)
610 XBT_DEBUG("InitializeRoutes");
611 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
612 ns3::GlobalRouteManager::InitializeRoutes();