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 "ns3/wifi-module.h"
  24 #include "ns3/mobility-module.h"
  25
  26 #include "network_ns3.hpp"
  27 #include "ns3/ns3_simulator.hpp"
  28
  29 #include "simgrid/kernel/routing/NetPoint.hpp"
  30 #include "simgrid/plugins/energy.h"
  31 #include "simgrid/s4u/Engine.hpp"
  32 #include "simgrid/s4u/NetZone.hpp"
  33 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  34 #include "src/surf/surf_interface.hpp"
  35 #include "src/surf/xml/platf_private.hpp"
  36 #include "surf/surf.hpp"
  37
  38 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network ns-3 module");
  39
  40 std::vector<std::string> IPV4addr;
  41 static std::string transformIpv4Address(ns3::Ipv4Address from);
  42
  43 /*****************
  44  * Crude globals *
  45  *****************/
  46
  47 extern std::map<std::string, SgFlow*> flow_from_sock;
  48 extern std::map<std::string, ns3::ApplicationContainer> sink_from_sock;
  49
  50 static ns3::InternetStackHelper stack;
  51 static ns3::NodeContainer nodes;
  52 static ns3::NodeContainer Cluster_nodes;
  53 static ns3::Ipv4InterfaceContainer interfaces;
  54
  55 static int number_of_nodes = 0;
  56 static int number_of_clusters_nodes = 0;
  57 static int number_of_links = 1;
  58 static int number_of_networks = 1;
  59
  60 /* wifi globals */
  61
  62 /* This vector store the tuple for the different wifi zones:
  63  * zone name, ptr to AP node, channel, network, link, nb station nodes
  64 */
  65 static std::vector <std::tuple <std::string, ns3::Ptr<ns3::Node>, ns3::Ptr <ns3::YansWifiChannel>, int, int, int> > wifi_zones;
  66 static ns3::WifiHelper wifi;
  67 static ns3::YansWifiPhyHelper wifiPhy = ns3::YansWifiPhyHelper::Default ();
  68 static ns3::YansWifiChannelHelper wifiChannel = ns3::YansWifiChannelHelper::Default ();
  69 static ns3::WifiMacHelper wifiMac;
  70 static ns3::MobilityHelper mobility;
  71
  72 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
  73
  74 NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject<ns3::Node>(0))
  75 {
  76   stack.Install(ns3_node_);
  77   nodes.Add(ns3_node_);
  78   node_num = number_of_nodes++;
  79 }
  80
  81 WifiZone::WifiZone(std::string name_, simgrid::s4u::Host* host_, ns3::Ptr<ns3::Node> ap_node_,
  82                    ns3::Ptr<ns3::YansWifiChannel> channel_, int network_, int link_) :
  83     name(name_), host(host_), ap_node(ap_node_), channel(channel_), network(network_), link(link_){
  84     n_sta_nodes = 0;
  85     wifi_zones[name_] = this;
  86 }
  87
  88 const char* WifiZone::get_cname() {
  89     return name.c_str();
  90 }
  91
  92 simgrid::s4u::Host* WifiZone::get_host(){
  93     return host;
  94 }
  95
  96 ns3::Ptr<ns3::Node> WifiZone::get_ap_node() {
  97     return ap_node;
  98 }
  99
 100 ns3::Ptr<ns3::YansWifiChannel> WifiZone::get_channel() {
 101     return channel;
 102 }
 103
 104 int WifiZone::get_network() {
 105     return network;
 106 }
 107
 108 int WifiZone::get_link() {
 109     return link;
 110 }
 111
 112 int WifiZone::get_n_sta_nodes() {
 113     return n_sta_nodes;
 114 }
 115
 116 void WifiZone::set_ap_node(ns3::Ptr<ns3::Node> ap_node_) {
 117     ap_node = ap_node_;
 118 }
 119
 120 void WifiZone::set_network(int network_) {
 121     network = network_;
 122 }
 123
 124 void WifiZone::set_link(int link_) {
 125     link = link_;
 126 }
 127
 128 void WifiZone::add_sta_node() {
 129     n_sta_nodes++;
 130 }
 131
 132 bool WifiZone::is_ap(ns3::Ptr<ns3::Node> ap){
 133     for (std::pair<std::string, WifiZone*> zone : wifi_zones)
 134         if (zone.second->get_ap_node() == ap)
 135             return true;
 136     return false;
 137 }
 138
 139 WifiZone* WifiZone::by_name(std::string name) {
 140     WifiZone* zone;
 141     try {
 142         zone = wifi_zones.at(name);
 143     }
 144     catch (const std::out_of_range& oor) {
 145         return nullptr;
 146     }
 147     return zone;
 148 }
 149
 150 std::unordered_map<std::string, WifiZone*> WifiZone::wifi_zones;
 151
 152 static void initialize_ns3_wifi() {
 153     wifi.SetStandard (ns3::WIFI_PHY_STANDARD_80211n_5GHZ);
 154     wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager",
 155                               "ControlMode", ns3::StringValue ("HtMcs0"),
 156                               "DataMode", ns3::StringValue ("HtMcs3"));
 157
 158     std::vector <simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 159     for (auto host : hosts)
 160         if (host->get_property("cell"))
 161           new WifiZone(host->get_property("cell"), host, nullptr, wifiChannel.Create (), 0, 0);
 162 }
 163
 164 /*************
 165  * Callbacks *
 166  *************/
 167
 168 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
 169 {
 170   for (int const& i : *cluster.radicals) {
 171     // Routers don't create a router on the other end of the private link by themselves.
 172     // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
 173     auto* host_dst = new NetPointNs3();
 174
 175     // Create private link
 176     std::string host_id = cluster.prefix + std::to_string(i) + cluster.suffix;
 177     auto* host_src      = simgrid::s4u::Host::by_name(host_id)->get_netpoint()->extension<NetPointNs3>();
 178     xbt_assert(host_src, "Cannot find a ns-3 host of name %s", host_id.c_str());
 179
 180     // Any ns-3 route is symmetrical
 181     ns3_add_direct_route(host_src, host_dst, cluster.bw, cluster.lat, cluster.id, cluster.sharing_policy);
 182
 183     delete host_dst;
 184   }
 185
 186   //Create link backbone
 187   ns3_add_cluster(cluster.id.c_str(), cluster.bb_bw, cluster.bb_lat);
 188 }
 189
 190 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
 191                              simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* /*gw_src*/,
 192                              simgrid::kernel::routing::NetPoint* /*gw_dst*/,
 193                              std::vector<simgrid::kernel::resource::LinkImpl*> const& link_list)
 194 {
 195   if (link_list.size() == 1) {
 196     auto* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
 197
 198     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s %s", src->get_cname(), dst->get_cname(), link->get_cname(),
 199               (link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI ? "(wifi)" : "(wired)"),
 200               (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
 201
 202     //   XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
 203     XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->get_cname(), link->get_bandwidth(), link->get_latency());
 204
 205     // create link ns3
 206     auto* host_src = src->extension<NetPointNs3>();
 207     auto* host_dst = dst->extension<NetPointNs3>();
 208
 209     xbt_assert(host_src != nullptr, "Network element %s does not seem to be ns-3-ready", src->get_cname());
 210     xbt_assert(host_dst != nullptr, "Network element %s does not seem to be ns-3-ready", dst->get_cname());
 211
 212     ns3_add_direct_route(host_src, host_dst, link->get_bandwidth(), link->get_latency(), link->get_name(), link->get_sharing_policy());
 213   } else {
 214     static bool warned_about_long_routes = false;
 215
 216     if (not warned_about_long_routes)
 217       XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with ns-3.\n"
 218                "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
 219                "of length 1.\n"
 220                "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
 221                "ignored.",
 222                src->get_cname(), dst->get_cname(), link_list.size());
 223     warned_about_long_routes = true;
 224   }
 225 }
 226
 227 /* Create the ns3 topology based on routing strategy */
 228 static void postparse_cb()
 229 {
 230   IPV4addr.shrink_to_fit();
 231   ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
 232   ns3::GlobalRouteManager::InitializeRoutes();
 233 }
 234
 235 /*********
 236  * Model *
 237  *********/
 238 void surf_network_model_init_NS3()
 239 {
 240   xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
 241
 242   surf_network_model = new simgrid::kernel::resource::NetworkNS3Model();
 243 }
 244
 245 static simgrid::config::Flag<std::string>
 246     ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be : NewReno or Reno or Tahoe", "default");
 247
 248 namespace simgrid {
 249 namespace kernel {
 250 namespace resource {
 251
 252 NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
 253 {
 254   xbt_assert(not sg_link_energy_is_inited(),
 255              "LinkEnergy plugin and ns-3 network models are not compatible. Are you looking for Ecofen, maybe?");
 256
 257   all_existing_models.push_back(this);
 258
 259   NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create<NetPointNs3>();
 260
 261   ns3_initialize(ns3_tcp_model.get());
 262
 263   routing::NetPoint::on_creation.connect([](routing::NetPoint& pt) {
 264     pt.extension_set<NetPointNs3>(new NetPointNs3());
 265     XBT_VERB("SimGrid's %s is known as node %d within ns-3", pt.get_cname(), pt.extension<NetPointNs3>()->node_num);
 266   });
 267   routing::on_cluster_creation.connect(&clusterCreation_cb);
 268
 269   s4u::Engine::on_platform_created.connect(&postparse_cb);
 270   s4u::NetZone::on_route_creation.connect(&routeCreation_cb);
 271 }
 272
 273 NetworkNS3Model::~NetworkNS3Model() {
 274   IPV4addr.clear();
 275 }
 276
 277 LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
 278                                        s4u::Link::SharingPolicy policy)
 279 {
 280   xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
 281   return new LinkNS3(this, name, bandwidths[0], latency, policy);
 282 }
 283
 284 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 285 {
 286   xbt_assert(rate == -1,
 287              "Communication over ns-3 links cannot specify a specific rate. Please use -1 as a value instead of %f.",
 288              rate);
 289   return new NetworkNS3Action(this, size, src, dst);
 290 }
 291
 292 double NetworkNS3Model::next_occurring_event(double now)
 293 {
 294   double time_to_next_flow_completion = 0.0;
 295   XBT_DEBUG("ns3_next_occurring_event");
 296
 297   //get the first relevant value from the running_actions list
 298
 299   // If there is no comms in NS-3, then we do not move it forward.
 300   // We will synchronize NS-3 with SimGrid when starting a new communication.
 301   // (see NetworkNS3Action::NetworkNS3Action() for more details on this point)
 302   if (get_started_action_set()->empty() || now == 0.0)
 303     return -1.0;
 304
 305   XBT_DEBUG("doing a ns3 simulation for a duration of %f", now);
 306   ns3_simulator(now);
 307   time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
 308   // NS-3 stops as soon as a flow ends,
 309   // but it does not process the other flows that may finish at the same (simulated) time.
 310   // If another flow ends at the same time, time_to_next_flow_completion = 0
 311   if(double_equals(time_to_next_flow_completion, 0, sg_surf_precision))
 312     time_to_next_flow_completion = 0.0;
 313
 314   XBT_DEBUG("min       : %f", now);
 315   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
 316   XBT_DEBUG("surf time : %f", surf_get_clock());
 317   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
 318
 319   return time_to_next_flow_completion;
 320 }
 321
 322 void NetworkNS3Model::update_actions_state(double now, double delta)
 323 {
 324   static std::vector<std::string> socket_to_destroy;
 325
 326   std::string ns3_socket;
 327   for (const auto& elm : flow_from_sock) {
 328     ns3_socket                = elm.first;
 329     SgFlow* sgFlow            = elm.second;
 330     NetworkNS3Action * action = sgFlow->action_;
 331     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
 332     // Because NS3 stops as soon as a flow is finished, the other flows that ends at the same time may remains in an
 333     // inconsistent state (i.e. remains_ == 0 but finished_ == false).
 334     // However, SimGrid considers sometimes that an action with remains_ == 0 is finished.
 335     // Thus, to avoid inconsistencies between SimGrid and NS3, set remains to 0 only when the flow is finished in NS3
 336     int remains = action->get_cost() - sgFlow->sent_bytes_;
 337     if(remains > 0)
 338       action->set_remains(remains);
 339
 340     if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) {
 341       double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_;
 342
 343       std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
 344
 345       action->get_src().route_to(&action->get_dst(), route, nullptr);
 346       for (auto const& link : route)
 347         instr::resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(),
 348                                         (data_delta_sent) / delta, now - delta, delta);
 349
 350       action->last_sent_ = sgFlow->sent_bytes_;
 351     }
 352
 353     if(sgFlow->finished_){
 354       socket_to_destroy.push_back(ns3_socket);
 355       XBT_DEBUG("Destroy socket %p of action %p", ns3_socket.c_str(), action);
 356       action->set_remains(0);
 357       action->finish(Action::State::FINISHED);
 358     } else {
 359       XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
 360                 sgFlow->total_bytes_, sgFlow->remaining_);
 361     }
 362   }
 363
 364   while (not socket_to_destroy.empty()) {
 365     ns3_socket = socket_to_destroy.back();
 366     socket_to_destroy.pop_back();
 367     SgFlow* flow = flow_from_sock.at(ns3_socket);
 368     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
 369       XBT_DEBUG("Removing socket %p of action %p", ns3_socket.c_str(), flow->action_);
 370     }
 371     delete flow;
 372     flow_from_sock.erase(ns3_socket);
 373     sink_from_sock.erase(ns3_socket);
 374   }
 375 }
 376
 377 /************
 378  * Resource *
 379  ************/
 380
 381 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency,
 382                  s4u::Link::SharingPolicy policy)
 383     : LinkImpl(model, name, nullptr)
 384 {
 385   bandwidth_.peak = bandwidth;
 386   latency_.peak   = latency;
 387   sharing_policy_ = policy;
 388
 389   if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
 390       static bool wifi_init = false;
 391       if (!wifi_init) {
 392           initialize_ns3_wifi();
 393           wifi_init = true;
 394       }
 395
 396       ns3::NetDeviceContainer netA;
 397       WifiZone* zone = WifiZone::by_name(name);
 398       xbt_assert(zone != 0, "Link name '%s' does not match the 'cell' property of a host.", name.c_str());
 399       NetPointNs3* netpoint_ns3 = zone->get_host()->get_netpoint()->extension<NetPointNs3>();
 400
 401       zone->set_ap_node(netpoint_ns3->ns3_node_);
 402
 403       wifiPhy.SetChannel (zone->get_channel());
 404       wifiMac.SetType("ns3::ApWifiMac");
 405       netA.Add(wifi.Install (wifiPhy, wifiMac, zone->get_ap_node()));
 406
 407       ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator> ();
 408       positionAllocS->Add(ns3::Vector(0, 0, 0));
 409       mobility.SetPositionAllocator(positionAllocS);
 410       mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
 411       mobility.Install(zone->get_ap_node());
 412
 413       ns3::Ipv4AddressHelper address;
 414       std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 415       address.SetBase(addr.c_str(), "255.255.0.0");
 416       XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
 417       interfaces.Add(address.Assign (netA));
 418       zone->set_network(number_of_networks);
 419       zone->set_link(number_of_links);
 420
 421       int nodeNum = netpoint_ns3->node_num;
 422       if (IPV4addr.size() <= (unsigned)nodeNum)
 423         IPV4addr.resize(nodeNum + 1);
 424       IPV4addr[nodeNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
 425
 426       if (number_of_links == 255){
 427         xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 428         number_of_links = 1;
 429         number_of_networks++;
 430       } else {
 431         number_of_links++;
 432       }
 433   }
 434   s4u::Link::on_creation(*this->get_iface());
 435 }
 436
 437 LinkNS3::~LinkNS3() = default;
 438
 439 void LinkNS3::apply_event(profile::Event*, double)
 440 {
 441   THROW_UNIMPLEMENTED;
 442 }
 443 void LinkNS3::set_bandwidth_profile(profile::Profile*)
 444 {
 445   xbt_die("The ns-3 network model doesn't support bandwidth profiles");
 446 }
 447 void LinkNS3::set_latency_profile(profile::Profile*)
 448 {
 449   xbt_die("The ns-3 network model doesn't support latency profiles");
 450 }
 451
 452 /**********
 453  * Action *
 454  **********/
 455
 456 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
 457     : NetworkAction(model, *src, *dst, totalBytes, false)
 458 {
 459   // If there is no other started actions, we need to move NS-3 forward to be sync with SimGrid
 460   if (model->get_started_action_set()->size()==1){
 461     while(double_positive(surf_get_clock() - ns3::Simulator::Now().GetSeconds(), sg_surf_precision)){
 462       XBT_DEBUG("Synchronizing NS-3 (time %f) with SimGrid (time %f)", ns3::Simulator::Now().GetSeconds(), surf_get_clock());
 463       ns3_simulator(surf_get_clock() - ns3::Simulator::Now().GetSeconds());
 464     }
 465   }
 466
 467   XBT_DEBUG("Communicate from %s to %s", src->get_cname(), dst->get_cname());
 468
 469   static int port_number = 1025; // Port number is limited from 1025 to 65 000
 470
 471   unsigned int node1 = src->get_netpoint()->extension<NetPointNs3>()->node_num;
 472   unsigned int node2 = dst->get_netpoint()->extension<NetPointNs3>()->node_num;
 473
 474   ns3::Ptr<ns3::Node> src_node = src->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
 475   ns3::Ptr<ns3::Node> dst_node = dst->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
 476
 477   xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
 478              dst->get_netpoint()->get_cname());
 479   std::string& addr = IPV4addr[node2];
 480   xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
 481              dst->get_netpoint()->get_cname());
 482
 483   XBT_DEBUG("ns3: Create flow of %.0f Bytes from %u to %u with Interface %s", totalBytes, node1, node2, addr.c_str());
 484   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
 485   ns3::ApplicationContainer apps = sink.Install(dst_node);
 486
 487   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
 488
 489   flow_from_sock.insert({transform_socket_ptr(sock), new SgFlow(totalBytes, this)});
 490   sink_from_sock.insert({transform_socket_ptr(sock), apps});
 491
 492   sock->Bind(ns3::InetSocketAddress(port_number));
 493
 494   ns3::Simulator::ScheduleNow(&start_flow, sock, addr.c_str(), port_number);
 495
 496   port_number++;
 497   if(port_number > 65000){
 498     port_number = 1025;
 499     XBT_WARN("Too many connections! Port number is saturated. Trying to use the oldest ports.");
 500   }
 501   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
 502
 503   s4u::Link::on_communicate(*this);
 504 }
 505
 506 void NetworkNS3Action::suspend() {
 507   THROW_UNIMPLEMENTED;
 508 }
 509
 510 void NetworkNS3Action::resume() {
 511   THROW_UNIMPLEMENTED;
 512 }
 513
 514 std::list<LinkImpl*> NetworkNS3Action::get_links() const
 515 {
 516   THROW_UNIMPLEMENTED;
 517 }
 518 void NetworkNS3Action::update_remains_lazy(double /*now*/)
 519 {
 520   THROW_IMPOSSIBLE;
 521 }
 522
 523 } // namespace resource
 524 } // namespace kernel
 525 } // namespace simgrid
 526
 527 void ns3_simulator(double maxSeconds)
 528 {
 529   ns3::EventId id;
 530   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
 531     id = ns3::Simulator::Schedule(ns3::Seconds(maxSeconds), &ns3::Simulator::Stop);
 532
 533   XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
 534   ns3::Simulator::Run ();
 535   XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds());
 536
 537   if(maxSeconds > 0.0)
 538     id.Cancel();
 539 }
 540
 541 // initialize the ns-3 interface and environment
 542 void ns3_initialize(std::string TcpProtocol)
 543 {
 544   //  tcpModel are:
 545   //  "ns3::TcpNewReno"
 546   //  "ns3::TcpReno"
 547   //  "ns3::TcpTahoe"
 548
 549   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
 550   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
 551   ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
 552
 553   if (TcpProtocol == "default") {
 554     /* nothing to do */
 555
 556   } else if (TcpProtocol == "Reno") {
 557     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 558     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
 559
 560   } else if (TcpProtocol == "NewReno") {
 561     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 562     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
 563
 564   } else if (TcpProtocol == "Tahoe") {
 565     XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
 566     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
 567
 568   } else {
 569     xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
 570   }
 571 }
 572
 573 void ns3_add_cluster(const char* /*id*/, double bw, double lat)
 574 {
 575   ns3::NodeContainer Nodes;
 576
 577   for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
 578     Nodes.Add(Cluster_nodes.Get(i));
 579     XBT_DEBUG("Add node %u to cluster", i);
 580   }
 581   number_of_clusters_nodes = Cluster_nodes.GetN();
 582
 583   XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
 584   Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
 585
 586   xbt_assert(Nodes.GetN() <= 65000, "Cluster with ns-3 is limited to 65000 nodes");
 587   ns3::CsmaHelper csma;
 588   csma.SetChannelAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
 589   csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 590   ns3::NetDeviceContainer devices = csma.Install(Nodes);
 591   XBT_DEBUG("Create CSMA");
 592
 593   std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 594   XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
 595   ns3::Ipv4AddressHelper ipv4;
 596   ipv4.SetBase(addr.c_str(), "255.255.0.0");
 597   interfaces.Add(ipv4.Assign (devices));
 598
 599   if(number_of_links == 255){
 600     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 601     number_of_links = 1;
 602     number_of_networks++;
 603   }else{
 604     number_of_links++;
 605   }
 606   XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
 607 }
 608
 609 static std::string transformIpv4Address(ns3::Ipv4Address from)
 610 {
 611   std::stringstream sstream;
 612   sstream << from ;
 613   return sstream.str();
 614 }
 615
 616 void ns3_add_direct_route(NetPointNs3* src, NetPointNs3* dst, double bw, double lat, std::string link_name,
 617                           simgrid::s4u::Link::SharingPolicy policy)
 618 {
 619   ns3::Ipv4AddressHelper address;
 620   ns3::NetDeviceContainer netA;
 621
 622   int srcNum = src->node_num;
 623   int dstNum = dst->node_num;
 624
 625   ns3::Ptr<ns3::Node> a = src->ns3_node_;
 626   ns3::Ptr<ns3::Node> b = dst->ns3_node_;
 627
 628   if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
 629       xbt_assert(WifiZone::is_ap(a) != WifiZone::is_ap(b), "A wifi route can only exist between an access point node and a station node.");
 630
 631       ns3::Ptr<ns3::Node> apNode = WifiZone::is_ap(a) ? a : b;
 632       ns3::Ptr<ns3::Node> staNode = apNode == a ? b : a;
 633
 634       WifiZone* zone = WifiZone::by_name(link_name);
 635
 636       wifiPhy.SetChannel (zone->get_channel());
 637
 638       wifiMac.SetType ("ns3::StaWifiMac");
 639       netA.Add(wifi.Install (wifiPhy, wifiMac, staNode));
 640
 641       ns3::Config::Set ("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue (40));
 642
 643       ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator> ();
 644       positionAllocS->Add(ns3::Vector(10, 0, 0));
 645       mobility.SetPositionAllocator(positionAllocS);
 646       mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
 647       mobility.Install(staNode);
 648
 649       std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", zone->get_network(), zone->get_link());
 650       address.SetBase(addr.c_str(), "255.255.0.0", ("0.0.0." + std::to_string(zone->get_n_sta_nodes() + 2)).c_str());
 651       zone->add_sta_node();
 652       XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
 653       interfaces.Add(address.Assign (netA));
 654       if (IPV4addr.size() <= (unsigned)dstNum)
 655         IPV4addr.resize(dstNum + 1);
 656       IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
 657   } else {
 658     ns3::PointToPointHelper pointToPoint;
 659     XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
 660     pointToPoint.SetDeviceAttribute("DataRate",
 661                                     ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
 662     pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
 663
 664     netA.Add(pointToPoint.Install(a, b));
 665
 666     std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
 667     address.SetBase(addr.c_str(), "255.255.0.0");
 668     XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
 669     interfaces.Add(address.Assign (netA));
 670
 671     if (IPV4addr.size() <= (unsigned)srcNum)
 672         IPV4addr.resize(srcNum + 1);
 673     IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
 674
 675     if (IPV4addr.size() <= (unsigned)dstNum)
 676         IPV4addr.resize(dstNum + 1);
 677     IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
 678
 679     if (number_of_links == 255){
 680         xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 681         number_of_links = 1;
 682         number_of_networks++;
 683     } else {
 684         number_of_links++;
 685     }
 686   }
 687 }