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