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 "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  25 #include "src/kernel/routing/NetPoint.hpp"
  26
  27 #include "simgrid/plugins/energy.h"
  28 #include "simgrid/s4u/Engine.hpp"
  29 #include "simgrid/s4u/NetZone.hpp"
  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(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 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->setRemains(action->getCost() - sgFlow->sentBytes_);
 225
 226     if (TRACE_is_enabled() &&
 227         action->getState() == Action::State::running){
 228       double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
 229
 230       std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
 231
 232       action->src_->routeTo(action->dst_, route, nullptr);
 233       for (auto const& link : route)
 234         TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
 235                                         delta);
 236
 237       action->lastSent_ = sgFlow->sentBytes_;
 238     }
 239
 240     if(sgFlow->finished_){
 241       socket_to_destroy.push_back(ns3Socket);
 242       XBT_DEBUG("Destroy socket %p of action %p", ns3Socket.c_str(), action);
 243       action->finish(Action::State::done);
 244     } else {
 245       XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3Socket.c_str(), sgFlow->sentBytes_,
 246                 sgFlow->totalBytes_, sgFlow->remaining_);
 247     }
 248   }
 249
 250   while (not socket_to_destroy.empty()) {
 251     ns3Socket = socket_to_destroy.back();
 252     socket_to_destroy.pop_back();
 253     SgFlow* flow = flowFromSock.at(ns3Socket);
 254     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
 255       XBT_DEBUG("Removing socket %p of action %p", ns3Socket.c_str(), flow->action_);
 256     }
 257     delete flow;
 258     flowFromSock.erase(ns3Socket);
 259   }
 260 }
 261
 262 /************
 263  * Resource *
 264  ************/
 265
 266 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency)
 267     : LinkImpl(model, name, nullptr)
 268 {
 269   bandwidth_.peak = bandwidth;
 270   latency_.peak   = latency;
 271
 272   s4u::Link::onCreation(this->piface_);
 273 }
 274
 275 LinkNS3::~LinkNS3() = default;
 276
 277 void LinkNS3::apply_event(tmgr_trace_event_t event, double value)
 278 {
 279   THROW_UNIMPLEMENTED;
 280 }
 281 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
 282   xbt_die("The NS3 network model doesn't support bandwidth traces");
 283 }
 284 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
 285   xbt_die("The NS3 network model doesn't support latency traces");
 286 }
 287
 288 /**********
 289  * Action *
 290  **********/
 291
 292 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
 293     : NetworkAction(model, totalBytes, false)
 294 {
 295   XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname());
 296
 297   src_ = src;
 298   dst_ = dst;
 299   static int port_number = 1025; // Port number is limited from 1025 to 65 000
 300
 301   unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
 302   unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
 303
 304   ns3::Ptr<ns3::Node> src_node = src->pimpl_netpoint->extension<NetPointNs3>()->ns3Node_;
 305   ns3::Ptr<ns3::Node> dst_node = dst->pimpl_netpoint->extension<NetPointNs3>()->ns3Node_;
 306
 307   xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
 308              dst->pimpl_netpoint->getCname());
 309   std::string& addr = IPV4addr[node2];
 310   xbt_assert(not addr.empty(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
 311              dst->pimpl_netpoint->getCname());
 312
 313   XBT_DEBUG("ns3: Create flow of %.0f Bytes from %u to %u with Interface %s", totalBytes, node1, node2, addr.c_str());
 314   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
 315   sink.Install(dst_node);
 316
 317   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
 318
 319   flowFromSock.insert({transformSocketPtr(sock), new SgFlow(totalBytes, this)});
 320
 321   sock->Bind(ns3::InetSocketAddress(port_number));
 322
 323   ns3::Simulator::ScheduleNow(&StartFlow, sock, addr.c_str(), port_number);
 324
 325   port_number++;
 326   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
 327
 328   s4u::Link::onCommunicate(this, src, dst);
 329 }
 330
 331 void NetworkNS3Action::suspend() {
 332   THROW_UNIMPLEMENTED;
 333 }
 334
 335 void NetworkNS3Action::resume() {
 336   THROW_UNIMPLEMENTED;
 337 }
 338
 339 std::list<LinkImpl*> NetworkNS3Action::links()
 340 {
 341   THROW_UNIMPLEMENTED;
 342 }
 343
 344 /* Test whether a flow is suspended */
 345 bool NetworkNS3Action::isSuspended()
 346 {
 347   return false;
 348 }
 349
 350 int NetworkNS3Action::unref()
 351 {
 352   refcount_--;
 353   if (not refcount_) {
 354     if (stateSetHook_.is_linked())
 355       simgrid::xbt::intrusive_erase(*stateSet_, *this);
 356     XBT_DEBUG ("Removing action %p", this);
 357     delete this;
 358     return 1;
 359   }
 360   return 0;
 361 }
 362
 363 }
 364 }
 365
 366 void ns3_simulator(double maxSeconds)
 367 {
 368   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
 369     ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
 370   XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
 371   ns3::Simulator::Run ();
 372 }
 373
 374
 375 // initialize the NS3 interface and environment
 376 void ns3_initialize(std::string TcpProtocol)
 377 {
 378   //  tcpModel are:
 379   //  "ns3::TcpNewReno"
 380   //  "ns3::TcpReno"
 381   //  "ns3::TcpTahoe"
 382
 383   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
 384   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
 385   ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
 386
 387   if (TcpProtocol == "default") {
 388     /* nothing to do */
 389
 390   } else if (TcpProtocol == "Reno") {
 391     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 392     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
 393
 394   } else if (TcpProtocol == "NewReno") {
 395     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 396     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
 397
 398   } else if (TcpProtocol == "Tahoe") {
 399     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 400     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
 401
 402   } else {
 403     xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
 404   }
 405 }
 406
 407 void ns3_add_cluster(const char* id, double bw, double lat) {
 408   ns3::NodeContainer Nodes;
 409
 410   for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
 411     Nodes.Add(Cluster_nodes.Get(i));
 412     XBT_DEBUG("Add node %u to cluster", i);
 413   }
 414   number_of_clusters_nodes = Cluster_nodes.GetN();
 415
 416   XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
 417   Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
 418
 419   xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
 420   ns3::CsmaHelper csma;
 421   csma.SetChannelAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw * 8))); // NS3 takes bps, but we provide Bps
 422   csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 423   ns3::NetDeviceContainer devices = csma.Install(Nodes);
 424   XBT_DEBUG("Create CSMA");
 425
 426   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 427   XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
 428   ns3::Ipv4AddressHelper ipv4;
 429   ipv4.SetBase(addr.c_str(), "255.255.0.0");
 430   interfaces.Add(ipv4.Assign (devices));
 431
 432   if(number_of_links == 255){
 433     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 434     number_of_links = 1;
 435     number_of_networks++;
 436   }else{
 437     number_of_links++;
 438   }
 439   XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
 440 }
 441
 442 static std::string transformIpv4Address(ns3::Ipv4Address from)
 443 {
 444   std::stringstream sstream;
 445   sstream << from ;
 446   return sstream.str();
 447 }
 448
 449 void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
 450   ns3::PointToPointHelper pointToPoint;
 451
 452   ns3::Ipv4AddressHelper address;
 453
 454   int srcNum = src->node_num;
 455   int dstNum = dst->node_num;
 456
 457   ns3::Ptr<ns3::Node> a = src->ns3Node_;
 458   ns3::Ptr<ns3::Node> b = dst->ns3Node_;
 459
 460   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
 461   pointToPoint.SetDeviceAttribute("DataRate",
 462                                   ns3::DataRateValue(ns3::DataRate(bw * 8))); // NS3 takes bps, but we provide Bps
 463   pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 464
 465   ns3::NetDeviceContainer netA;
 466   netA.Add(pointToPoint.Install (a, b));
 467
 468   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 469   address.SetBase(addr.c_str(), "255.255.0.0");
 470   XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
 471   interfaces.Add(address.Assign (netA));
 472
 473   if (IPV4addr.size() <= (unsigned)srcNum)
 474     IPV4addr.resize(srcNum + 1);
 475   IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
 476
 477   if (IPV4addr.size() <= (unsigned)dstNum)
 478     IPV4addr.resize(dstNum + 1);
 479   IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
 480
 481   if (number_of_links == 255){
 482     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 483     number_of_links = 1;
 484     number_of_networks++;
 485   } else {
 486     number_of_links++;
 487   }
 488 }