1 /* Copyright (c) 2007-2016. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include <unordered_set>
8 #include "xbt/config.hpp"
10 #include "ns3/core-module.h"
13 #include "ns3/ns3_interface.h"
14 #include "ns3/ns3_simulator.h"
15 #include "network_ns3.hpp"
17 #include "simgrid/sg_config.h"
18 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
19 #include "src/kernel/routing/NetPoint.hpp"
20 #include "src/surf/HostImpl.hpp"
21 #include "src/surf/surf_private.h"
23 #include "simgrid/s4u/NetZone.hpp"
24 #include "simgrid/s4u/engine.hpp"
26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
28 std::vector<char*> IPV4addr;
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 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
49 NetPointNs3::NetPointNs3()
51 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
54 node_num = number_of_nodes++;
61 static void clusterCreation_cb(sg_platf_cluster_cbarg_t cluster)
63 char* lat = bprintf("%fs", cluster->lat);
64 char* bw = bprintf("%fBps", cluster->bw);
66 for (int i : *cluster->radicals) {
67 // Routers don't create a router on the other end of the private link by themselves.
68 // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
69 NetPointNs3* host_dst = new NetPointNs3();
71 // Create private link
72 char* host_id = bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
73 NetPointNs3* host_src = sg_host_by_name(host_id)->pimpl_netpoint->extension<NetPointNs3>();
74 xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id);
76 ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
84 //Create link backbone
85 lat = bprintf("%fs", cluster->bb_lat);
86 bw = bprintf("%fBps", cluster->bb_bw);
87 ns3_add_cluster(cluster->id, bw, lat);
92 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
93 simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
94 simgrid::kernel::routing::NetPoint* gw_dst, std::vector<Link*>* link_list)
96 if (link_list->size() == 1) {
97 simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
99 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->cname(), dst->cname(), link->getName(),
100 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
101 char* link_bdw = bprintf("%fBps", link->bandwidth());
102 char* link_lat = bprintf("%fs", link->latency());
104 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
105 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
108 NetPointNs3* host_src = src->extension<NetPointNs3>();
109 NetPointNs3* host_dst = dst->extension<NetPointNs3>();
111 xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->cname());
112 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->cname());
114 ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
116 ns3_add_link(host_dst->node_num, host_src->node_num, link_bdw, link_lat);
123 /* Create the ns3 topology based on routing strategy */
124 static void postparse_cb(void)
126 IPV4addr.shrink_to_fit();
128 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
129 ns3::GlobalRouteManager::InitializeRoutes();
135 void surf_network_model_init_NS3()
137 if (surf_network_model)
140 surf_network_model = new simgrid::surf::NetworkNS3Model();
141 all_existing_models->push_back(surf_network_model);
144 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
145 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
151 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
152 NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
154 ns3_initialize(ns3_tcp_model.get().c_str());
156 simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint pt) {
157 pt->extension_set<NetPointNs3>(new NetPointNs3());
160 simgrid::surf::on_cluster.connect(&clusterCreation_cb);
161 simgrid::surf::on_postparse.connect(&postparse_cb);
162 simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
164 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
165 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
168 NetworkNS3Model::~NetworkNS3Model() {
169 for (auto addr : IPV4addr)
172 xbt_dict_free(&flowFromSock);
175 Link* NetworkNS3Model::createLink(const char* name, double bandwidth, double latency,
176 e_surf_link_sharing_policy_t policy)
178 return new LinkNS3(this, name, bandwidth, latency);
181 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
183 return new NetworkNS3Action(this, size, src, dst);
186 double NetworkNS3Model::nextOccuringEvent(double now)
188 double time_to_next_flow_completion;
189 XBT_DEBUG("ns3_next_occuring_event");
191 //get the first relevant value from the running_actions list
192 if (!getRunningActionSet()->size() || now == 0.0)
197 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
198 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
200 XBT_DEBUG("min : %f", now);
201 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
202 XBT_DEBUG("surf time : %f", surf_get_clock());
203 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
205 return time_to_next_flow_completion;
208 void NetworkNS3Model::updateActionsState(double now, double delta)
210 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
212 /* If there are no running flows, advance the NS3 simulator and return */
213 if (getRunningActionSet()->empty()) {
215 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
216 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
221 xbt_dict_cursor_t cursor = nullptr;
224 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
225 NetworkNS3Action * action = sgFlow->action_;
226 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
227 action->setRemains(action->getCost() - sgFlow->sentBytes_);
229 if (TRACE_is_enabled() &&
230 action->getState() == Action::State::running){
231 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
233 std::vector<Link*> route = std::vector<Link*>();
235 action->src_->routeTo(action->dst_, &route, nullptr);
236 for (auto link : route)
237 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
239 action->lastSent_ = sgFlow->sentBytes_;
242 if(sgFlow->finished_){
243 xbt_dynar_push(socket_to_destroy,&ns3Socket);
244 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
246 action->setState(Action::State::done);
250 while (!xbt_dynar_is_empty(socket_to_destroy)){
251 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
253 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
254 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
255 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
257 xbt_dict_remove(flowFromSock, ns3Socket);
265 LinkNS3::LinkNS3(NetworkNS3Model* model, const char* name, double bandwidth, double latency)
266 : Link(model, name, nullptr)
268 bandwidth_.peak = bandwidth;
269 latency_.peak = latency;
271 Link::onCreation(this);
274 LinkNS3::~LinkNS3() = default;
276 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
280 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
281 xbt_die("The NS3 network model doesn't support bandwidth traces");
283 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
284 xbt_die("The NS3 network model doesn't support latency traces");
291 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
292 : NetworkAction(model, size, false)
294 XBT_DEBUG("Communicate from %s to %s", src->cname(), dst->cname());
298 ns3_create_flow(src, dst, surf_get_clock(), size, this);
300 Link::onCommunicate(this, src, dst);
303 void NetworkNS3Action::suspend() {
307 void NetworkNS3Action::resume() {
311 /* Test whether a flow is suspended */
312 bool NetworkNS3Action::isSuspended()
317 int NetworkNS3Action::unref()
321 if (action_hook.is_linked())
322 stateSet_->erase(stateSet_->iterator_to(*this));
323 XBT_DEBUG ("Removing action %p", this);
333 void ns3_simulator(double maxSeconds)
335 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
336 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
337 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
338 ns3::Simulator::Run ();
341 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double startTime, u_int32_t TotalBytes,
342 simgrid::surf::NetworkNS3Action* action)
344 int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
345 int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
347 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
348 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
350 char* addr = IPV4addr.at(node2);
352 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
353 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
354 sink.Install (dst_node);
356 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket (src_node, ns3::TcpSocketFactory::GetTypeId());
358 xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr);
360 sock->Bind(ns3::InetSocketAddress(port_number));
361 XBT_DEBUG("Create flow starting to %fs + %fs = %fs",
362 startTime-ns3::Simulator::Now().GetSeconds(), ns3::Simulator::Now().GetSeconds(), startTime);
364 ns3::Simulator::Schedule (ns3::Seconds(startTime-ns3::Simulator::Now().GetSeconds()),
365 &StartFlow, sock, addr, port_number);
368 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
371 // initialize the NS3 interface and environment
372 void ns3_initialize(const char* TcpProtocol){
378 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
379 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
381 if (!strcmp(TcpProtocol,"default"))
384 if (!strcmp(TcpProtocol,"Reno")) {
385 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
386 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
389 if (!strcmp(TcpProtocol,"NewReno")) {
390 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
391 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
394 if(!strcmp(TcpProtocol,"Tahoe")){
395 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
396 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
400 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
403 void ns3_add_cluster(const char* id, char* bw, char* lat)
405 ns3::NodeContainer Nodes;
407 for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
408 Nodes.Add(Cluster_nodes.Get(i));
409 XBT_DEBUG("Add node %d to cluster",i);
411 number_of_clusters_nodes = Cluster_nodes.GetN();
413 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
414 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
416 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
417 ns3::CsmaHelper csma;
418 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
419 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
420 ns3::NetDeviceContainer devices = csma.Install (Nodes);
421 XBT_DEBUG("Create CSMA");
423 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
424 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
425 ns3::Ipv4AddressHelper ipv4;
426 ipv4.SetBase (adr, "255.255.0.0");
428 interfaces.Add(ipv4.Assign (devices));
430 if(number_of_links == 255){
431 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
433 number_of_networks++;
437 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
440 static char* transformIpv4Address (ns3::Ipv4Address from){
441 std::stringstream sstream;
443 std::string s = sstream.str();
444 return bprintf("%s",s.c_str());
447 void ns3_add_link(int src, int dst, char *bw, char *lat)
449 ns3::PointToPointHelper pointToPoint;
451 ns3::NetDeviceContainer netA;
452 ns3::Ipv4AddressHelper address;
454 ns3::Ptr<ns3::Node> a = nodes.Get(src);
455 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
457 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
458 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
459 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
461 netA.Add(pointToPoint.Install (a, b));
463 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
464 address.SetBase (adr, "255.255.0.0");
465 XBT_DEBUG("\tInterface stack '%s'",adr);
467 interfaces.Add(address.Assign (netA));
469 if (IPV4addr.size() <= (unsigned)src)
470 IPV4addr.resize(src + 1, nullptr);
471 IPV4addr.at(src) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
473 if (IPV4addr.size() <= (unsigned)dst)
474 IPV4addr.resize(dst + 1, nullptr);
475 IPV4addr.at(dst) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
477 if (number_of_links == 255){
478 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
480 number_of_networks++;