src/surf/network_ns3.cpp

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