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++;
79 xbt_lib_set(as_router_lib, id, NS3_ASR_LEVEL, ns3netcard );
82 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
83 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
85 const char *groups = NULL;
90 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
92 char *router_id,*host_id;
94 xbt_dynar_t radical_elements = xbt_str_split(cluster->radical, ",");
95 xbt_dynar_foreach(radical_elements, iter, groups) {
96 xbt_dynar_t radical_ends = xbt_str_split(groups, "-");
98 switch (xbt_dynar_length(radical_ends)) {
100 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
101 xbt_dynar_push_as(tab_elements_num, int, start);
102 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
103 simgrid::s4u::Host::by_name_or_create(router_id)
104 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
105 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
110 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
111 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
112 for (i = start; i <= end; i++){
113 xbt_dynar_push_as(tab_elements_num, int, i);
114 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
115 simgrid::s4u::Host::by_name_or_create(router_id)
116 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
117 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
123 XBT_DEBUG("Malformed radical");
130 char * lat = bprintf("%fs", cluster->lat);
131 char * bw = bprintf("%fBps", cluster->bw);
133 xbt_dynar_foreach(tab_elements_num,cpt,elmts) {
134 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
135 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
136 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
138 ns3_node_t host_src = ns3_find_host(host_id);
139 ns3_node_t host_dst = ns3_find_host(router_id);
141 xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
143 ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
150 xbt_dynar_free(&tab_elements_num);
153 //Create link backbone
154 lat = bprintf("%fs", cluster->bb_lat);
155 bw = bprintf("%fBps", cluster->bb_bw);
156 ns3_add_cluster(bw,lat,cluster->id);
161 /* Create the ns3 topology based on routing strategy */
162 static void create_ns3_topology(void)
164 XBT_DEBUG("Starting topology generation");
166 xbt_dynar_shrink(IPV4addr,0);
168 //get the onelinks from the parsed platform
169 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
171 std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
173 XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
174 simgrid::surf::Onelink *onelink;
176 xbt_dynar_foreach(onelink_routes, iter, onelink) {
177 char *src = onelink->src_->name();
178 char *dst = onelink->dst_->name();
179 simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
181 if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
182 already_seen.insert(link);
183 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
184 char * link_bdw = bprintf("%fBps", link->getBandwidth());
185 char * link_lat = bprintf("%fs", link->getLatency());
187 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
188 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
191 ns3_node_t host_src = ns3_find_host(src);
193 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
194 ns3_node_t host_dst = ns3_find_host(dst);
196 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
198 if (!host_src || !host_dst)
199 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
201 ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
212 void surf_network_model_init_NS3()
214 if (surf_network_model)
217 surf_network_model = new simgrid::surf::NetworkNS3Model();
218 xbt_dynar_push(all_existing_models, &surf_network_model);
224 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
225 ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"));
227 routing_model_create(NULL);
228 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
229 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_netcard);
230 simgrid::surf::on_link.connect(netlink_parse_init);
231 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
232 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
233 simgrid::surf::on_postparse.connect(&ns3_end_platform); //InitializeRoutes
235 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
236 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
239 NetworkNS3Model::~NetworkNS3Model() {
241 xbt_dynar_free_container(&IPV4addr);
242 xbt_dict_free(&flowFromSock);
245 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
246 xbt_dict_t properties){
248 return new LinkNS3(this, name, properties, bandwidth, latency);
251 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
253 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
254 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
256 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
258 action->m_lastSent = 0;
259 action->p_srcElm = src;
260 action->p_dstElm = dst;
261 networkCommunicateCallbacks(action, src, dst, size, rate);
266 double NetworkNS3Model::next_occuring_event(double now)
268 XBT_DEBUG("ns3_next_occuring_event");
270 //get the first relevant value from the running_actions list
271 if (!getRunningActionSet()->size() || now == 0.0)
276 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
277 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
279 XBT_DEBUG("min : %f", now);
280 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
281 XBT_DEBUG("surf time : %f", surf_get_clock());
282 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
284 return time_to_next_flow_completion;
287 void NetworkNS3Model::updateActionsState(double now, double delta)
289 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
291 /* If there are no running flows, advance the NS3 simulator and return */
292 if (getRunningActionSet()->empty()) {
294 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
295 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
300 xbt_dict_cursor_t cursor = NULL;
303 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
304 NetworkNS3Action * action = sgFlow->action_;
305 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
306 action->setRemains(action->getCost() - sgFlow->sentBytes_);
308 if (TRACE_is_enabled() &&
309 action->getState() == Action::State::running){
310 double data_delta_sent = sgFlow->sentBytes_ - action->m_lastSent;
312 std::vector<Link*> *route = new std::vector<Link*>();
314 routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
315 for (auto link : *route)
316 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
319 action->m_lastSent = sgFlow->sentBytes_;
322 if(sgFlow->finished_){
323 xbt_dynar_push(socket_to_destroy,&ns3Socket);
324 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
326 action->setState(Action::State::done);
330 while (!xbt_dynar_is_empty(socket_to_destroy)){
331 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
333 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
334 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
335 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
337 xbt_dict_remove(flowFromSock, ns3Socket);
346 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
347 : Link(model, name, props)
349 m_bandwidth.peak = bandwidth;
350 m_latency.peak = latency;
352 Link::onCreation(this);
359 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
363 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
364 xbt_die("The NS3 network model doesn't support latency state traces");
366 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
367 xbt_die("The NS3 network model doesn't support latency state traces");
374 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
375 : NetworkAction(model, cost, failed)
378 void NetworkNS3Action::suspend()
383 void NetworkNS3Action::resume()
388 /* Test whether a flow is suspended */
389 bool NetworkNS3Action::isSuspended()
394 int NetworkNS3Action::unref()
398 if (action_hook.is_linked())
399 p_stateSet->erase(p_stateSet->iterator_to(*this));
400 XBT_DEBUG ("Removing action %p", this);
414 void ns3_simulator(double min){
415 ns3_sim->simulator_start(min);
418 void ns3_create_flow(const char* a,const char *b,double start,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
420 int node1 = ns3_find_host(a)->node_num;
421 int node2 = ns3_find_host(b)->node_num;
423 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
424 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
426 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2,char*);
428 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
429 ns3_sim->create_flow_NS3(src_node, dst_node, port_number, start, addr, TotalBytes, action);
432 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
435 // initialize the NS3 interface and environment
436 void ns3_initialize(const char* TcpProtocol){
437 xbt_assert(!ns3_sim, "ns3 already initialized");
438 ns3_sim = new NS3Sim();
445 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
446 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
448 if (!strcmp(TcpProtocol,"default"))
451 if (!strcmp(TcpProtocol,"Reno")) {
452 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
453 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
456 if (!strcmp(TcpProtocol,"NewReno")) {
457 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
458 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
461 if(!strcmp(TcpProtocol,"Tahoe")){
462 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
463 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
467 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
470 void * ns3_add_host_cluster(const char * id)
472 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
473 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
474 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
476 Cluster_nodes.Add(node);
478 host->node_num = number_of_nodes;
483 void ns3_add_cluster(char * bw,char * lat,const char *id)
486 XBT_DEBUG("cluster_id: %s",id);
487 XBT_DEBUG("bw: %s lat: %s",bw,lat);
488 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
490 ns3::NodeContainer Nodes;
492 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
493 Nodes.Add(Cluster_nodes.Get(i));
494 XBT_DEBUG("Add node %d to cluster",i);
496 number_of_clusters_nodes = Cluster_nodes.GetN();
498 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
499 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
501 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
502 ns3::CsmaHelper csma;
503 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
504 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
505 ns3::NetDeviceContainer devices = csma.Install (Nodes);
506 XBT_DEBUG("Create CSMA");
508 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
509 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
510 ns3::Ipv4AddressHelper ipv4;
511 ipv4.SetBase (adr, "255.255.0.0");
513 interfaces.Add(ipv4.Assign (devices));
515 if(number_of_links == 255){
516 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
518 number_of_networks++;
522 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
525 static char* transformIpv4Address (ns3::Ipv4Address from){
526 std::stringstream sstream;
528 std::string s = sstream.str();
529 return bprintf("%s",s.c_str());
532 void ns3_add_link(int src, int dst, char *bw, char *lat)
534 if(number_of_links == 1 ) {
535 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
536 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
539 ns3::PointToPointHelper pointToPoint;
541 ns3::NetDeviceContainer netA;
542 ns3::Ipv4AddressHelper address;
544 ns3::Ptr<ns3::Node> a = nodes.Get(src);
545 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
547 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
548 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
549 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
550 //pointToPoint.EnablePcapAll("test_ns3_trace"); //DEBUG
552 netA.Add(pointToPoint.Install (a, b));
554 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
555 address.SetBase (adr, "255.255.0.0");
556 XBT_DEBUG("\tInterface stack '%s'",adr);
558 interfaces.Add(address.Assign (netA));
560 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
561 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
562 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
564 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
565 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
566 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
568 if(number_of_links == 255){
569 if(number_of_networks == 255)
570 xbt_die("Number of links and networks exceed 255*255");
572 number_of_networks++;
578 void ns3_end_platform(void)
580 XBT_DEBUG("InitializeRoutes");
581 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
582 ns3::GlobalRouteManager::InitializeRoutes();