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