Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove constraint from LinkImpl ctor
[simgrid.git] / src / surf / network_ns3.cpp
index ba00493..569b6c6 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2021. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 #include "src/surf/xml/platf_private.hpp"
 #include "surf/surf.hpp"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network ns-3 module");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_ns3, res_network, "Network model based on ns-3");
 
 /*****************
  * Crude globals *
  *****************/
 
-extern std::map<std::string, SgFlow*> flow_from_sock;
-extern std::map<std::string, ns3::ApplicationContainer> sink_from_sock;
+extern std::map<std::string, SgFlow*, std::less<>> flow_from_sock;
+extern std::map<std::string, ns3::ApplicationContainer, std::less<>> sink_from_sock;
 
 static ns3::InternetStackHelper stack;
 
@@ -53,7 +53,11 @@ static int number_of_networks = 1;
 
 /* wifi globals */
 static ns3::WifiHelper wifi;
-static ns3::YansWifiPhyHelper wifiPhy         = ns3::YansWifiPhyHelper::Default();
+#if NS3_MINOR_VERSION < 33
+static ns3::YansWifiPhyHelper wifiPhy = ns3::YansWifiPhyHelper::Default();
+#else
+static ns3::YansWifiPhyHelper wifiPhy;
+#endif
 static ns3::YansWifiChannelHelper wifiChannel = ns3::YansWifiChannelHelper::Default();
 static ns3::WifiMacHelper wifiMac;
 static ns3::MobilityHelper mobility;
@@ -72,55 +76,9 @@ NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject<ns3::Node>(0))
   stack.Install(ns3_node_);
 }
 
-WifiZone::WifiZone(const std::string& name_, simgrid::s4u::Host* host_, ns3::Ptr<ns3::Node> ap_node_,
-                   ns3::Ptr<ns3::YansWifiChannel> channel_, int mcs_, int nss_, int network_, int link_)
-    : name(name_)
-    , host(host_)
-    , ap_node(ap_node_)
-    , channel(channel_)
-    , mcs(mcs_)
-    , nss(nss_)
-    , network(network_)
-    , link(link_)
+static void resumeWifiDevice(ns3::Ptr<ns3::WifiNetDevice> device)
 {
-  n_sta_nodes       = 0;
-  wifi_zones[name_] = this;
-}
-
-bool WifiZone::is_ap(ns3::Ptr<ns3::Node> node)
-{
-  for (std::pair<std::string, WifiZone*> zone : wifi_zones)
-    if (zone.second->get_ap_node() == node)
-      return true;
-  return false;
-}
-
-WifiZone* WifiZone::by_name(const std::string& name)
-{
-  WifiZone* zone;
-  try {
-    zone = wifi_zones.at(name);
-  } catch (const std::out_of_range& oor) {
-    return nullptr;
-  }
-  return zone;
-}
-
-std::unordered_map<std::string, WifiZone*> WifiZone::wifi_zones;
-
-static void initialize_ns3_wifi()
-{
-  wifi.SetStandard(ns3::WIFI_PHY_STANDARD_80211n_5GHZ);
-
-  for (auto host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
-    const char* wifi_link = host->get_property("wifi_link");
-    const char* wifi_mcs  = host->get_property("wifi_mcs");
-    const char* wifi_nss  = host->get_property("wifi_nss");
-
-    if (wifi_link)
-      new WifiZone(wifi_link, host, host->get_netpoint()->extension<NetPointNs3>()->ns3_node_, wifiChannel.Create(),
-                   wifi_mcs ? atoi(wifi_mcs) : 3, wifi_nss ? atoi(wifi_nss) : 1, 0, 0);
-  }
+  device->GetPhy()->ResumeFromOff();
 }
 
 /*************
@@ -131,13 +89,21 @@ static void zoneCreation_cb(simgrid::s4u::NetZone const& zone) {
     simgrid::kernel::routing::WifiZone* wifizone = dynamic_cast<simgrid::kernel::routing::WifiZone*> (zone.get_impl());
     if (wifizone == nullptr) return;
 
+#if NS3_MINOR_VERSION < 32
     wifi.SetStandard(ns3::WIFI_PHY_STANDARD_80211n_5GHZ);
+#else
+    wifi.SetStandard(ns3::WIFI_STANDARD_80211n_5GHZ);
+#endif
 
     std::string ssid = wifizone->get_name();
     const char* mcs = wifizone->get_property("mcs");
     const char* nss = wifizone->get_property("nss");
     int mcs_value = mcs ? atoi(mcs) : 3;
     int nss_value = nss ? atoi(nss) : 1;
+#if NS3_MINOR_VERSION < 30
+    if(nss_value != 1+(mcs_value/8))
+      xbt_die("On NS3 < 3.30, NSS value has to satisfy NSS == 1+(MCS/8) constraint. Bailing out");
+#endif
     wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
                                  "ControlMode", ns3::StringValue("HtMcs0"),
                                  "DataMode", ns3::StringValue("HtMcs" + std::to_string(mcs_value)));
@@ -183,6 +149,14 @@ static void zoneCreation_cb(simgrid::s4u::NetZone const& zone) {
         netDevices.Add(wifi.Install(wifiPhy, wifiMac, station_ns3_node));
     }
 
+    const char* start_time = wifizone->get_property("start_time");
+    int start_time_value = start_time ? atoi(start_time) : 0;
+    for (uint32_t i = 0; i < netDevices.GetN(); i++) {
+      ns3::Ptr<ns3::WifiNetDevice> device = ns3::StaticCast<ns3::WifiNetDevice>(netDevices.Get(i));
+      device->GetPhy()->SetOffMode();
+      ns3::Simulator::Schedule(ns3::Seconds(start_time_value), &resumeWifiDevice, device);
+    }
+
     ns3::Config::Set("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue(40));
 
     mobility.SetPositionAllocator(positionAllocS);
@@ -193,7 +167,7 @@ static void zoneCreation_cb(simgrid::s4u::NetZone const& zone) {
     address.SetBase(addr.c_str(), "255.255.0.0");
     XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
     ns3::Ipv4InterfaceContainer addresses = address.Assign(netDevices);
-    for (int i = 0; i < hosts_netpoints.size(); i++) {
+    for (unsigned int i = 0; i < hosts_netpoints.size(); i++) {
         hosts_netpoints[i]->ipv4_address_ = transformIpv4Address(addresses.GetAddress(i));
     }
 
@@ -354,11 +328,11 @@ NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
   s4u::NetZone::on_seal.connect(&zoneCreation_cb);
 }
 
-LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
+LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths,
                                        s4u::Link::SharingPolicy policy)
 {
   xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
-  return new LinkNS3(this, name, bandwidths[0], latency, policy);
+  return new LinkNS3(name, bandwidths[0], policy);
 }
 
 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
@@ -408,7 +382,7 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
     ns3_socket                = elm.first;
     SgFlow* sgFlow            = elm.second;
     NetworkNS3Action * action = sgFlow->action_;
-    XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
+    XBT_DEBUG("Processing flow %p (socket %s, action %p)", sgFlow, ns3_socket.c_str(), action);
     // Because NS3 stops as soon as a flow is finished, the other flows that ends at the same time may remains in an
     // inconsistent state (i.e. remains_ == 0 but finished_ == false).
     // However, SimGrid considers sometimes that an action with remains_ == 0 is finished.
@@ -445,7 +419,7 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
     ns3_socket = socket_to_destroy.back();
     socket_to_destroy.pop_back();
     SgFlow* flow = flow_from_sock.at(ns3_socket);
-    if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
+    if (XBT_LOG_ISENABLED(res_ns3, xbt_log_priority_debug)) {
       XBT_DEBUG("Removing socket %s of action %p", ns3_socket.c_str(), flow->action_);
     }
     delete flow;
@@ -458,65 +432,10 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
  * Resource *
  ************/
 
-LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency,
-                 s4u::Link::SharingPolicy policy)
-    : LinkImpl(model, name, nullptr), sharing_policy_(policy)
+LinkNS3::LinkNS3(const std::string& name, double bandwidth, s4u::Link::SharingPolicy policy)
+    : LinkImpl(name), sharing_policy_(policy)
 {
   bandwidth_.peak = bandwidth;
-  latency_.peak   = latency;
-
-  /* If wifi, create the wifizone now. If not, don't do anything: the links will be created in routeCreate_cb */
-
-  if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
-    static bool wifi_init = false;
-    if (!wifi_init) {
-      initialize_ns3_wifi();
-      wifi_init = true;
-    }
-
-    ns3::NetDeviceContainer netA;
-    WifiZone* zone = WifiZone::by_name(name);
-    xbt_assert(zone != nullptr, "Link name '%s' does not match the 'wifi_link' property of a host.", name.c_str());
-    auto* netpoint_ns3 = zone->get_host()->get_netpoint()->extension<NetPointNs3>();
-
-    wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager", "ControlMode", ns3::StringValue("HtMcs0"), "DataMode",
-                                 ns3::StringValue("HtMcs" + std::to_string(zone->get_mcs())));
-
-    wifiPhy.SetChannel(zone->get_channel());
-    wifiPhy.Set("Antennas", ns3::UintegerValue(zone->get_nss()));
-    wifiPhy.Set("MaxSupportedTxSpatialStreams", ns3::UintegerValue(zone->get_nss()));
-    wifiPhy.Set("MaxSupportedRxSpatialStreams", ns3::UintegerValue(zone->get_nss()));
-
-    wifiMac.SetType("ns3::ApWifiMac",
-                    "Ssid", ns3::SsidValue(name));
-
-    netA.Add(wifi.Install(wifiPhy, wifiMac, zone->get_ap_node()));
-
-    ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator>();
-    positionAllocS->Add(ns3::Vector(0, 0, 0));
-    mobility.SetPositionAllocator(positionAllocS);
-    mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
-    mobility.Install(zone->get_ap_node());
-
-    ns3::Ipv4AddressHelper address;
-    std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
-    address.SetBase(addr.c_str(), "255.255.0.0");
-    XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
-    auto addresses = address.Assign(netA);
-    zone->set_network(number_of_networks);
-    zone->set_link(number_of_links);
-
-    netpoint_ns3->ipv4_address_ = transformIpv4Address(addresses.GetAddress(1));
-
-    if (number_of_links == 255) {
-      xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
-      number_of_links = 1;
-      number_of_networks++;
-    } else {
-      number_of_links++;
-    }
-  }
-  s4u::Link::on_creation(*this->get_iface());
 }
 
 LinkNS3::~LinkNS3() = default;
