1 /* Copyright (c) 2007-2017. 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. */
7 #include <unordered_set>
9 #include "xbt/config.hpp"
10 #include "xbt/string.hpp"
12 #include "ns3/core-module.h"
15 #include "network_ns3.hpp"
16 #include "ns3/ns3_simulator.hpp"
18 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
19 #include "src/kernel/routing/NetPoint.hpp"
21 #include "simgrid/s4u/Engine.hpp"
22 #include "simgrid/s4u/NetZone.hpp"
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
26 std::vector<std::string> IPV4addr;
32 extern std::map<std::string, SgFlow*> flowFromSock;
34 static ns3::InternetStackHelper stack;
35 static ns3::NodeContainer nodes;
36 static ns3::NodeContainer Cluster_nodes;
37 static ns3::Ipv4InterfaceContainer interfaces;
39 static int number_of_nodes = 0;
40 static int number_of_clusters_nodes = 0;
41 static int number_of_links = 1;
42 static int number_of_networks = 1;
43 static int port_number = 1025; //Port number is limited from 1025 to 65 000
45 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
47 NetPointNs3::NetPointNs3()
49 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
52 node_num = number_of_nodes++;
59 static void clusterCreation_cb(ClusterCreationArgs* cluster)
61 for (int const& i : *cluster->radicals) {
62 // Routers don't create a router on the other end of the private link by themselves.
63 // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
64 NetPointNs3* host_dst = new NetPointNs3();
66 // Create private link
67 std::string host_id = cluster->prefix + std::to_string(i) + cluster->suffix;
68 NetPointNs3* host_src = sg_host_by_name(host_id.c_str())->pimpl_netpoint->extension<NetPointNs3>();
69 xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id.c_str());
71 // Any NS3 route is symmetrical
72 ns3_add_link(host_src, host_dst, cluster->bw, cluster->lat);
77 //Create link backbone
78 ns3_add_cluster(cluster->id.c_str(), cluster->bb_bw, cluster->bb_lat);
81 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
82 simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
83 simgrid::kernel::routing::NetPoint* gw_dst,
84 std::vector<simgrid::surf::LinkImpl*>* link_list)
86 if (link_list->size() == 1) {
87 simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
89 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->getCname(), dst->getCname(), link->getCname(),
90 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
92 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
93 XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->getCname(), link->bandwidth(), link->latency());
96 NetPointNs3* host_src = src->extension<NetPointNs3>();
97 NetPointNs3* host_dst = dst->extension<NetPointNs3>();
99 xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->getCname());
100 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->getCname());
102 ns3_add_link(host_src, host_dst, link->bandwidth(), link->latency());
104 static bool warned_about_long_routes = false;
106 if (not warned_about_long_routes)
107 XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with NS3.\n"
108 "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
110 "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
112 src->getCname(), dst->getCname(), link_list->size());
113 warned_about_long_routes = true;
117 /* Create the ns3 topology based on routing strategy */
118 static void postparse_cb()
120 IPV4addr.shrink_to_fit();
122 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
123 ns3::GlobalRouteManager::InitializeRoutes();
129 void surf_network_model_init_NS3()
131 if (surf_network_model)
134 surf_network_model = new simgrid::surf::NetworkNS3Model();
135 all_existing_models->push_back(surf_network_model);
138 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
139 "The ns3 tcp model can be : NewReno or Reno or Tahoe", "NewReno");
144 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
145 NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
147 ns3_initialize(ns3_tcp_model.get().c_str());
149 simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint* pt) {
150 pt->extension_set<NetPointNs3>(new NetPointNs3());
151 XBT_VERB("SimGrid's %s is known as node %d within NS3", pt->getCname(), pt->extension<NetPointNs3>()->node_num);
153 simgrid::surf::on_cluster.connect(&clusterCreation_cb);
154 simgrid::s4u::onPlatformCreated.connect(&postparse_cb);
155 simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
157 LogComponentEnable("PacketSink", ns3::LOG_LEVEL_INFO);
158 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
159 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
162 NetworkNS3Model::~NetworkNS3Model() {
166 LinkImpl* NetworkNS3Model::createLink(const std::string& name, double bandwidth, double latency,
167 e_surf_link_sharing_policy_t policy)
169 return new LinkNS3(this, name, bandwidth, latency);
172 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
174 return new NetworkNS3Action(this, size, src, dst);
177 double NetworkNS3Model::nextOccuringEvent(double now)
179 double time_to_next_flow_completion;
180 XBT_DEBUG("ns3_next_occuring_event");
182 //get the first relevant value from the running_actions list
183 if (not getRunningActionSet()->size() || now == 0.0)
188 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
189 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
191 XBT_DEBUG("min : %f", now);
192 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
193 XBT_DEBUG("surf time : %f", surf_get_clock());
194 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
196 return time_to_next_flow_completion;
199 void NetworkNS3Model::updateActionsState(double now, double delta)
201 static std::vector<std::string> socket_to_destroy;
203 /* If there are no running flows, advance the NS3 simulator and return */
204 if (getRunningActionSet()->empty()) {
206 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
207 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
212 std::string ns3Socket;
213 for (auto elm : flowFromSock) {
214 ns3Socket = elm.first;
215 SgFlow* sgFlow = elm.second;
216 NetworkNS3Action * action = sgFlow->action_;
217 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
218 action->setRemains(action->getCost() - sgFlow->sentBytes_);
220 if (TRACE_is_enabled() &&
221 action->getState() == Action::State::running){
222 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
224 std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
226 action->src_->routeTo(action->dst_, &route, nullptr);
227 for (auto const& link : route)
228 TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
231 action->lastSent_ = sgFlow->sentBytes_;
234 if(sgFlow->finished_){
235 socket_to_destroy.push_back(ns3Socket);
236 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
237 action->finish(Action::State::done);
241 while (not socket_to_destroy.empty()) {
242 ns3Socket = socket_to_destroy.back();
243 socket_to_destroy.pop_back();
244 SgFlow* flow = flowFromSock.at(ns3Socket);
245 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
246 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
249 flowFromSock.erase(ns3Socket);
257 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency)
258 : LinkImpl(model, name, nullptr)
260 bandwidth_.peak = bandwidth;
261 latency_.peak = latency;
263 s4u::Link::onCreation(this->piface_);
266 LinkNS3::~LinkNS3() = default;
268 void LinkNS3::apply_event(tmgr_trace_event_t event, double value)
272 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
273 xbt_die("The NS3 network model doesn't support bandwidth traces");
275 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
276 xbt_die("The NS3 network model doesn't support latency traces");
283 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
284 : NetworkAction(model, size, false)
286 XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname());
290 ns3_create_flow(src, dst, size, this);
292 s4u::Link::onCommunicate(this, src, dst);
295 void NetworkNS3Action::suspend() {
299 void NetworkNS3Action::resume() {
303 std::list<LinkImpl*> NetworkNS3Action::links()
308 /* Test whether a flow is suspended */
309 bool NetworkNS3Action::isSuspended()
314 int NetworkNS3Action::unref()
318 if (action_hook.is_linked())
319 stateSet_->erase(stateSet_->iterator_to(*this));
320 XBT_DEBUG ("Removing action %p", this);
330 void ns3_simulator(double maxSeconds)
332 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
333 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
334 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
335 ns3::Simulator::Run ();
338 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst,
339 u_int32_t TotalBytes,
340 simgrid::surf::NetworkNS3Action* action) {
341 unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
342 unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
344 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
345 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
347 xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
348 dst->pimpl_netpoint->getCname());
349 std::string& addr = IPV4addr[node2];
350 xbt_assert(not addr.empty(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
351 dst->pimpl_netpoint->getCname());
353 XBT_DEBUG("ns3_create_flow %u Bytes from %u to %u with Interface %s", TotalBytes, node1, node2, addr.c_str());
354 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
355 sink.Install (dst_node);
357 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
359 flowFromSock.insert({transformSocketPtr(sock), new SgFlow(TotalBytes, action)});
361 sock->Bind(ns3::InetSocketAddress(port_number));
363 ns3::Simulator::ScheduleNow(&StartFlow, sock, addr.c_str(), port_number);
366 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
369 // initialize the NS3 interface and environment
370 void ns3_initialize(const char* TcpProtocol){
376 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
377 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
378 ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
380 if (not strcmp(TcpProtocol, "default"))
383 if (not strcmp(TcpProtocol, "Reno")) {
384 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
385 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
388 if (not strcmp(TcpProtocol, "NewReno")) {
389 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
390 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
393 if (not strcmp(TcpProtocol, "Tahoe")) {
394 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
395 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
399 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
402 void ns3_add_cluster(const char* id, double bw, double lat) {
403 ns3::NodeContainer Nodes;
405 for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
406 Nodes.Add(Cluster_nodes.Get(i));
407 XBT_DEBUG("Add node %u to cluster", i);
409 number_of_clusters_nodes = Cluster_nodes.GetN();
411 XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
412 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
414 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
415 ns3::CsmaHelper csma;
416 csma.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
417 csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
418 ns3::NetDeviceContainer devices = csma.Install(Nodes);
419 XBT_DEBUG("Create CSMA");
421 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
422 XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
423 ns3::Ipv4AddressHelper ipv4;
424 ipv4.SetBase(addr.c_str(), "255.255.0.0");
425 interfaces.Add(ipv4.Assign (devices));
427 if(number_of_links == 255){
428 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
430 number_of_networks++;
434 XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
437 static std::string transformIpv4Address(ns3::Ipv4Address from)
439 std::stringstream sstream;
441 return sstream.str();
444 void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
445 ns3::PointToPointHelper pointToPoint;
447 ns3::Ipv4AddressHelper address;
449 int srcNum = src->node_num;
450 int dstNum = dst->node_num;
452 ns3::Ptr<ns3::Node> a = nodes.Get(srcNum);
453 ns3::Ptr<ns3::Node> b = nodes.Get(dstNum);
455 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
456 pointToPoint.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
457 pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
459 std::string filename = simgrid::xbt::string_printf("link-%d-%d.tr", srcNum, dstNum);
460 ns3::AsciiTraceHelper ascii;
461 pointToPoint.EnableAsciiAll(ascii.CreateFileStream(filename));
462 pointToPoint.EnablePcapAll ("tcp-bulk-send", false);
464 ns3::NetDeviceContainer netA;
465 netA.Add(pointToPoint.Install (a, b));
467 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
468 address.SetBase(addr.c_str(), "255.255.0.0");
469 XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
470 interfaces.Add(address.Assign (netA));
472 if (IPV4addr.size() <= (unsigned)srcNum)
473 IPV4addr.resize(srcNum + 1);
474 IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
476 if (IPV4addr.size() <= (unsigned)dstNum)
477 IPV4addr.resize(dstNum + 1);
478 IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
480 if (number_of_links == 255){
481 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
483 number_of_networks++;