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