@@ -541,6 +460,20 @@ void LinkNS3::set_latency_profile(profile::Profile*)
 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
     : NetworkAction(model, *src, *dst, totalBytes, false)
 {
+  // ns-3 fails when src = dst, so avoid the problem by considering that communications are infinitely fast on the
+  // loopback that does not exists
+  if (src == dst) {
+    static bool warned = false;
+    if (not warned) {
+      XBT_WARN("Sending from a host %s to itself is not supported by ns-3. Every such communication finishes "
+               "immediately upon startup.",
+               src->get_cname());
+      warned = true;
+    }
+    finish(Action::State::FINISHED);
+    return;
+  }
+
   // If there is no other started actions, we need to move NS-3 forward to be sync with SimGrid
   if (model->get_started_action_set()->size()==1){
     while(double_positive(surf_get_clock() - ns3::Simulator::Now().GetSeconds(), sg_surf_precision)){
@@ -549,7 +482,7 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
     }
   }
 
-  static int port_number = 1025; // Port number is limited from 1025 to 65 000
+  static uint16_t port_number = 1;
 
   ns3::Ptr<ns3::Node> src_node = src->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
   ns3::Ptr<ns3::Node> dst_node = dst->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
@@ -570,14 +503,11 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
   sink_from_sock.insert({transform_socket_ptr(sock), apps});
 
   sock->Bind(ns3::InetSocketAddress(port_number));
-
   ns3::Simulator::ScheduleNow(&start_flow, sock, addr.c_str(), port_number);
 
-  port_number++;
-  if(port_number > 65000){
-    port_number = 1025;
+  port_number = 1 + (port_number % UINT16_MAX);
+  if (port_number == 1)
     XBT_WARN("Too many connections! Port number is saturated. Trying to use the oldest ports.");
-  }
 
   s4u::Link::on_communicate(*this);
 }
@@ -631,46 +561,7 @@ void ns3_add_direct_route(simgrid::kernel::routing::NetPoint* src, simgrid::kern
   xbt_assert(host_dst != nullptr, "Network element %s does not seem to be ns-3-ready", dst->get_cname());
 
   if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
-    auto a = host_src->ns3_node_;
-    auto b = host_dst->ns3_node_;
-    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.");
-
-    ns3::Ptr<ns3::Node> apNode  = WifiZone::is_ap(a) ? a : b;
-    ns3::Ptr<ns3::Node> staNode = apNode == a ? b : a;
-
-    WifiZone* zone = WifiZone::by_name(link_name);
-
-    wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager", "ControlMode", ns3::StringValue("HtMcs0"), "DataMode",
-                                 ns3::StringValue("HtMcs" + std::to_string(zone->get_mcs())));
-
-    wifiPhy.SetChannel(zone->get_channel());
-    wifiPhy.Set("Antennas", ns3::UintegerValue(zone->get_nss()));
-    wifiPhy.Set("MaxSupportedTxSpatialStreams", ns3::UintegerValue(zone->get_nss()));
-    wifiPhy.Set("MaxSupportedRxSpatialStreams", ns3::UintegerValue(zone->get_nss()));
-
-    wifiMac.SetType ("ns3::StaWifiMac",
-                     "Ssid", ns3::SsidValue(link_name),
-                     "ActiveProbing", ns3::BooleanValue(false));
-
-    netA.Add(wifi.Install(wifiPhy, wifiMac, staNode));
-
-    ns3::Config::Set("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue(40));
-
-    simgrid::kernel::routing::NetPoint* sta_netpoint = WifiZone::is_ap(host_src->ns3_node_) ? dst : src;
-    const char* wifi_distance    = simgrid::s4u::Host::by_name(sta_netpoint->get_name())->get_property("wifi_distance");
-    ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator>();
-    positionAllocS->Add(ns3::Vector(wifi_distance ? atof(wifi_distance) : 10.0, 0, 0));
-    mobility.SetPositionAllocator(positionAllocS);
-    mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
-    mobility.Install(staNode);
-
-    std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", zone->get_network(), zone->get_link());
-    address.SetBase(addr.c_str(), "255.255.0.0", ("0.0.0." + std::to_string(zone->get_n_sta_nodes() + 2)).c_str());
-    zone->add_sta_node();
-    XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
-    auto addresses          = address.Assign(netA);
-    host_dst->ipv4_address_ = transformIpv4Address(addresses.GetAddress(1));
+      xbt_die("The wifi sharing policy is not supported for links. You want to use a wifi zone (see documentation).");
   } else {
     ns3::PointToPointHelper pointToPoint;