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 <xbt/config.hpp>
11 #include "ns3/core-module.h"
14 #include "ns3/ns3_interface.h"
15 #include "ns3/ns3_simulator.h"
16 #include "src/surf/network_ns3.hpp"
18 #include "src/surf/HostImpl.hpp"
19 #include "src/surf/surf_private.h"
20 #include "simgrid/sg_config.h"
21 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
23 #include "simgrid/s4u/As.hpp"
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
29 xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
35 extern xbt_dict_t flowFromSock;
37 static ns3::InternetStackHelper stack;
38 static ns3::NodeContainer nodes;
39 static ns3::NodeContainer Cluster_nodes;
40 static ns3::Ipv4InterfaceContainer interfaces;
42 static int number_of_nodes = 0;
43 static int number_of_clusters_nodes = 0;
44 static int number_of_links = 1;
45 static int number_of_networks = 1;
46 static int port_number = 1025; //Port number is limited from 1025 to 65 000
52 static void 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 ++;
63 host.extension_set(NS3_EXTENSION_ID, ns3host);
66 static void ns3_add_netcard(simgrid::surf::NetCard* netcard)
68 const char* id = netcard->name();
70 ns3_node_t ns3netcard = xbt_new0(s_ns3_node_t,1);
71 XBT_DEBUG("Interface ns3 add netcard[%d] '%s'",number_of_nodes,id);
72 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
75 ns3netcard->node_num = number_of_nodes++;
77 xbt_lib_set(as_router_lib, id, NS3_ASR_LEVEL, ns3netcard );
80 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
81 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
83 const char *groups = NULL;
88 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
90 char *router_id,*host_id;
92 xbt_dynar_t radical_elements = xbt_str_split(cluster->radical, ",");
93 xbt_dynar_foreach(radical_elements, iter, groups) {
94 xbt_dynar_t radical_ends = xbt_str_split(groups, "-");
96 switch (xbt_dynar_length(radical_ends)) {
98 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
99 xbt_dynar_push_as(tab_elements_num, int, start);
100 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
101 simgrid::s4u::Host::by_name_or_create(router_id)->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
102 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
107 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
108 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
109 for (i = start; i <= end; i++){
110 xbt_dynar_push_as(tab_elements_num, int, i);
111 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
112 simgrid::s4u::Host::by_name_or_create(router_id)->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
113 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
119 XBT_DEBUG("Malformed radical");
126 char * lat = bprintf("%fs", cluster->lat);
127 char * bw = bprintf("%fBps", cluster->bw);
129 xbt_dynar_foreach(tab_elements_num,cpt,elmts) {
130 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
131 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
132 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
134 ns3_node_t host_src = ns3_find_host(host_id);
135 ns3_node_t host_dst = ns3_find_host(router_id);
137 xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
139 ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
146 xbt_dynar_free(&tab_elements_num);
149 //Create link backbone
150 lat = bprintf("%fs", cluster->bb_lat);
151 bw = bprintf("%fBps", cluster->bb_bw);
152 ns3_add_cluster(bw,lat,cluster->id);
157 /* Create the ns3 topology based on routing strategy */
158 static void create_ns3_topology(void)
160 XBT_DEBUG("Starting topology generation");
162 xbt_dynar_shrink(IPV4addr,0);
164 //get the onelinks from the parsed platform
165 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
167 std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
169 XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
170 simgrid::surf::Onelink *onelink;
172 xbt_dynar_foreach(onelink_routes, iter, onelink) {
173 char *src = onelink->src_->name();
174 char *dst = onelink->dst_->name();
175 simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
177 if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
178 already_seen.insert(link);
179 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
180 char * link_bdw = bprintf("%fBps", link->getBandwidth());
181 char * link_lat = bprintf("%fs", link->getLatency());
183 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
184 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
187 ns3_node_t host_src = ns3_find_host(src);
189 host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
190 ns3_node_t host_dst = ns3_find_host(dst);
192 host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
194 if (!host_src || !host_dst)
195 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
197 ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
204 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
205 ns3::GlobalRouteManager::InitializeRoutes();
211 void surf_network_model_init_NS3()
213 if (surf_network_model)
216 surf_network_model = new simgrid::surf::NetworkNS3Model();
217 xbt_dynar_push(all_existing_models, &surf_network_model);
220 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
221 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
227 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
228 ns3_initialize(ns3_tcp_model.get().c_str());
230 routing_model_create(NULL);
231 simgrid::s4u::Host::onCreation.connect(ns3_add_host);
232 simgrid::surf::netcardCreatedCallbacks.connect(ns3_add_netcard);
233 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
234 simgrid::surf::on_postparse.connect(&create_ns3_topology);
236 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
237 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
239 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
240 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
243 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 return new NetworkNS3Action(this, size, src, dst);
259 double NetworkNS3Model::next_occuring_event(double now)
261 double time_to_next_flow_completion;
262 XBT_DEBUG("ns3_next_occuring_event");
264 //get the first relevant value from the running_actions list
265 if (!getRunningActionSet()->size() || now == 0.0)
270 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
271 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
273 XBT_DEBUG("min : %f", now);
274 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
275 XBT_DEBUG("surf time : %f", surf_get_clock());
276 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
278 return time_to_next_flow_completion;
281 void NetworkNS3Model::updateActionsState(double now, double delta)
283 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
285 /* If there are no running flows, advance the NS3 simulator and return */
286 if (getRunningActionSet()->empty()) {
288 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
289 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
294 xbt_dict_cursor_t cursor = NULL;
297 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
298 NetworkNS3Action * action = sgFlow->action_;
299 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
300 action->setRemains(action->getCost() - sgFlow->sentBytes_);
302 if (TRACE_is_enabled() &&
303 action->getState() == Action::State::running){
304 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
306 std::vector<Link*> *route = new std::vector<Link*>();
308 routing_platf->getRouteAndLatency (action->src_, action->dst_, route, NULL);
309 for (auto link : *route)
310 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
313 action->lastSent_ = sgFlow->sentBytes_;
316 if(sgFlow->finished_){
317 xbt_dynar_push(socket_to_destroy,&ns3Socket);
318 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
320 action->setState(Action::State::done);
324 while (!xbt_dynar_is_empty(socket_to_destroy)){
325 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
327 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
328 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
329 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
331 xbt_dict_remove(flowFromSock, ns3Socket);
339 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
340 : Link(model, name, props)
342 m_bandwidth.peak = bandwidth;
343 m_latency.peak = latency;
345 Link::onCreation(this);
352 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
356 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
357 xbt_die("The NS3 network model doesn't support bandwidth traces");
359 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
360 xbt_die("The NS3 network model doesn't support latency traces");
367 NetworkNS3Action::NetworkNS3Action(Model *model, double size, NetCard *src, NetCard *dst)
368 : NetworkAction(model, size, false)
370 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
374 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, this);
376 Link::onCommunicate(this, src, dst);
379 void NetworkNS3Action::suspend() {
383 void NetworkNS3Action::resume() {
387 /* Test whether a flow is suspended */
388 bool NetworkNS3Action::isSuspended()
393 int NetworkNS3Action::unref()
397 if (action_hook.is_linked())
398 stateSet_->erase(stateSet_->iterator_to(*this));
399 XBT_DEBUG ("Removing action %p", this);
410 void ns3_simulator(double maxSeconds){
411 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
412 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
413 XBT_DEBUG("Start simulator for at most %fs",maxSeconds);
414 ns3::Simulator::Run ();
417 void ns3_create_flow(const char* a,const char *b,double startTime,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
419 int node1 = ns3_find_host(a)->node_num;
420 int node2 = ns3_find_host(b)->node_num;
422 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
423 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
425 char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2,char*);
427 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
428 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
429 sink.Install (dst_node);
431 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket (src_node, ns3::TcpSocketFactory::GetTypeId());
433 xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), NULL);
435 sock->Bind(ns3::InetSocketAddress(port_number));
436 XBT_DEBUG("Create flow starting to %fs + %fs = %fs",
437 startTime-ns3::Simulator::Now().GetSeconds(), ns3::Simulator::Now().GetSeconds(), startTime);
439 ns3::Simulator::Schedule (ns3::Seconds(startTime-ns3::Simulator::Now().GetSeconds()),
440 &StartFlow, sock, addr, port_number);
443 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
446 // initialize the NS3 interface and environment
447 void ns3_initialize(const char* TcpProtocol){
453 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
454 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
456 if (!strcmp(TcpProtocol,"default"))
459 if (!strcmp(TcpProtocol,"Reno")) {
460 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
461 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
464 if (!strcmp(TcpProtocol,"NewReno")) {
465 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
466 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
469 if(!strcmp(TcpProtocol,"Tahoe")){
470 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
471 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
475 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
478 void * ns3_add_host_cluster(const char * id)
480 ns3_node_t host = xbt_new0(s_ns3_node_t,1);
481 XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
482 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
484 Cluster_nodes.Add(node);
486 host->node_num = number_of_nodes;
491 void ns3_add_cluster(char * bw,char * lat,const char *id)
493 XBT_DEBUG("cluster_id: %s",id);
494 XBT_DEBUG("bw: %s lat: %s",bw,lat);
495 XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
497 ns3::NodeContainer Nodes;
499 for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
500 Nodes.Add(Cluster_nodes.Get(i));
501 XBT_DEBUG("Add node %d to cluster",i);
503 number_of_clusters_nodes = Cluster_nodes.GetN();
505 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
506 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
508 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
509 ns3::CsmaHelper csma;
510 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
511 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
512 ns3::NetDeviceContainer devices = csma.Install (Nodes);
513 XBT_DEBUG("Create CSMA");
515 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
516 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
517 ns3::Ipv4AddressHelper ipv4;
518 ipv4.SetBase (adr, "255.255.0.0");
520 interfaces.Add(ipv4.Assign (devices));
522 if(number_of_links == 255){
523 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
525 number_of_networks++;
529 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
532 static char* transformIpv4Address (ns3::Ipv4Address from){
533 std::stringstream sstream;
535 std::string s = sstream.str();
536 return bprintf("%s",s.c_str());
539 void ns3_add_link(int src, int dst, char *bw, char *lat)
541 ns3::PointToPointHelper pointToPoint;
543 ns3::NetDeviceContainer netA;
544 ns3::Ipv4AddressHelper address;
546 ns3::Ptr<ns3::Node> a = nodes.Get(src);
547 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
549 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
550 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
551 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
553 netA.Add(pointToPoint.Install (a, b));
555 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
556 address.SetBase (adr, "255.255.0.0");
557 XBT_DEBUG("\tInterface stack '%s'",adr);
559 interfaces.Add(address.Assign (netA));
561 char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
562 xbt_dynar_set_as(IPV4addr,src,char*,tmp);
563 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
565 tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
566 xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
567 XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
569 if (number_of_links == 255){
570 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
572 number_of_networks++;