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 ++;
65 host.extension_set(NS3_EXTENSION_ID, ns3host);
68 static void simgrid_ns3_add_netcard(simgrid::surf::NetCard* netcard)
70 const char* id = netcard->name();
72 ns3_node_t ns3netcard = xbt_new0(s_ns3_node_t,1);
73 XBT_DEBUG("Interface ns3 add netcard[%d] '%s'",number_of_nodes,id);
74 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
77 ns3netcard->node_num = number_of_nodes++;
80 xbt_lib_set(as_router_lib, id, NS3_ASR_LEVEL, ns3netcard );
83 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
84 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
86 const char *groups = NULL;
91 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
93 char *router_id,*host_id;
95 xbt_dynar_t radical_elements = xbt_str_split(cluster->radical, ",");
96 xbt_dynar_foreach(radical_elements, iter, groups) {
97 xbt_dynar_t radical_ends = xbt_str_split(groups, "-");
99 switch (xbt_dynar_length(radical_ends)) {
101 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
102 xbt_dynar_push_as(tab_elements_num, int, start);
103 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
104 simgrid::s4u::Host::by_name_or_create(router_id)
105 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
106 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
111 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
112 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
113 for (i = start; i <= end; i++){
114 xbt_dynar_push_as(tab_elements_num, int, i);
115 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
116 simgrid::s4u::Host::by_name_or_create(router_id)
117 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
118 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
124 XBT_DEBUG("Malformed radical");
131 char * lat = bprintf("%fs", cluster->lat);
132 char * bw = bprintf("%fBps", cluster->bw);
134 xbt_dynar_foreach(tab_elements_num,cpt,elmts) {
135 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
136 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
137 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
139 ns3_node_t host_src = ns3_find_host(host_id);
140 ns3_node_t host_dst = ns3_find_host(router_id);
142 xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
144 ns3_add_link(host_src->node_num,NS3_NETWORK_ELEMENT_HOST,
145 host_dst->node_num,NS3_NETWORK_ELEMENT_HOST,
153 xbt_dynar_free(&tab_elements_num);
156 //Create link backbone
157 lat = bprintf("%fs", cluster->bb_lat);
158 bw = bprintf("%fBps", cluster->bb_bw);
159 ns3_add_cluster(bw,lat,cluster->id);
164 /* Create the ns3 topology based on routing strategy */
165 static void create_ns3_topology(void)
167 XBT_DEBUG("Starting topology generation");
169 xbt_dynar_shrink(IPV4addr,0);
171 //get the onelinks from the parsed platform
172 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
174 std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
176 XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
177 simgrid::surf::Onelink *onelink;
179 xbt_dynar_foreach(onelink_routes, iter, onelink) {
180 char *src = onelink->src_->name();
181 char *dst = onelink->dst_->name();
182 simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
184 if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
185 already_seen.insert(link);
186 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
187 char * link_bdw = bprintf("%fBps", link->getBandwidth());
188 char * link_lat = bprintf("%fs", link->getLatency());
190 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
191 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
194 ns3_node_t host_src = ns3_find_host(src);
196 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
197 ns3_node_t host_dst = ns3_find_host(dst);
199 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
201 if (!host_src || !host_dst)
202 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
204 ns3_add_link(host_src->node_num,NS3_NETWORK_ELEMENT_HOST,host_dst->node_num,NS3_NETWORK_ELEMENT_HOST,link_bdw,link_lat);
215 void surf_network_model_init_NS3()
217 if (surf_network_model)
220 surf_network_model = new simgrid::surf::NetworkNS3Model();
221 xbt_dynar_push(all_existing_models, &surf_network_model);
227 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
228 ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"));
230 routing_model_create(NULL);
231 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
232 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_netcard);
233 simgrid::surf::on_link.connect(netlink_parse_init);
234 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
235 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
236 simgrid::surf::on_postparse.connect(&ns3_end_platform); //InitializeRoutes
238 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
239 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
242 NetworkNS3Model::~NetworkNS3Model() {
244 xbt_dynar_free_container(&IPV4addr);
245 xbt_dict_free(&flowFromSock);
248 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
249 xbt_dict_t properties){
251 return new LinkNS3(this, name, properties, bandwidth, latency);
254 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
256 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
257 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
259 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
261 action->m_lastSent = 0;
262 action->p_srcElm = src;
263 action->p_dstElm = dst;
264 networkCommunicateCallbacks(action, src, dst, size, rate);
269 double NetworkNS3Model::next_occuring_event(double now)
271 XBT_DEBUG("ns3_next_occuring_event");
273 //get the first relevant value from the running_actions list
274 if (!getRunningActionSet()->size() || now == 0.0)
279 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
280 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
282 XBT_DEBUG("min : %f", now);
283 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
284 XBT_DEBUG("surf time : %f", surf_get_clock());
285 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
287 return time_to_next_flow_completion;
290 void NetworkNS3Model::updateActionsState(double now, double delta)
292 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
294 /* If there are no running flows, advance the NS3 simulator and return */
295 if (getRunningActionSet()->empty()) {
297 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
298 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
303 xbt_dict_cursor_t cursor = NULL;
306 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
307 NetworkNS3Action * action = sgFlow->action_;
308 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
309 action->setRemains(action->getCost() - sgFlow->sentBytes_);
311 if (TRACE_is_enabled() &&
312 action->getState() == Action::State::running){
313 double data_delta_sent = sgFlow->sentBytes_ - action->m_lastSent;
315 std::vector<Link*> *route = new std::vector<Link*>();
317 routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
318 for (auto link : *route)
319 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
322 action->m_lastSent = sgFlow->sentBytes_;
325 if(sgFlow->finished_){
326 xbt_dynar_push(socket_to_destroy,&ns3Socket);
327 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
329 action->setState(Action::State::done);
333 while (!xbt_dynar_is_empty(socket_to_destroy)){
334 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
336 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
337 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
338 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
340 xbt_dict_remove(flowFromSock, ns3Socket);
349 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
350 : Link(model, name, props)
352 m_bandwidth.peak = bandwidth;
353 m_latency.peak = latency;
355 Link::onCreation(this);
362 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
366 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
367 xbt_die("The NS3 network model doesn't support latency state traces");
369 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
370 xbt_die("The NS3 network model doesn't support latency state traces");
377 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
378 : NetworkAction(model, cost, failed)
381 void NetworkNS3Action::suspend()
386 void NetworkNS3Action::resume()
391 /* Test whether a flow is suspended */
392 bool NetworkNS3Action::isSuspended()
397 int NetworkNS3Action::unref()
401 if (action_hook.is_linked())
402 p_stateSet->erase(p_stateSet->iterator_to(*this));
403 XBT_DEBUG ("Removing action %p", this);
417 void ns3_simulator(double min){
418 ns3_sim->simulator_start(min);
421 void ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
423 ns3_node_t node1 = ns3_find_host(a);
424 ns3_node_t node2 = ns3_find_host(b);
426 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1->node_num);
427 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2->node_num);
429 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2->node_num,char*);
431 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1->node_num, node2->node_num,addr);
432 ns3_sim->create_flow_NS3(src_node, dst_node, port_number, start, addr, TotalBytes, action);
435 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
438 // initialize the NS3 interface and environment
439 void ns3_initialize(const char* TcpProtocol){
440 xbt_assert(!ns3_sim, "ns3 already initialized");
441 ns3_sim = new NS3Sim();
448 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
449 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
451 if (!strcmp(TcpProtocol,"default"))
454 if (!strcmp(TcpProtocol,"Reno")) {
455 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
456 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
459 if (!strcmp(TcpProtocol,"NewReno")) {
460 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
461 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
464 if(!strcmp(TcpProtocol,"Tahoe")){
465 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
466 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
470 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
473 void * ns3_add_host_cluster(const char * id)
475 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
476 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
477 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
479 Cluster_nodes.Add(node);
481 host->node_num = number_of_nodes;
486 void ns3_add_cluster(char * bw,char * lat,const char *id)
489 XBT_DEBUG("cluster_id: %s",id);
490 XBT_DEBUG("bw: %s lat: %s",bw,lat);
491 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
493 ns3::NodeContainer Nodes;
495 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
496 Nodes.Add(Cluster_nodes.Get(i));
497 XBT_DEBUG("Add node %d to cluster",i);
499 number_of_clusters_nodes = Cluster_nodes.GetN();
501 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
502 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
504 if(Nodes.GetN() > 65000)
505 xbt_die("Cluster with NS3 is limited to 65000 nodes");
506 ns3::CsmaHelper csma;
507 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
508 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
509 ns3::NetDeviceContainer devices = csma.Install (Nodes);
510 XBT_DEBUG("Create CSMA");
512 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
513 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
514 ns3::Ipv4AddressHelper ipv4;
515 ipv4.SetBase (adr, "255.255.0.0");
517 interfaces.Add(ipv4.Assign (devices));
519 if(number_of_links == 255){
520 if(number_of_networks == 255)
521 xbt_die("Number of links and networks exceed 255*255");
523 number_of_networks++;
527 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
530 static char* transformIpv4Address (ns3::Ipv4Address from){
531 std::stringstream sstream;
533 std::string s = sstream.str();
534 return bprintf("%s",s.c_str());
537 void ns3_add_link(int src, e_ns3_network_element_type_t type_src,
538 int dst, e_ns3_network_element_type_t type_dst,
541 if(number_of_links == 1 ) {
542 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
543 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
546 ns3::MyPointToPointHelper pointToPoint;
548 ns3::NetDeviceContainer netA;
549 ns3::Ipv4AddressHelper address;
551 ns3::Ptr<ns3::Node> a = nodes.Get(src);
552 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
554 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
555 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
556 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
557 //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
559 netA.Add(pointToPoint.Install (a, type_src, b, type_dst));
561 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
562 address.SetBase (adr, "255.255.0.0");
563 XBT_DEBUG("\tInterface stack '%s'",adr);
565 interfaces.Add(address.Assign (netA));
567 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
568 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
569 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
571 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
572 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
573 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
575 if(number_of_links == 255){
576 if(number_of_networks == 255)
577 xbt_die("Number of links and networks exceed 255*255");
579 number_of_networks++;
585 void ns3_end_platform(void)
587 XBT_DEBUG("InitializeRoutes");
588 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
589 ns3::GlobalRouteManager::InitializeRoutes();