src/surf/network_ns3.cpp

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