1 /* Copyright (c) 2007-2020. 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>
20 #include <ns3/application-container.h>
21 #include <ns3/event-id.h>
23 #include "network_ns3.hpp"
24 #include "ns3/ns3_simulator.hpp"
26 #include "simgrid/kernel/routing/NetPoint.hpp"
27 #include "simgrid/plugins/energy.h"
28 #include "simgrid/s4u/Engine.hpp"
29 #include "simgrid/s4u/NetZone.hpp"
30 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
31 #include "src/surf/surf_interface.hpp"
32 #include "src/surf/xml/platf_private.hpp"
33 #include "surf/surf.hpp"
35 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network ns-3 module");
37 std::vector<std::string> IPV4addr;
43 extern std::map<std::string, SgFlow*> flow_from_sock;
44 extern std::map<std::string, ns3::ApplicationContainer> sink_from_sock;
46 static ns3::InternetStackHelper stack;
47 static ns3::NodeContainer nodes;
48 static ns3::NodeContainer Cluster_nodes;
49 static ns3::Ipv4InterfaceContainer interfaces;
51 static int number_of_nodes = 0;
52 static int number_of_clusters_nodes = 0;
53 static int number_of_links = 1;
54 static int number_of_networks = 1;
56 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
58 NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject<ns3::Node>(0))
60 stack.Install(ns3_node_);
62 node_num = number_of_nodes++;
69 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
71 for (int const& i : *cluster.radicals) {
72 // Routers don't create a router on the other end of the private link by themselves.
73 // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
74 auto* host_dst = new NetPointNs3();
76 // Create private link
77 std::string host_id = cluster.prefix + std::to_string(i) + cluster.suffix;
78 auto* host_src = simgrid::s4u::Host::by_name(host_id)->get_netpoint()->extension<NetPointNs3>();
79 xbt_assert(host_src, "Cannot find a ns-3 host of name %s", host_id.c_str());
81 // Any ns-3 route is symmetrical
82 ns3_add_direct_route(host_src, host_dst, cluster.bw, cluster.lat, cluster.sharing_policy);
87 //Create link backbone
88 ns3_add_cluster(cluster.id.c_str(), cluster.bb_bw, cluster.bb_lat);
91 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
92 simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* /*gw_src*/,
93 simgrid::kernel::routing::NetPoint* /*gw_dst*/,
94 std::vector<simgrid::kernel::resource::LinkImpl*> const& link_list)
96 if (link_list.size() == 1) {
97 auto* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
99 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s %s", src->get_cname(), dst->get_cname(), link->get_cname(),
100 (link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI ? "(wifi)" : "(wired)"),
101 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
103 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
104 XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->get_cname(), link->get_bandwidth(), link->get_latency());
107 auto* host_src = src->extension<NetPointNs3>();
108 auto* host_dst = dst->extension<NetPointNs3>();
110 xbt_assert(host_src != nullptr, "Network element %s does not seem to be ns-3-ready", src->get_cname());
111 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be ns-3-ready", dst->get_cname());
113 ns3_add_direct_route(host_src, host_dst, link->get_bandwidth(), link->get_latency(), link->get_sharing_policy());
115 static bool warned_about_long_routes = false;
117 if (not warned_about_long_routes)
118 XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with ns-3.\n"
119 "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
121 "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
123 src->get_cname(), dst->get_cname(), link_list.size());
124 warned_about_long_routes = true;
128 /* Create the ns3 topology based on routing strategy */
129 static void postparse_cb()
131 IPV4addr.shrink_to_fit();
133 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
134 ns3::GlobalRouteManager::InitializeRoutes();
140 void surf_network_model_init_NS3()
142 xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
144 surf_network_model = new simgrid::kernel::resource::NetworkNS3Model();
147 static simgrid::config::Flag<std::string>
148 ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be : NewReno or Reno or Tahoe", "default");
154 NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
156 xbt_assert(not sg_link_energy_is_inited(),
157 "LinkEnergy plugin and ns-3 network models are not compatible. Are you looking for Ecofen, maybe?");
159 all_existing_models.push_back(this);
161 NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create<NetPointNs3>();
163 ns3_initialize(ns3_tcp_model.get());
165 routing::NetPoint::on_creation.connect([](routing::NetPoint& pt) {
166 pt.extension_set<NetPointNs3>(new NetPointNs3());
167 XBT_VERB("SimGrid's %s is known as node %d within ns-3", pt.get_cname(), pt.extension<NetPointNs3>()->node_num);
169 routing::on_cluster_creation.connect(&clusterCreation_cb);
171 s4u::Engine::on_platform_created.connect(&postparse_cb);
172 s4u::NetZone::on_route_creation.connect(&routeCreation_cb);
175 NetworkNS3Model::~NetworkNS3Model() {
179 LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
180 s4u::Link::SharingPolicy policy)
182 xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
183 return new LinkNS3(this, name, bandwidths[0], latency, policy);
186 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
188 xbt_assert(rate == -1,
189 "Communication over ns-3 links cannot specify a specific rate. Please use -1 as a value instead of %f.",
191 return new NetworkNS3Action(this, size, src, dst);
194 double NetworkNS3Model::next_occurring_event(double now)
196 double time_to_next_flow_completion = 0.0;
197 XBT_DEBUG("ns3_next_occurring_event");
199 //get the first relevant value from the running_actions list
201 // If there is no comms in NS-3, then we do not move it forward.
202 // We will synchronize NS-3 with SimGrid when starting a new communication.
203 // (see NetworkNS3Action::NetworkNS3Action() for more details on this point)
204 if (get_started_action_set()->empty() || now == 0.0)
207 XBT_DEBUG("doing a ns3 simulation for a duration of %f", now);
209 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
210 // NS-3 stops as soon as a flow ends,
211 // but it does not process the other flows that may finish at the same (simulated) time.
212 // If another flow ends at the same time, time_to_next_flow_completion = 0
213 if(double_equals(time_to_next_flow_completion, 0, sg_surf_precision))
214 time_to_next_flow_completion = 0.0;
216 XBT_DEBUG("min : %f", now);
217 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
218 XBT_DEBUG("surf time : %f", surf_get_clock());
219 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
221 return time_to_next_flow_completion;
224 void NetworkNS3Model::update_actions_state(double now, double delta)
226 static std::vector<std::string> socket_to_destroy;
228 std::string ns3_socket;
229 for (const auto& elm : flow_from_sock) {
230 ns3_socket = elm.first;
231 SgFlow* sgFlow = elm.second;
232 NetworkNS3Action * action = sgFlow->action_;
233 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
234 // Because NS3 stops as soon as a flow is finished, the other flows that ends at the same time may remains in an
235 // inconsistent state (i.e. remains_ == 0 but finished_ == false).
236 // However, SimGrid considers sometimes that an action with remains_ == 0 is finished.
237 // Thus, to avoid inconsistencies between SimGrid and NS3, set remains to 0 only when the flow is finished in NS3
238 int remains = action->get_cost() - sgFlow->sent_bytes_;
240 action->set_remains(remains);
242 if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) {
243 double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_;
245 std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
247 action->get_src().route_to(&action->get_dst(), route, nullptr);
248 for (auto const& link : route)
249 instr::resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(),
250 (data_delta_sent) / delta, now - delta, delta);
252 action->last_sent_ = sgFlow->sent_bytes_;
255 if(sgFlow->finished_){
256 socket_to_destroy.push_back(ns3_socket);
257 XBT_DEBUG("Destroy socket %p of action %p", ns3_socket.c_str(), action);
258 action->set_remains(0);
259 action->finish(Action::State::FINISHED);
261 XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
262 sgFlow->total_bytes_, sgFlow->remaining_);
266 while (not socket_to_destroy.empty()) {
267 ns3_socket = socket_to_destroy.back();
268 socket_to_destroy.pop_back();
269 SgFlow* flow = flow_from_sock.at(ns3_socket);
270 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
271 XBT_DEBUG("Removing socket %p of action %p", ns3_socket.c_str(), flow->action_);
274 flow_from_sock.erase(ns3_socket);
275 sink_from_sock.erase(ns3_socket);
283 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency,
284 s4u::Link::SharingPolicy policy)
285 : LinkImpl(model, name, nullptr)
287 bandwidth_.peak = bandwidth;
288 latency_.peak = latency;
289 sharing_policy_ = policy;
290 /* If wifi, create the wifizone now. If not, don't do anything: the links will be created in routeCreate_cb */
292 s4u::Link::on_creation(*this->get_iface());
295 LinkNS3::~LinkNS3() = default;
297 void LinkNS3::apply_event(profile::Event*, double)
301 void LinkNS3::set_bandwidth_profile(profile::Profile*)
303 xbt_die("The ns-3 network model doesn't support bandwidth profiles");
305 void LinkNS3::set_latency_profile(profile::Profile*)
307 xbt_die("The ns-3 network model doesn't support latency profiles");
314 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
315 : NetworkAction(model, *src, *dst, totalBytes, false)
317 // If there is no other started actions, we need to move NS-3 forward to be sync with SimGrid
318 if (model->get_started_action_set()->size()==1){
319 while(double_positive(surf_get_clock() - ns3::Simulator::Now().GetSeconds(), sg_surf_precision)){
320 XBT_DEBUG("Synchronizing NS-3 (time %f) with SimGrid (time %f)", ns3::Simulator::Now().GetSeconds(), surf_get_clock());
321 ns3_simulator(surf_get_clock() - ns3::Simulator::Now().GetSeconds());
325 XBT_DEBUG("Communicate from %s to %s", src->get_cname(), dst->get_cname());
327 static int port_number = 1025; // Port number is limited from 1025 to 65 000
329 unsigned int node1 = src->get_netpoint()->extension<NetPointNs3>()->node_num;
330 unsigned int node2 = dst->get_netpoint()->extension<NetPointNs3>()->node_num;
332 ns3::Ptr<ns3::Node> src_node = src->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
333 ns3::Ptr<ns3::Node> dst_node = dst->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
335 xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
336 dst->get_netpoint()->get_cname());
337 std::string& addr = IPV4addr[node2];
338 xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
339 dst->get_netpoint()->get_cname());
341 XBT_DEBUG("ns3: Create flow of %.0f Bytes from %u to %u with Interface %s", totalBytes, node1, node2, addr.c_str());
342 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
343 ns3::ApplicationContainer apps = sink.Install(dst_node);
345 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
347 flow_from_sock.insert({transform_socket_ptr(sock), new SgFlow(totalBytes, this)});
348 sink_from_sock.insert({transform_socket_ptr(sock), apps});
350 sock->Bind(ns3::InetSocketAddress(port_number));
352 ns3::Simulator::ScheduleNow(&start_flow, sock, addr.c_str(), port_number);
355 if(port_number > 65000){
357 XBT_WARN("Too many connections! Port number is saturated. Trying to use the oldest ports.");
359 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
361 s4u::Link::on_communicate(*this);
364 void NetworkNS3Action::suspend() {
368 void NetworkNS3Action::resume() {
372 std::list<LinkImpl*> NetworkNS3Action::get_links() const
376 void NetworkNS3Action::update_remains_lazy(double /*now*/)
381 } // namespace resource
382 } // namespace kernel
383 } // namespace simgrid
385 void ns3_simulator(double maxSeconds)
388 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
389 id = ns3::Simulator::Schedule(ns3::Seconds(maxSeconds), &ns3::Simulator::Stop);
391 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
392 ns3::Simulator::Run ();
393 XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds());
399 // initialize the ns-3 interface and environment
400 void ns3_initialize(std::string TcpProtocol)
407 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
408 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
409 ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
411 if (TcpProtocol == "default") {
414 } else if (TcpProtocol == "Reno") {
415 XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
416 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
418 } else if (TcpProtocol == "NewReno") {
419 XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
420 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
422 } else if (TcpProtocol == "Tahoe") {
423 XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
424 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
427 xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
431 void ns3_add_cluster(const char* /*id*/, double bw, double lat)
433 ns3::NodeContainer Nodes;
435 for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
436 Nodes.Add(Cluster_nodes.Get(i));
437 XBT_DEBUG("Add node %u to cluster", i);
439 number_of_clusters_nodes = Cluster_nodes.GetN();
441 XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
442 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
444 xbt_assert(Nodes.GetN() <= 65000, "Cluster with ns-3 is limited to 65000 nodes");
445 ns3::CsmaHelper csma;
446 csma.SetChannelAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
447 csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
448 ns3::NetDeviceContainer devices = csma.Install(Nodes);
449 XBT_DEBUG("Create CSMA");
451 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
452 XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
453 ns3::Ipv4AddressHelper ipv4;
454 ipv4.SetBase(addr.c_str(), "255.255.0.0");
455 interfaces.Add(ipv4.Assign (devices));
457 if(number_of_links == 255){
458 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
460 number_of_networks++;
464 XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
467 static std::string transformIpv4Address(ns3::Ipv4Address from)
469 std::stringstream sstream;
471 return sstream.str();
474 void ns3_add_direct_route(NetPointNs3* src, NetPointNs3* dst, double bw, double lat,
475 simgrid::s4u::Link::SharingPolicy policy)
477 ns3::Ipv4AddressHelper address;
478 ns3::NetDeviceContainer netA;
480 int srcNum = src->node_num;
481 int dstNum = dst->node_num;
483 ns3::Ptr<ns3::Node> a = src->ns3_node_;
484 ns3::Ptr<ns3::Node> b = dst->ns3_node_;
486 if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
487 /* Install a ns3::WifiHelper */
489 ns3::PointToPointHelper pointToPoint;
491 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
492 pointToPoint.SetDeviceAttribute("DataRate",
493 ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
494 pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
496 netA.Add(pointToPoint.Install(a, b));
499 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
500 address.SetBase(addr.c_str(), "255.255.0.0");
501 XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
502 interfaces.Add(address.Assign (netA));
504 if (IPV4addr.size() <= (unsigned)srcNum)
505 IPV4addr.resize(srcNum + 1);
506 IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
508 if (IPV4addr.size() <= (unsigned)dstNum)
509 IPV4addr.resize(dstNum + 1);
510 IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
512 if (number_of_links == 255){
513 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
515 number_of_networks++;