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. */
6 #include <unordered_set>
8 #include "xbt/config.hpp"
10 #include "ns3/core-module.h"
13 #include "ns3/ns3_simulator.h"
14 #include "network_ns3.hpp"
16 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
17 #include "src/kernel/routing/NetPoint.hpp"
19 #include "simgrid/s4u/Engine.hpp"
20 #include "simgrid/s4u/NetZone.hpp"
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
24 std::vector<char*> IPV4addr;
30 extern xbt_dict_t flowFromSock;
32 static ns3::InternetStackHelper stack;
33 static ns3::NodeContainer nodes;
34 static ns3::NodeContainer Cluster_nodes;
35 static ns3::Ipv4InterfaceContainer interfaces;
37 static int number_of_nodes = 0;
38 static int number_of_clusters_nodes = 0;
39 static int number_of_links = 1;
40 static int number_of_networks = 1;
41 static int port_number = 1025; //Port number is limited from 1025 to 65 000
43 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
45 NetPointNs3::NetPointNs3()
47 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
50 node_num = number_of_nodes++;
57 static void clusterCreation_cb(ClusterCreationArgs* cluster)
59 for (int const& i : *cluster->radicals) {
60 // Routers don't create a router on the other end of the private link by themselves.
61 // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
62 NetPointNs3* host_dst = new NetPointNs3();
64 // Create private link
65 std::string host_id = cluster->prefix + std::to_string(i) + cluster->suffix;
66 NetPointNs3* host_src = sg_host_by_name(host_id.c_str())->pimpl_netpoint->extension<NetPointNs3>();
67 xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id.c_str());
69 // Any NS3 route is symmetrical
70 ns3_add_link(host_src, host_dst, cluster->bw, cluster->lat);
75 //Create link backbone
76 ns3_add_cluster(cluster->id.c_str(), cluster->bb_bw, cluster->bb_lat);
79 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
80 simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
81 simgrid::kernel::routing::NetPoint* gw_dst,
82 std::vector<simgrid::surf::LinkImpl*>* link_list)
84 if (link_list->size() == 1) {
85 simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
87 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->cname(), dst->cname(), link->cname(),
88 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
90 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
91 XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->cname(), link->bandwidth(),
95 NetPointNs3* host_src = src->extension<NetPointNs3>();
96 NetPointNs3* host_dst = dst->extension<NetPointNs3>();
98 xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->cname());
99 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->cname());
101 ns3_add_link(host_src, host_dst, link->bandwidth(), link->latency());
103 static bool warned_about_long_routes = false;
105 if (not warned_about_long_routes)
106 XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with NS3.\n"
107 "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
109 "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
111 src->cname(), dst->cname(), link_list->size());
112 warned_about_long_routes = true;
116 /* Create the ns3 topology based on routing strategy */
117 static void postparse_cb()
119 IPV4addr.shrink_to_fit();
121 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
122 ns3::GlobalRouteManager::InitializeRoutes();
128 void surf_network_model_init_NS3()
130 if (surf_network_model)
133 surf_network_model = new simgrid::surf::NetworkNS3Model();
134 all_existing_models->push_back(surf_network_model);
137 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
138 "The ns3 tcp model can be : NewReno or Reno or Tahoe", "NewReno");
143 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
144 NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
146 flowFromSock = xbt_dict_new_homogeneous([](void* p) { delete static_cast<SgFlow*>(p); });
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->cname(), 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() {
163 for (auto const& addr : IPV4addr)
166 xbt_dict_free(&flowFromSock);
169 LinkImpl* NetworkNS3Model::createLink(const std::string& name, double bandwidth, double latency,
170 e_surf_link_sharing_policy_t policy)
172 return new LinkNS3(this, name, bandwidth, latency);
175 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
177 return new NetworkNS3Action(this, size, src, dst);
180 double NetworkNS3Model::nextOccuringEvent(double now)
182 double time_to_next_flow_completion;
183 XBT_DEBUG("ns3_next_occuring_event");
185 //get the first relevant value from the running_actions list
186 if (not getRunningActionSet()->size() || now == 0.0)
191 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
192 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
194 XBT_DEBUG("min : %f", now);
195 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
196 XBT_DEBUG("surf time : %f", surf_get_clock());
197 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
199 return time_to_next_flow_completion;
202 void NetworkNS3Model::updateActionsState(double now, double delta)
204 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
206 /* If there are no running flows, advance the NS3 simulator and return */
207 if (getRunningActionSet()->empty()) {
209 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
210 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
215 xbt_dict_cursor_t cursor = nullptr;
218 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
219 NetworkNS3Action * action = sgFlow->action_;
220 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
221 action->setRemains(action->getCost() - sgFlow->sentBytes_);
223 if (TRACE_is_enabled() &&
224 action->getState() == Action::State::running){
225 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
227 std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
229 action->src_->routeTo(action->dst_, &route, nullptr);
230 for (auto const& link : route)
231 TRACE_surf_link_set_utilization(link->cname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
234 action->lastSent_ = sgFlow->sentBytes_;
237 if(sgFlow->finished_){
238 xbt_dynar_push(socket_to_destroy,&ns3Socket);
239 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
240 action->finish(Action::State::done);
244 while (not xbt_dynar_is_empty(socket_to_destroy)) {
245 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
247 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
248 SgFlow* flow = static_cast<SgFlow*>(xbt_dict_get(flowFromSock, ns3Socket));
249 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
251 xbt_dict_remove(flowFromSock, ns3Socket);
259 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency)
260 : LinkImpl(model, name, nullptr)
262 bandwidth_.peak = bandwidth;
263 latency_.peak = latency;
265 s4u::Link::onCreation(this->piface_);
268 LinkNS3::~LinkNS3() = default;
270 void LinkNS3::apply_event(tmgr_trace_event_t event, double value)
274 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
275 xbt_die("The NS3 network model doesn't support bandwidth traces");
277 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
278 xbt_die("The NS3 network model doesn't support latency traces");
285 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
286 : NetworkAction(model, size, false)
288 XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname());
292 ns3_create_flow(src, dst, size, this);
294 s4u::Link::onCommunicate(this, src, dst);
297 void NetworkNS3Action::suspend() {
301 void NetworkNS3Action::resume() {
305 std::list<LinkImpl*> NetworkNS3Action::links()
310 /* Test whether a flow is suspended */
311 bool NetworkNS3Action::isSuspended()
316 int NetworkNS3Action::unref()
320 if (action_hook.is_linked())
321 stateSet_->erase(stateSet_->iterator_to(*this));
322 XBT_DEBUG ("Removing action %p", this);
332 void ns3_simulator(double maxSeconds)
334 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
335 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
336 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
337 ns3::Simulator::Run ();
340 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst,
341 u_int32_t TotalBytes,
342 simgrid::surf::NetworkNS3Action* action) {
343 unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
344 unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
346 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
347 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
349 xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
350 dst->pimpl_netpoint->cname());
351 char* addr = IPV4addr.at(node2);
352 xbt_assert(addr != nullptr, "Element %s is unknown to NS3. Is it connected to any one-hop link?",
353 dst->pimpl_netpoint->cname());
355 XBT_DEBUG("ns3_create_flow %u Bytes from %u to %u with Interface %s", TotalBytes, node1, node2, addr);
356 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
357 sink.Install (dst_node);
359 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
361 xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr);
363 sock->Bind(ns3::InetSocketAddress(port_number));
365 ns3::Simulator::ScheduleNow(&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 (1000));
379 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
380 ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
382 if (not strcmp(TcpProtocol, "default"))
385 if (not strcmp(TcpProtocol, "Reno")) {
386 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
387 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
390 if (not strcmp(TcpProtocol, "NewReno")) {
391 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
392 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
395 if (not strcmp(TcpProtocol, "Tahoe")) {
396 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
397 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
401 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
404 void ns3_add_cluster(const char* id, double bw, double 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 %u to cluster", i);
411 number_of_clusters_nodes = Cluster_nodes.GetN();
413 XBT_DEBUG("Add router %u 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.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
419 csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(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: %u", 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(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
448 ns3::PointToPointHelper pointToPoint;
450 ns3::Ipv4AddressHelper address;
452 int srcNum = src->node_num;
453 int dstNum = dst->node_num;
455 ns3::Ptr<ns3::Node> a = nodes.Get(srcNum);
456 ns3::Ptr<ns3::Node> b = nodes.Get(dstNum);
458 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
459 pointToPoint.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
460 pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
462 char *filename = bprintf("link-%d-%d.tr", srcNum, dstNum);
463 ns3::AsciiTraceHelper ascii;
464 pointToPoint.EnableAsciiAll (ascii.CreateFileStream (filename));
465 pointToPoint.EnablePcapAll ("tcp-bulk-send", false);
468 ns3::NetDeviceContainer netA;
469 netA.Add(pointToPoint.Install (a, b));
471 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
472 address.SetBase (adr, "255.255.0.0");
473 XBT_DEBUG("\tInterface stack '%s'",adr);
475 interfaces.Add(address.Assign (netA));
477 if (IPV4addr.size() <= (unsigned)srcNum)
478 IPV4addr.resize(srcNum + 1, nullptr);
479 IPV4addr.at(srcNum) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
481 if (IPV4addr.size() <= (unsigned)dstNum)
482 IPV4addr.resize(dstNum + 1, nullptr);
483 IPV4addr.at(dstNum) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
485 if (number_of_links == 255){
486 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
488 number_of_networks++;