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"
11 #include "xbt/utility.hpp"
13 #include "ns3/core-module.h"
16 #include "network_ns3.hpp"
17 #include "ns3/ns3_simulator.hpp"
19 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
20 #include "src/kernel/routing/NetPoint.hpp"
22 #include "simgrid/s4u/Engine.hpp"
23 #include "simgrid/s4u/NetZone.hpp"
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
27 std::vector<std::string> IPV4addr;
33 extern std::map<std::string, SgFlow*> flowFromSock;
35 static ns3::InternetStackHelper stack;
36 static ns3::NodeContainer nodes;
37 static ns3::NodeContainer Cluster_nodes;
38 static ns3::Ipv4InterfaceContainer interfaces;
40 static int number_of_nodes = 0;
41 static int number_of_clusters_nodes = 0;
42 static int number_of_links = 1;
43 static int number_of_networks = 1;
44 static int port_number = 1025; //Port number is limited from 1025 to 65 000
46 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
48 NetPointNs3::NetPointNs3()
50 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
53 node_num = number_of_nodes++;
60 static void clusterCreation_cb(ClusterCreationArgs* cluster)
62 for (int const& i : *cluster->radicals) {
63 // Routers don't create a router on the other end of the private link by themselves.
64 // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
65 NetPointNs3* host_dst = new NetPointNs3();
67 // Create private link
68 std::string host_id = cluster->prefix + std::to_string(i) + cluster->suffix;
69 NetPointNs3* host_src = sg_host_by_name(host_id.c_str())->pimpl_netpoint->extension<NetPointNs3>();
70 xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id.c_str());
72 // Any NS3 route is symmetrical
73 ns3_add_link(host_src, host_dst, cluster->bw, cluster->lat);
78 //Create link backbone
79 ns3_add_cluster(cluster->id.c_str(), cluster->bb_bw, cluster->bb_lat);
82 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
83 simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
84 simgrid::kernel::routing::NetPoint* gw_dst,
85 std::vector<simgrid::surf::LinkImpl*>& link_list)
87 if (link_list.size() == 1) {
88 simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list[0]);
90 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->getCname(), dst->getCname(), link->getCname(),
91 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
93 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
94 XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->getCname(), link->bandwidth(), link->latency());
97 NetPointNs3* host_src = src->extension<NetPointNs3>();
98 NetPointNs3* host_dst = dst->extension<NetPointNs3>();
100 xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->getCname());
101 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->getCname());
103 ns3_add_link(host_src, host_dst, link->bandwidth(), link->latency());
105 static bool warned_about_long_routes = false;
107 if (not warned_about_long_routes)
108 XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with NS3.\n"
109 "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
111 "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
113 src->getCname(), dst->getCname(), link_list.size());
114 warned_about_long_routes = true;
118 /* Create the ns3 topology based on routing strategy */
119 static void postparse_cb()
121 IPV4addr.shrink_to_fit();
123 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
124 ns3::GlobalRouteManager::InitializeRoutes();
130 void surf_network_model_init_NS3()
132 if (surf_network_model)
135 surf_network_model = new simgrid::surf::NetworkNS3Model();
136 all_existing_models->push_back(surf_network_model);
139 static simgrid::config::Flag<std::string>
140 ns3_tcp_model("ns3/TcpModel", "The ns3 tcp model can be : NewReno or Reno or Tahoe", "default");
145 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
146 NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
148 ns3_initialize(ns3_tcp_model.get().c_str());
150 simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint* pt) {
151 pt->extension_set<NetPointNs3>(new NetPointNs3());
152 XBT_VERB("SimGrid's %s is known as node %d within NS3", pt->getCname(), pt->extension<NetPointNs3>()->node_num);
154 simgrid::surf::on_cluster.connect(&clusterCreation_cb);
155 simgrid::s4u::onPlatformCreated.connect(&postparse_cb);
156 simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
159 NetworkNS3Model::~NetworkNS3Model() {
163 LinkImpl* NetworkNS3Model::createLink(const std::string& name, double bandwidth, double latency,
164 e_surf_link_sharing_policy_t policy)
166 return new LinkNS3(this, name, bandwidth, latency);
169 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
171 return new NetworkNS3Action(this, size, src, dst);
174 double NetworkNS3Model::nextOccuringEvent(double now)
176 double time_to_next_flow_completion;
177 XBT_DEBUG("ns3_next_occuring_event");
179 //get the first relevant value from the running_actions list
180 if (not getRunningActionSet()->size() || now == 0.0)
185 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
186 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
188 XBT_DEBUG("min : %f", now);
189 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
190 XBT_DEBUG("surf time : %f", surf_get_clock());
191 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
193 return time_to_next_flow_completion;
196 void NetworkNS3Model::updateActionsState(double now, double delta)
198 static std::vector<std::string> socket_to_destroy;
200 /* If there are no running flows, advance the NS3 simulator and return */
201 if (getRunningActionSet()->empty()) {
203 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
204 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
209 std::string ns3Socket;
210 for (auto elm : flowFromSock) {
211 ns3Socket = elm.first;
212 SgFlow* sgFlow = elm.second;
213 NetworkNS3Action * action = sgFlow->action_;
214 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
215 action->setRemains(action->getCost() - sgFlow->sentBytes_);
217 if (TRACE_is_enabled() &&
218 action->getState() == Action::State::running){
219 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
221 std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
223 action->src_->routeTo(action->dst_, route, nullptr);
224 for (auto const& link : route)
225 TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
228 action->lastSent_ = sgFlow->sentBytes_;
231 if(sgFlow->finished_){
232 socket_to_destroy.push_back(ns3Socket);
233 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
234 action->finish(Action::State::done);
238 while (not socket_to_destroy.empty()) {
239 ns3Socket = socket_to_destroy.back();
240 socket_to_destroy.pop_back();
241 SgFlow* flow = flowFromSock.at(ns3Socket);
242 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
243 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
246 flowFromSock.erase(ns3Socket);
254 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency)
255 : LinkImpl(model, name, nullptr)
257 bandwidth_.peak = bandwidth;
258 latency_.peak = latency;
260 s4u::Link::onCreation(this->piface_);
263 LinkNS3::~LinkNS3() = default;
265 void LinkNS3::apply_event(tmgr_trace_event_t event, double value)
269 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
270 xbt_die("The NS3 network model doesn't support bandwidth traces");
272 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
273 xbt_die("The NS3 network model doesn't support latency traces");
280 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
281 : NetworkAction(model, size, false)
283 XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname());
287 ns3_create_flow(src, dst, size, this);
289 s4u::Link::onCommunicate(this, src, dst);
292 void NetworkNS3Action::suspend() {
296 void NetworkNS3Action::resume() {
300 std::list<LinkImpl*> NetworkNS3Action::links()
305 /* Test whether a flow is suspended */
306 bool NetworkNS3Action::isSuspended()
311 int NetworkNS3Action::unref()
315 if (action_hook.is_linked())
316 simgrid::xbt::intrusive_erase(*stateSet_, *this);
317 XBT_DEBUG ("Removing action %p", this);
327 void ns3_simulator(double maxSeconds)
329 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
330 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
331 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
332 ns3::Simulator::Run ();
335 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst,
336 u_int32_t TotalBytes,
337 simgrid::surf::NetworkNS3Action* action) {
338 unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
339 unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
341 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
342 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
344 xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
345 dst->pimpl_netpoint->getCname());
346 std::string& addr = IPV4addr[node2];
347 xbt_assert(not addr.empty(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
348 dst->pimpl_netpoint->getCname());
350 XBT_DEBUG("ns3_create_flow %u Bytes from %u to %u with Interface %s", TotalBytes, node1, node2, addr.c_str());
351 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
352 sink.Install (dst_node);
354 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
356 flowFromSock.insert({transformSocketPtr(sock), new SgFlow(TotalBytes, action)});
358 sock->Bind(ns3::InetSocketAddress(port_number));
360 ns3::Simulator::ScheduleNow(&StartFlow, sock, addr.c_str(), port_number);
363 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
366 // initialize the NS3 interface and environment
367 void ns3_initialize(const char* TcpProtocol){
373 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
374 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
375 ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
377 if (not strcmp(TcpProtocol, "default"))
380 if (not strcmp(TcpProtocol, "Reno")) {
381 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
382 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
385 if (not strcmp(TcpProtocol, "NewReno")) {
386 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
387 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
390 if (not strcmp(TcpProtocol, "Tahoe")) {
391 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
392 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
396 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
399 void ns3_add_cluster(const char* id, double bw, double lat) {
400 ns3::NodeContainer Nodes;
402 for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
403 Nodes.Add(Cluster_nodes.Get(i));
404 XBT_DEBUG("Add node %u to cluster", i);
406 number_of_clusters_nodes = Cluster_nodes.GetN();
408 XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
409 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
411 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
412 ns3::CsmaHelper csma;
413 csma.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
414 csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
415 ns3::NetDeviceContainer devices = csma.Install(Nodes);
416 XBT_DEBUG("Create CSMA");
418 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
419 XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
420 ns3::Ipv4AddressHelper ipv4;
421 ipv4.SetBase(addr.c_str(), "255.255.0.0");
422 interfaces.Add(ipv4.Assign (devices));
424 if(number_of_links == 255){
425 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
427 number_of_networks++;
431 XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
434 static std::string transformIpv4Address(ns3::Ipv4Address from)
436 std::stringstream sstream;
438 return sstream.str();
441 void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
442 ns3::PointToPointHelper pointToPoint;
444 ns3::Ipv4AddressHelper address;
446 int srcNum = src->node_num;
447 int dstNum = dst->node_num;
449 ns3::Ptr<ns3::Node> a = nodes.Get(srcNum);
450 ns3::Ptr<ns3::Node> b = nodes.Get(dstNum);
452 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
453 pointToPoint.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
454 pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
456 std::string filename = simgrid::xbt::string_printf("link-%d-%d.tr", srcNum, dstNum);
457 ns3::AsciiTraceHelper ascii;
458 pointToPoint.EnableAsciiAll(ascii.CreateFileStream(filename));
459 pointToPoint.EnablePcapAll ("tcp-bulk-send", false);
461 ns3::NetDeviceContainer netA;
462 netA.Add(pointToPoint.Install (a, b));
464 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
465 address.SetBase(addr.c_str(), "255.255.0.0");
466 XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
467 interfaces.Add(address.Assign (netA));
469 if (IPV4addr.size() <= (unsigned)srcNum)
470 IPV4addr.resize(srcNum + 1);
471 IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
473 if (IPV4addr.size() <= (unsigned)dstNum)
474 IPV4addr.resize(dstNum + 1);
475 IPV4addr[dstNum] = 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++;