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);
33 extern xbt_dict_t flowFromSock;
35 static ns3::InternetStackHelper stack;
36 static ns3::NodeContainer nodes;
37 static ns3::NodeContainer Cluster_nodes;
38 static ns3::Ipv4InterfaceContainer interfaces;
40 static int number_of_nodes = 0;
41 static int number_of_clusters_nodes = 0;
42 static int number_of_links = 1;
43 static int number_of_networks = 1;
44 static int port_number = 1025; //Port number is limited from 1025 to 65 000
50 static void ns3_add_host(simgrid::s4u::Host& host)
52 const char* id = host.name().c_str();
53 XBT_DEBUG("NS3_ADD_HOST '%s'", id);
55 ns3_node_t ns3host = xbt_new0(s_ns3_node_t,1);
56 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
59 ns3host->node_num = number_of_nodes ++;
61 host.extension_set(NS3_EXTENSION_ID, ns3host);
64 static void ns3_add_netcard(simgrid::surf::NetCard* netcard)
66 const char* id = netcard->name();
68 ns3_node_t ns3netcard = xbt_new0(s_ns3_node_t,1);
69 XBT_DEBUG("Interface ns3 add netcard[%d] '%s'",number_of_nodes,id);
70 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
73 ns3netcard->node_num = number_of_nodes++;
75 xbt_lib_set(as_router_lib, id, NS3_ASR_LEVEL, ns3netcard );
78 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
79 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
81 const char *groups = NULL;
86 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
88 char *router_id,*host_id;
90 xbt_dynar_t radical_elements = xbt_str_split(cluster->radical, ",");
91 xbt_dynar_foreach(radical_elements, iter, groups) {
92 xbt_dynar_t radical_ends = xbt_str_split(groups, "-");
94 switch (xbt_dynar_length(radical_ends)) {
96 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
97 xbt_dynar_push_as(tab_elements_num, int, start);
98 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
99 simgrid::s4u::Host::by_name_or_create(router_id)->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
100 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
105 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
106 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
107 for (i = start; i <= end; i++){
108 xbt_dynar_push_as(tab_elements_num, int, i);
109 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
110 simgrid::s4u::Host::by_name_or_create(router_id)->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
111 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
117 XBT_DEBUG("Malformed radical");
124 char * lat = bprintf("%fs", cluster->lat);
125 char * bw = bprintf("%fBps", cluster->bw);
127 xbt_dynar_foreach(tab_elements_num,cpt,elmts) {
128 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
129 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
130 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
132 ns3_node_t host_src = ns3_find_host(host_id);
133 ns3_node_t host_dst = ns3_find_host(router_id);
135 xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
137 ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
144 xbt_dynar_free(&tab_elements_num);
147 //Create link backbone
148 lat = bprintf("%fs", cluster->bb_lat);
149 bw = bprintf("%fBps", cluster->bb_bw);
150 ns3_add_cluster(bw,lat,cluster->id);
155 /* Create the ns3 topology based on routing strategy */
156 static void create_ns3_topology(void)
158 XBT_DEBUG("Starting topology generation");
160 xbt_dynar_shrink(IPV4addr,0);
162 //get the onelinks from the parsed platform
163 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
165 std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
167 XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
168 simgrid::surf::Onelink *onelink;
170 xbt_dynar_foreach(onelink_routes, iter, onelink) {
171 char *src = onelink->src_->name();
172 char *dst = onelink->dst_->name();
173 simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
175 if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
176 already_seen.insert(link);
177 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
178 char * link_bdw = bprintf("%fBps", link->getBandwidth());
179 char * link_lat = bprintf("%fs", link->getLatency());
181 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
182 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
185 ns3_node_t host_src = ns3_find_host(src);
187 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
188 ns3_node_t host_dst = ns3_find_host(dst);
190 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
192 if (!host_src || !host_dst)
193 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
195 ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
202 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
203 ns3::GlobalRouteManager::InitializeRoutes();
209 void surf_network_model_init_NS3()
211 if (surf_network_model)
214 surf_network_model = new simgrid::surf::NetworkNS3Model();
215 xbt_dynar_push(all_existing_models, &surf_network_model);
221 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
222 ns3_initialize(xbt_cfg_get_string("ns3/TcpModel"));
224 routing_model_create(NULL);
225 simgrid::s4u::Host::onCreation.connect(ns3_add_host);
226 simgrid::surf::netcardCreatedCallbacks.connect(ns3_add_netcard);
227 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
228 simgrid::surf::on_postparse.connect(&create_ns3_topology);
230 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
231 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
233 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
234 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
237 NetworkNS3Model::~NetworkNS3Model() {
238 xbt_dynar_free_container(&IPV4addr);
239 xbt_dict_free(&flowFromSock);
242 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
243 xbt_dict_t properties){
245 return new LinkNS3(this, name, properties, bandwidth, latency);
248 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
250 return new NetworkNS3Action(this, size, src, dst);
253 double NetworkNS3Model::next_occuring_event(double now)
255 double time_to_next_flow_completion;
256 XBT_DEBUG("ns3_next_occuring_event");
258 //get the first relevant value from the running_actions list
259 if (!getRunningActionSet()->size() || now == 0.0)
264 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
265 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
267 XBT_DEBUG("min : %f", now);
268 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
269 XBT_DEBUG("surf time : %f", surf_get_clock());
270 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
272 return time_to_next_flow_completion;
275 void NetworkNS3Model::updateActionsState(double now, double delta)
277 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
279 /* If there are no running flows, advance the NS3 simulator and return */
280 if (getRunningActionSet()->empty()) {
282 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
283 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
288 xbt_dict_cursor_t cursor = NULL;
291 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
292 NetworkNS3Action * action = sgFlow->action_;
293 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
294 action->setRemains(action->getCost() - sgFlow->sentBytes_);
296 if (TRACE_is_enabled() &&
297 action->getState() == Action::State::running){
298 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
300 std::vector<Link*> *route = new std::vector<Link*>();
302 routing_platf->getRouteAndLatency (action->src_, action->dst_, route, NULL);
303 for (auto link : *route)
304 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
307 action->lastSent_ = sgFlow->sentBytes_;
310 if(sgFlow->finished_){
311 xbt_dynar_push(socket_to_destroy,&ns3Socket);
312 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
314 action->setState(Action::State::done);
318 while (!xbt_dynar_is_empty(socket_to_destroy)){
319 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
321 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
322 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
323 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
325 xbt_dict_remove(flowFromSock, ns3Socket);
333 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
334 : Link(model, name, props)
336 m_bandwidth.peak = bandwidth;
337 m_latency.peak = latency;
339 Link::onCreation(this);
346 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
350 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
351 xbt_die("The NS3 network model doesn't support bandwidth traces");
353 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
354 xbt_die("The NS3 network model doesn't support latency traces");
361 NetworkNS3Action::NetworkNS3Action(Model *model, double size, NetCard *src, NetCard *dst)
362 : NetworkAction(model, size, false)
364 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
368 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, this);
370 Link::onCommunicate(this, src, dst);
373 void NetworkNS3Action::suspend() {
377 void NetworkNS3Action::resume() {
381 /* Test whether a flow is suspended */
382 bool NetworkNS3Action::isSuspended()
387 int NetworkNS3Action::unref()
391 if (action_hook.is_linked())
392 stateSet_->erase(stateSet_->iterator_to(*this));
393 XBT_DEBUG ("Removing action %p", this);
404 void ns3_simulator(double maxSeconds){
405 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
406 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
407 XBT_DEBUG("Start simulator for at most %fs",maxSeconds);
408 ns3::Simulator::Run ();
411 void ns3_create_flow(const char* a,const char *b,double startTime,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
413 int node1 = ns3_find_host(a)->node_num;
414 int node2 = ns3_find_host(b)->node_num;
416 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
417 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
419 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2,char*);
421 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
422 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
423 sink.Install (dst_node);
425 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket (src_node, ns3::TcpSocketFactory::GetTypeId());
427 xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), NULL);
429 sock->Bind(ns3::InetSocketAddress(port_number));
430 XBT_DEBUG("Create flow starting to %fs + %fs = %fs",
431 startTime-ns3::Simulator::Now().GetSeconds(), ns3::Simulator::Now().GetSeconds(), startTime);
433 ns3::Simulator::Schedule (ns3::Seconds(startTime-ns3::Simulator::Now().GetSeconds()),
434 &StartFlow, sock, addr, port_number);
437 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
440 // initialize the NS3 interface and environment
441 void ns3_initialize(const char* TcpProtocol){
447 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
448 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
450 if (!strcmp(TcpProtocol,"default"))
453 if (!strcmp(TcpProtocol,"Reno")) {
454 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
455 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
458 if (!strcmp(TcpProtocol,"NewReno")) {
459 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
460 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
463 if(!strcmp(TcpProtocol,"Tahoe")){
464 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
465 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
469 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
472 void * ns3_add_host_cluster(const char * id)
474 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
475 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
476 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
478 Cluster_nodes.Add(node);
480 host->node_num = number_of_nodes;
485 void ns3_add_cluster(char * bw,char * lat,const char *id)
487 XBT_DEBUG("cluster_id: %s",id);
488 XBT_DEBUG("bw: %s lat: %s",bw,lat);
489 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
491 ns3::NodeContainer Nodes;
493 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
494 Nodes.Add(Cluster_nodes.Get(i));
495 XBT_DEBUG("Add node %d to cluster",i);
497 number_of_clusters_nodes = Cluster_nodes.GetN();
499 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
500 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
502 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
503 ns3::CsmaHelper csma;
504 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
505 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
506 ns3::NetDeviceContainer devices = csma.Install (Nodes);
507 XBT_DEBUG("Create CSMA");
509 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
510 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
511 ns3::Ipv4AddressHelper ipv4;
512 ipv4.SetBase (adr, "255.255.0.0");
514 interfaces.Add(ipv4.Assign (devices));
516 if(number_of_links == 255){
517 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
519 number_of_networks++;
523 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
526 static char* transformIpv4Address (ns3::Ipv4Address from){
527 std::stringstream sstream;
529 std::string s = sstream.str();
530 return bprintf("%s",s.c_str());
533 void ns3_add_link(int src, int dst, char *bw, char *lat)
535 ns3::PointToPointHelper pointToPoint;
537 ns3::NetDeviceContainer netA;
538 ns3::Ipv4AddressHelper address;
540 ns3::Ptr<ns3::Node> a = nodes.Get(src);
541 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
543 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
544 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
545 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
547 netA.Add(pointToPoint.Install (a, b));
549 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
550 address.SetBase (adr, "255.255.0.0");
551 XBT_DEBUG("\tInterface stack '%s'",adr);
553 interfaces.Add(address.Assign (netA));
555 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
556 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
557 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
559 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
560 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
561 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
563 if (number_of_links == 255){
564 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
566 number_of_networks++;