1 /* Copyright (c) 2007-2018. 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"
11 #include "xbt/utility.hpp"
13 #include <ns3/core-module.h>
14 #include <ns3/csma-helper.h>
15 #include <ns3/global-route-manager.h>
16 #include <ns3/internet-stack-helper.h>
17 #include <ns3/ipv4-address-helper.h>
18 #include <ns3/packet-sink-helper.h>
19 #include <ns3/point-to-point-helper.h>
21 #include "network_ns3.hpp"
22 #include "ns3/ns3_simulator.hpp"
24 #include "simgrid/kernel/routing/NetPoint.hpp"
25 #include "simgrid/plugins/energy.h"
26 #include "simgrid/s4u/Engine.hpp"
27 #include "simgrid/s4u/NetZone.hpp"
28 #include "src/surf/xml/platf_private.hpp"
29 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
33 std::vector<std::string> IPV4addr;
39 extern std::map<std::string, SgFlow*> flowFromSock;
41 static ns3::InternetStackHelper stack;
42 static ns3::NodeContainer nodes;
43 static ns3::NodeContainer Cluster_nodes;
44 static ns3::Ipv4InterfaceContainer interfaces;
46 static int number_of_nodes = 0;
47 static int number_of_clusters_nodes = 0;
48 static int number_of_links = 1;
49 static int number_of_networks = 1;
51 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
53 NetPointNs3::NetPointNs3()
55 ns3Node_ = ns3::CreateObject<ns3::Node>(0);
56 stack.Install(ns3Node_);
58 node_num = number_of_nodes++;
65 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs* cluster)
67 for (int const& i : *cluster->radicals) {
68 // Routers don't create a router on the other end of the private link by themselves.
69 // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
70 NetPointNs3* host_dst = new NetPointNs3();
72 // Create private link
73 std::string host_id = cluster->prefix + std::to_string(i) + cluster->suffix;
74 NetPointNs3* host_src = sg_host_by_name(host_id.c_str())->pimpl_netpoint->extension<NetPointNs3>();
75 xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id.c_str());
77 // Any NS3 route is symmetrical
78 ns3_add_link(host_src, host_dst, cluster->bw, cluster->lat);
83 //Create link backbone
84 ns3_add_cluster(cluster->id.c_str(), cluster->bb_bw, cluster->bb_lat);
87 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
88 simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
89 simgrid::kernel::routing::NetPoint* gw_dst,
90 std::vector<simgrid::surf::LinkImpl*>& link_list)
92 if (link_list.size() == 1) {
93 simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list[0]);
95 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->getCname(), dst->getCname(), link->getCname(),
96 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
98 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
99 XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->getCname(), link->bandwidth(), link->latency());
102 NetPointNs3* host_src = src->extension<NetPointNs3>();
103 NetPointNs3* host_dst = dst->extension<NetPointNs3>();
105 xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->getCname());
106 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->getCname());
108 ns3_add_link(host_src, host_dst, link->bandwidth(), link->latency());
110 static bool warned_about_long_routes = false;
112 if (not warned_about_long_routes)
113 XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with NS3.\n"
114 "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
116 "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
118 src->getCname(), dst->getCname(), link_list.size());
119 warned_about_long_routes = true;
123 /* Create the ns3 topology based on routing strategy */
124 static void postparse_cb()
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>
145 ns3_tcp_model("ns3/TcpModel", "The ns3 tcp model can be : NewReno or Reno or Tahoe", "default");
150 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
151 xbt_assert(not sg_link_energy_is_inited(),
152 "LinkEnergy plugin and NS3 network models are not compatible. Are you looking for Ecofen, maybe?");
154 NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
156 ns3_initialize(ns3_tcp_model.get().c_str());
158 simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint* pt) {
159 pt->extension_set<NetPointNs3>(new NetPointNs3());
160 XBT_VERB("SimGrid's %s is known as node %d within NS3", pt->getCname(), pt->extension<NetPointNs3>()->node_num);
162 simgrid::surf::on_cluster.connect(&clusterCreation_cb);
164 simgrid::s4u::onPlatformCreated.connect(&postparse_cb);
165 simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
168 NetworkNS3Model::~NetworkNS3Model() {
172 LinkImpl* NetworkNS3Model::createLink(const std::string& name, double bandwidth, double latency,
173 e_surf_link_sharing_policy_t policy)
175 return new LinkNS3(this, name, bandwidth, latency);
178 kernel::resource::Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
180 return new NetworkNS3Action(this, size, src, dst);
183 double NetworkNS3Model::nextOccuringEvent(double now)
185 double time_to_next_flow_completion;
186 XBT_DEBUG("ns3_next_occuring_event");
188 //get the first relevant value from the running_actions list
189 if (not getRunningActionSet()->size() || now == 0.0)
194 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
195 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
197 XBT_DEBUG("min : %f", now);
198 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
199 XBT_DEBUG("surf time : %f", surf_get_clock());
200 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
202 return time_to_next_flow_completion;
205 void NetworkNS3Model::updateActionsState(double now, double delta)
207 static std::vector<std::string> socket_to_destroy;
209 /* If there are no running flows, advance the NS3 simulator and return */
210 if (getRunningActionSet()->empty()) {
212 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
213 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
218 std::string ns3Socket;
219 for (auto elm : flowFromSock) {
220 ns3Socket = elm.first;
221 SgFlow* sgFlow = elm.second;
222 NetworkNS3Action * action = sgFlow->action_;
223 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
224 action->setRemains(action->getCost() - sgFlow->sentBytes_);
226 if (TRACE_is_enabled() && action->getState() == kernel::resource::Action::State::running) {
227 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
229 std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
231 action->src_->routeTo(action->dst_, route, nullptr);
232 for (auto const& link : route)
233 TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
236 action->lastSent_ = sgFlow->sentBytes_;
239 if(sgFlow->finished_){
240 socket_to_destroy.push_back(ns3Socket);
241 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket.c_str(), action);
242 action->finish(kernel::resource::Action::State::done);
244 XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3Socket.c_str(), sgFlow->sentBytes_,
245 sgFlow->totalBytes_, sgFlow->remaining_);
249 while (not socket_to_destroy.empty()) {
250 ns3Socket = socket_to_destroy.back();
251 socket_to_destroy.pop_back();
252 SgFlow* flow = flowFromSock.at(ns3Socket);
253 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
254 XBT_DEBUG("Removing socket %p of action %p", ns3Socket.c_str(), flow->action_);
257 flowFromSock.erase(ns3Socket);
265 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency)
266 : LinkImpl(model, name, nullptr)
268 bandwidth_.peak = bandwidth;
269 latency_.peak = latency;
271 s4u::Link::onCreation(this->piface_);
274 LinkNS3::~LinkNS3() = default;
276 void LinkNS3::apply_event(tmgr_trace_event_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(kernel::resource::Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
292 : NetworkAction(model, totalBytes, false)
294 XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname());
298 static int port_number = 1025; // Port number is limited from 1025 to 65 000
300 unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
301 unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
303 ns3::Ptr<ns3::Node> src_node = src->pimpl_netpoint->extension<NetPointNs3>()->ns3Node_;
304 ns3::Ptr<ns3::Node> dst_node = dst->pimpl_netpoint->extension<NetPointNs3>()->ns3Node_;
306 xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
307 dst->pimpl_netpoint->getCname());
308 std::string& addr = IPV4addr[node2];
309 xbt_assert(not addr.empty(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
310 dst->pimpl_netpoint->getCname());
312 XBT_DEBUG("ns3: Create flow of %.0f Bytes from %u to %u with Interface %s", totalBytes, node1, node2, addr.c_str());
313 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
314 sink.Install(dst_node);
316 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
318 flowFromSock.insert({transformSocketPtr(sock), new SgFlow(totalBytes, this)});
320 sock->Bind(ns3::InetSocketAddress(port_number));
322 ns3::Simulator::ScheduleNow(&StartFlow, sock, addr.c_str(), port_number);
325 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
327 s4u::Link::onCommunicate(this, src, dst);
330 void NetworkNS3Action::suspend() {
334 void NetworkNS3Action::resume() {
338 std::list<LinkImpl*> NetworkNS3Action::links()
343 /* Test whether a flow is suspended */
344 bool NetworkNS3Action::isSuspended()
349 int NetworkNS3Action::unref()
353 if (stateSetHook_.is_linked())
354 simgrid::xbt::intrusive_erase(*stateSet_, *this);
355 XBT_DEBUG ("Removing action %p", this);
365 void ns3_simulator(double maxSeconds)
367 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
368 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
369 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
370 ns3::Simulator::Run ();
374 // initialize the NS3 interface and environment
375 void ns3_initialize(std::string TcpProtocol)
382 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
383 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
384 ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
386 if (TcpProtocol == "default") {
389 } else if (TcpProtocol == "Reno") {
390 XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
391 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
393 } else if (TcpProtocol == "NewReno") {
394 XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
395 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
397 } else if (TcpProtocol == "Tahoe") {
398 XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
399 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
402 xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
406 void ns3_add_cluster(const char* id, double bw, double lat) {
407 ns3::NodeContainer Nodes;
409 for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
410 Nodes.Add(Cluster_nodes.Get(i));
411 XBT_DEBUG("Add node %u to cluster", i);
413 number_of_clusters_nodes = Cluster_nodes.GetN();
415 XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
416 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
418 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
419 ns3::CsmaHelper csma;
420 csma.SetChannelAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw * 8))); // NS3 takes bps, but we provide Bps
421 csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
422 ns3::NetDeviceContainer devices = csma.Install(Nodes);
423 XBT_DEBUG("Create CSMA");
425 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
426 XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
427 ns3::Ipv4AddressHelper ipv4;
428 ipv4.SetBase(addr.c_str(), "255.255.0.0");
429 interfaces.Add(ipv4.Assign (devices));
431 if(number_of_links == 255){
432 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
434 number_of_networks++;
438 XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
441 static std::string transformIpv4Address(ns3::Ipv4Address from)
443 std::stringstream sstream;
445 return sstream.str();
448 void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
449 ns3::PointToPointHelper pointToPoint;
451 ns3::Ipv4AddressHelper address;
453 int srcNum = src->node_num;
454 int dstNum = dst->node_num;
456 ns3::Ptr<ns3::Node> a = src->ns3Node_;
457 ns3::Ptr<ns3::Node> b = dst->ns3Node_;
459 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
460 pointToPoint.SetDeviceAttribute("DataRate",
461 ns3::DataRateValue(ns3::DataRate(bw * 8))); // NS3 takes bps, but we provide Bps
462 pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
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++;