src/surf/network_ns3.cpp

   1 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #include <string>
   7 #include <unordered_set>
   8
   9 #include "xbt/config.hpp"
  10 #include "xbt/string.hpp"
  11 #include "xbt/utility.hpp"
  12
  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
  22 #include "network_ns3.hpp"
  23 #include "ns3/ns3_simulator.hpp"
  24
  25 #include "simgrid/kernel/routing/NetPoint.hpp"
  26 #include "simgrid/plugins/energy.h"
  27 #include "simgrid/s4u/Engine.hpp"
  28 #include "simgrid/s4u/NetZone.hpp"
  29 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  30 #include "src/surf/surf_interface.hpp"
  31 #include "src/surf/xml/platf_private.hpp"
  32 #include "surf/surf.hpp"
  33
  34 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network ns-3 module");
  35
  36 std::vector<std::string> IPV4addr;
  37
  38 /*****************
  39  * Crude globals *
  40  *****************/
  41
  42 extern std::map<std::string, SgFlow*> flow_from_sock;
  43 extern std::map<std::string, ns3::ApplicationContainer> sink_from_sock;
  44
  45 static ns3::InternetStackHelper stack;
  46 static ns3::NodeContainer nodes;
  47 static ns3::NodeContainer Cluster_nodes;
  48 static ns3::Ipv4InterfaceContainer interfaces;
  49
  50 static int number_of_nodes = 0;
  51 static int number_of_clusters_nodes = 0;
  52 static int number_of_links = 1;
  53 static int number_of_networks = 1;
  54
  55 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
  56
  57 NetPointNs3::NetPointNs3()
  58 {
  59   ns3_node_ = ns3::CreateObject<ns3::Node>(0);
  60   stack.Install(ns3_node_);
  61   nodes.Add(ns3_node_);
  62   node_num = number_of_nodes++;
  63 }
  64
  65 /*************
  66  * Callbacks *
  67  *************/
  68
  69 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
  70 {
  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();
  75
  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)->pimpl_netpoint->extension<NetPointNs3>();
  79     xbt_assert(host_src, "Cannot find a ns-3 host of name %s", host_id.c_str());
  80
  81     // Any ns-3 route is symmetrical
  82     ns3_add_link(host_src, host_dst, cluster.bw, cluster.lat);
  83
  84     delete host_dst;
  85   }
  86
  87   //Create link backbone
  88   ns3_add_cluster(cluster.id.c_str(), cluster.bb_bw, cluster.bb_lat);
  89 }
  90
  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)
  95 {
  96   if (link_list.size() == 1) {
  97     auto* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
  98
  99     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->get_cname(), dst->get_cname(), link->get_cname(),
 100               (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
 101
 102     //   XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
 103     XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->get_cname(), link->get_bandwidth(), link->get_latency());
 104
 105     // create link ns3
 106     auto* host_src = src->extension<NetPointNs3>();
 107     auto* host_dst = dst->extension<NetPointNs3>();
 108
 109     xbt_assert(host_src != nullptr, "Network element %s does not seem to be ns-3-ready", src->get_cname());
 110     xbt_assert(host_dst != nullptr, "Network element %s does not seem to be ns-3-ready", dst->get_cname());
 111
 112     ns3_add_link(host_src, host_dst, link->get_bandwidth(), link->get_latency());
 113   } else {
 114     static bool warned_about_long_routes = false;
 115
 116     if (not warned_about_long_routes)
 117       XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with ns-3.\n"
 118                "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
 119                "of length 1.\n"
 120                "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
 121                "ignored.",
 122                src->get_cname(), dst->get_cname(), link_list.size());
 123     warned_about_long_routes = true;
 124   }
 125 }
 126
 127 /* Create the ns3 topology based on routing strategy */
 128 static void postparse_cb()
 129 {
 130   IPV4addr.shrink_to_fit();
 131
 132   ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
 133   ns3::GlobalRouteManager::InitializeRoutes();
 134 }
 135
 136 /*********
 137  * Model *
 138  *********/
 139 void surf_network_model_init_NS3()
 140 {
 141   xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
 142
 143   surf_network_model = new simgrid::kernel::resource::NetworkNS3Model();
 144 }
 145
 146 static simgrid::config::Flag<std::string>
 147     ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be : NewReno or Reno or Tahoe", "default");
 148
 149 namespace simgrid {
 150 namespace kernel {
 151 namespace resource {
 152
 153 NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
 154 {
 155   xbt_assert(not sg_link_energy_is_inited(),
 156              "LinkEnergy plugin and ns-3 network models are not compatible. Are you looking for Ecofen, maybe?");
 157
 158   all_existing_models.push_back(this);
 159
 160   NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create<NetPointNs3>();
 161
 162   ns3_initialize(ns3_tcp_model.get());
 163
 164   routing::NetPoint::on_creation.connect([](routing::NetPoint& pt) {
 165     pt.extension_set<NetPointNs3>(new NetPointNs3());
 166     XBT_VERB("SimGrid's %s is known as node %d within ns-3", pt.get_cname(), pt.extension<NetPointNs3>()->node_num);
 167   });
 168   surf::on_cluster.connect(&clusterCreation_cb);
 169
 170   s4u::Engine::on_platform_created.connect(&postparse_cb);
 171   s4u::NetZone::on_route_creation.connect(&routeCreation_cb);
 172 }
 173
 174 NetworkNS3Model::~NetworkNS3Model() {
 175   IPV4addr.clear();
 176 }
 177
 178 LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
 179                                        s4u::Link::SharingPolicy)
 180 {
 181   xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
 182   return new LinkNS3(this, name, bandwidths[0], latency);
 183 }
 184
 185 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 186 {
 187   xbt_assert(rate == -1,
 188              "Communication over ns-3 links cannot specify a specific rate. Please use -1 as a value instead of %f.",
 189              rate);
 190   return new NetworkNS3Action(this, size, src, dst);
 191 }
 192
 193 double NetworkNS3Model::next_occuring_event(double now)
 194 {
 195   double time_to_next_flow_completion = 0.0;
 196   XBT_DEBUG("ns3_next_occuring_event");
 197
 198   //get the first relevant value from the running_actions list
 199   if (get_started_action_set()->empty() || now == 0.0)
 200     return -1.0;
 201
 202   XBT_DEBUG("doing a ns3 simulation for a duration of %f", now);
 203   ns3_simulator(now);
 204   time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
 205   // NS-3 stops as soon as a flow ends,
 206   // but it does not process the other flows that may finish at the same (simulated) time.
 207   // If another flow ends at the same time, time_to_next_flow_completion = 0
 208   if(double_equals(time_to_next_flow_completion, 0, sg_surf_precision))
 209     time_to_next_flow_completion = 0.0;
 210
 211   XBT_DEBUG("min       : %f", now);
 212   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
 213   XBT_DEBUG("surf time : %f", surf_get_clock());
 214   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
 215
 216   return time_to_next_flow_completion;
 217 }
 218
 219 void NetworkNS3Model::update_actions_state(double now, double delta)
 220 {
 221   static std::vector<std::string> socket_to_destroy;
 222
 223   /* If there are no running flows, advance the ns-3 simulator and return */
 224   if (get_started_action_set()->empty()) {
 225
 226     while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
 227       ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
 228
 229     return;
 230   }
 231
 232   std::string ns3_socket;
 233   for (const auto& elm : flow_from_sock) {
 234     ns3_socket                = elm.first;
 235     SgFlow* sgFlow            = elm.second;
 236     NetworkNS3Action * action = sgFlow->action_;
 237     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
 238     // Because NS3 stops as soon as a flow is finished, the other flows that ends at the same time may remains in an inconsistant state
 239     // (i.e. remains_ == 0 but finished_ == false).
 240     // However, SimGrid considers sometimes that an action with remains_ == 0 is finished.
 241     // Thus, to avoid inconsistencies between SimGrid and NS3, set remains to 0 only when the flow is finished in NS3
 242     int remains = action->get_cost() - sgFlow->sent_bytes_;
 243     if(remains > 0)
 244       action->set_remains(remains);
 245
 246     if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) {
 247       double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_;
 248
 249       std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
 250
 251       action->src_->route_to(action->dst_, route, nullptr);
 252       for (auto const& link : route)
 253         TRACE_surf_resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(),
 254                                             (data_delta_sent) / delta, now - delta, delta);
 255
 256       action->last_sent_ = sgFlow->sent_bytes_;
 257     }
 258
 259     if(sgFlow->finished_){
 260       socket_to_destroy.push_back(ns3_socket);
 261       XBT_DEBUG("Destroy socket %p of action %p", ns3_socket.c_str(), action);
 262       action->set_remains(0);
 263       action->finish(kernel::resource::Action::State::FINISHED);
 264     } else {
 265       XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
 266                 sgFlow->total_bytes_, sgFlow->remaining_);
 267     }
 268   }
 269
 270   while (not socket_to_destroy.empty()) {
 271     ns3_socket = socket_to_destroy.back();
 272     socket_to_destroy.pop_back();
 273     SgFlow* flow = flow_from_sock.at(ns3_socket);
 274     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
 275       XBT_DEBUG("Removing socket %p of action %p", ns3_socket.c_str(), flow->action_);
 276     }
 277     delete flow;
 278     flow_from_sock.erase(ns3_socket);
 279     sink_from_sock.erase(ns3_socket);
 280   }
 281 }
 282
 283 /************
 284  * Resource *
 285  ************/
 286
 287 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency)
 288     : LinkImpl(model, name, nullptr)
 289 {
 290   bandwidth_.peak = bandwidth;
 291   latency_.peak   = latency;
 292
 293   s4u::Link::on_creation(this->piface_);
 294 }
 295
 296 LinkNS3::~LinkNS3() = default;
 297
 298 void LinkNS3::apply_event(profile::Event*, double)
 299 {
 300   THROW_UNIMPLEMENTED;
 301 }
 302 void LinkNS3::set_bandwidth_profile(profile::Profile*)
 303 {
 304   xbt_die("The ns-3 network model doesn't support bandwidth profiles");
 305 }
 306 void LinkNS3::set_latency_profile(profile::Profile*)
 307 {
 308   xbt_die("The ns-3 network model doesn't support latency profiles");
 309 }
 310
 311 /**********
 312  * Action *
 313  **********/
 314
 315 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
 316     : NetworkAction(model, totalBytes, false), src_(src), dst_(dst)
 317 {
 318   XBT_DEBUG("Communicate from %s to %s", src->get_cname(), dst->get_cname());
 319
 320   static int port_number = 1025; // Port number is limited from 1025 to 65 000
 321
 322   unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
 323   unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
 324
 325   ns3::Ptr<ns3::Node> src_node = src->pimpl_netpoint->extension<NetPointNs3>()->ns3_node_;
 326   ns3::Ptr<ns3::Node> dst_node = dst->pimpl_netpoint->extension<NetPointNs3>()->ns3_node_;
 327
 328   xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
 329              dst->pimpl_netpoint->get_cname());
 330   std::string& addr = IPV4addr[node2];
 331   xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
 332              dst->pimpl_netpoint->get_cname());
 333
 334   XBT_DEBUG("ns3: Create flow of %.0f Bytes from %u to %u with Interface %s", totalBytes, node1, node2, addr.c_str());
 335   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
 336   ns3::ApplicationContainer apps = sink.Install(dst_node);
 337
 338   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
 339
 340   flow_from_sock.insert({transform_socket_ptr(sock), new SgFlow(totalBytes, this)});
 341   sink_from_sock.insert({transform_socket_ptr(sock), apps});
 342
 343   sock->Bind(ns3::InetSocketAddress(port_number));
 344
 345   ns3::Simulator::ScheduleNow(&start_flow, sock, addr.c_str(), port_number);
 346
 347   port_number++;
 348   if(port_number > 65000){
 349     port_number = 1025;
 350     XBT_WARN("Too many connections! Port number is saturated. Trying to use the oldest ports.");
 351   }
 352   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
 353
 354   s4u::Link::on_communicate(*this, src, dst);
 355 }
 356
 357 void NetworkNS3Action::suspend() {
 358   THROW_UNIMPLEMENTED;
 359 }
 360
 361 void NetworkNS3Action::resume() {
 362   THROW_UNIMPLEMENTED;
 363 }
 364
 365 std::list<LinkImpl*> NetworkNS3Action::links() const
 366 {
 367   THROW_UNIMPLEMENTED;
 368 }
 369 void NetworkNS3Action::update_remains_lazy(double /*now*/)
 370 {
 371   THROW_IMPOSSIBLE;
 372 }
 373
 374 } // namespace resource
 375 } // namespace kernel
 376 } // namespace simgrid
 377
 378 void ns3_simulator(double maxSeconds)
 379 {
 380   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
 381     ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
 382   XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
 383   ns3::Simulator::Run ();
 384 }
 385
 386 // initialize the ns-3 interface and environment
 387 void ns3_initialize(std::string TcpProtocol)
 388 {
 389   //  tcpModel are:
 390   //  "ns3::TcpNewReno"
 391   //  "ns3::TcpReno"
 392   //  "ns3::TcpTahoe"
 393
 394   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
 395   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
 396   ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
 397
 398   if (TcpProtocol == "default") {
 399     /* nothing to do */
 400
 401   } else if (TcpProtocol == "Reno") {
 402     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 403     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
 404
 405   } else if (TcpProtocol == "NewReno") {
 406     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 407     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
 408
 409   } else if (TcpProtocol == "Tahoe") {
 410     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 411     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
 412
 413   } else {
 414     xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
 415   }
 416 }
 417
 418 void ns3_add_cluster(const char* id, double bw, double lat) {
 419   ns3::NodeContainer Nodes;
 420
 421   for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
 422     Nodes.Add(Cluster_nodes.Get(i));
 423     XBT_DEBUG("Add node %u to cluster", i);
 424   }
 425   number_of_clusters_nodes = Cluster_nodes.GetN();
 426
 427   XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
 428   Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
 429
 430   xbt_assert(Nodes.GetN() <= 65000, "Cluster with ns-3 is limited to 65000 nodes");
 431   ns3::CsmaHelper csma;
 432   csma.SetChannelAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
 433   csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 434   ns3::NetDeviceContainer devices = csma.Install(Nodes);
 435   XBT_DEBUG("Create CSMA");
 436
 437   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 438   XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
 439   ns3::Ipv4AddressHelper ipv4;
 440   ipv4.SetBase(addr.c_str(), "255.255.0.0");
 441   interfaces.Add(ipv4.Assign (devices));
 442
 443   if(number_of_links == 255){
 444     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 445     number_of_links = 1;
 446     number_of_networks++;
 447   }else{
 448     number_of_links++;
 449   }
 450   XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
 451 }
 452
 453 static std::string transformIpv4Address(ns3::Ipv4Address from)
 454 {
 455   std::stringstream sstream;
 456   sstream << from ;
 457   return sstream.str();
 458 }
 459
 460 void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
 461   ns3::PointToPointHelper pointToPoint;
 462
 463   ns3::Ipv4AddressHelper address;
 464
 465   int srcNum = src->node_num;
 466   int dstNum = dst->node_num;
 467
 468   ns3::Ptr<ns3::Node> a = src->ns3_node_;
 469   ns3::Ptr<ns3::Node> b = dst->ns3_node_;
 470
 471   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
 472   pointToPoint.SetDeviceAttribute("DataRate",
 473                                   ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
 474   pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 475
 476   ns3::NetDeviceContainer netA;
 477   netA.Add(pointToPoint.Install (a, b));
 478
 479   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 480   address.SetBase(addr.c_str(), "255.255.0.0");
 481   XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
 482   interfaces.Add(address.Assign (netA));
 483
 484   if (IPV4addr.size() <= (unsigned)srcNum)
 485     IPV4addr.resize(srcNum + 1);
 486   IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
 487
 488   if (IPV4addr.size() <= (unsigned)dstNum)
 489     IPV4addr.resize(dstNum + 1);
 490   IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
 491
 492   if (number_of_links == 255){
 493     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 494     number_of_links = 1;
 495     number_of_networks++;
 496   } else {
 497     number_of_links++;
 498   }
 499 }