Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use new name for wifi standard in recent NS3.
[simgrid.git] / src / surf / network_ns3.cpp
index b6835cd..bc81977 100644 (file)
@@ -7,6 +7,7 @@
 #include <unordered_set>
 
 #include "xbt/config.hpp"
+#include "xbt/str.h"
 #include "xbt/string.hpp"
 #include "xbt/utility.hpp"
 
@@ -27,6 +28,7 @@
 #include "ns3/ns3_simulator.hpp"
 
 #include "simgrid/kernel/routing/NetPoint.hpp"
+#include "simgrid/kernel/routing/WifiZone.hpp"
 #include "simgrid/plugins/energy.h"
 #include "simgrid/s4u/Engine.hpp"
 #include "simgrid/s4u/NetZone.hpp"
@@ -70,60 +72,92 @@ 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_)
-{
-  n_sta_nodes       = 0;
-  wifi_zones[name_] = this;
-}
+/*************
+ * Callbacks *
+ *************/
 
-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;
-}
+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;
+    wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
+                                 "ControlMode", ns3::StringValue("HtMcs0"),
+                                 "DataMode", ns3::StringValue("HtMcs" + std::to_string(mcs_value)));
+    wifiPhy.SetChannel(wifiChannel.Create());
+    wifiPhy.Set("Antennas", ns3::UintegerValue(nss_value));
+    wifiPhy.Set("MaxSupportedTxSpatialStreams", ns3::UintegerValue(nss_value));
+    wifiPhy.Set("MaxSupportedRxSpatialStreams", ns3::UintegerValue(nss_value));
+    wifiMac.SetType("ns3::ApWifiMac",
+                    "Ssid", ns3::SsidValue(ssid));
 
-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;
-}
+    mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
+    ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator>();
+    positionAllocS->Add(ns3::Vector(0, 0, 255 * 100 * number_of_networks + 100 * number_of_links));
 
-std::unordered_map<std::string, WifiZone*> WifiZone::wifi_zones;
+    ns3::NetDeviceContainer netDevices;
+    NetPointNs3* access_point_netpoint_ns3 = wifizone->get_access_point()->extension<NetPointNs3>();
 
-static void initialize_ns3_wifi()
-{
-  wifi.SetStandard(ns3::WIFI_PHY_STANDARD_80211n_5GHZ);
+    ns3::Ptr<ns3::Node> access_point_ns3_node = access_point_netpoint_ns3->ns3_node_;
+    ns3::NodeContainer nodes = {access_point_ns3_node};
+    std::vector<NetPointNs3*> hosts_netpoints = {access_point_netpoint_ns3};
+    netDevices.Add(wifi.Install(wifiPhy, wifiMac,access_point_ns3_node));
 
-  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");
+    wifiMac.SetType ("ns3::StaWifiMac",
+                     "Ssid", ns3::SsidValue(ssid),
+                     "ActiveProbing", ns3::BooleanValue(false));
 
-    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);
-  }
-}
+    NetPointNs3* station_netpoint_ns3 = nullptr;
+    ns3::Ptr<ns3::Node> station_ns3_node = nullptr;
+    double distance;
+    double angle = 0;
+    int nb_stations = wifizone->get_all_hosts().size() - 1;
+    double step = 2 * M_PI / nb_stations;
+    for (auto station_host : wifizone->get_all_hosts()) {
+        station_netpoint_ns3 = station_host->get_netpoint()->extension<NetPointNs3>();
+        if (station_netpoint_ns3 == access_point_netpoint_ns3)
+            continue;
+        hosts_netpoints.push_back(station_netpoint_ns3);
+        distance = station_host->get_property("wifi_distance") ? atof(station_host->get_property("wifi_distance")) : 10.0;
+        positionAllocS->Add(ns3::Vector(distance * std::cos(angle), distance * std::sin(angle), 255 * 100 * number_of_networks + 100 * number_of_links));
+        angle += step;
+        station_ns3_node = station_netpoint_ns3->ns3_node_;
+        nodes.Add(station_ns3_node);
+        netDevices.Add(wifi.Install(wifiPhy, wifiMac, station_ns3_node));
+    }
 
-/*************
- * Callbacks *
- *************/
+    ns3::Config::Set("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue(40));
+
+    mobility.SetPositionAllocator(positionAllocS);
+    mobility.Install(nodes);
+
+    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());
+    ns3::Ipv4InterfaceContainer addresses = address.Assign(netDevices);
+    for (int i = 0; i < hosts_netpoints.size(); i++) {
+        hosts_netpoints[i]->ipv4_address_ = transformIpv4Address(addresses.GetAddress(i));
+    }
+
+    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++;
+    }
+}
 
 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
 {
@@ -174,7 +208,7 @@ static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoin
                              std::vector<simgrid::kernel::resource::LinkImpl*> const& link_list)
 {
   if (link_list.size() == 1) {
-    auto* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
+    auto const* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
 
     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s %s", src->get_cname(), dst->get_cname(), link->get_cname(),
               (link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI ? "(wifi)" : "(wired)"),
@@ -210,7 +244,24 @@ void surf_network_model_init_NS3()
 }
 
 static simgrid::config::Flag<std::string>
-    ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be : NewReno or Reno or Tahoe", "default");
+    ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be: NewReno or Reno or Tahoe", "default");
+static simgrid::config::Flag<std::string> ns3_seed(
+    "ns3/seed",
+    "The random seed provided to ns-3. Either 'time' to seed with time(), blank to not set (default), or a number.", "",
+    [](std::string val) {
+      if (val.length() == 0)
+        return;
+      if (strcasecmp(val.c_str(), "time") == 0) {
+        std::srand(time(NULL));
+        ns3::RngSeedManager::SetSeed(std::rand());
+        ns3::RngSeedManager::SetRun(std::rand());
+      } else {
+        int v = xbt_str_parse_int(
+            val.c_str(), "Invalid value for option ns3/seed. It must be either 'time', a number, or left empty.");
+        ns3::RngSeedManager::SetSeed(v);
+        ns3::RngSeedManager::SetRun(v);
+      }
+    });
 
 namespace simgrid {
 namespace kernel {
@@ -253,6 +304,7 @@ NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
   });
   routing::on_cluster_creation.connect(&clusterCreation_cb);
   s4u::NetZone::on_route_creation.connect(&routeCreation_cb);
+  s4u::NetZone::on_seal.connect(&zoneCreation_cb);
 }
 
 LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
@@ -309,7 +361,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.
@@ -331,13 +383,13 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
       action->last_sent_ = sgFlow->sent_bytes_;
     }
 
-    if(sgFlow->finished_){
+    if ((sgFlow->finished_) && (remains <= 0)) { // finished_ should not become true before remains gets to 0, but it sometimes does. Let's play safe, here.
       socket_to_destroy.push_back(ns3_socket);
-      XBT_DEBUG("Destroy socket %p of action %p", ns3_socket.c_str(), action);
+      XBT_DEBUG("Destroy socket %s of action %p", ns3_socket.c_str(), action);
       action->set_remains(0);
       action->finish(Action::State::FINISHED);
     } else {
-      XBT_DEBUG("Socket %p sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
+      XBT_DEBUG("Socket %s sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
                 sgFlow->total_bytes_, sgFlow->remaining_);
     }
   }
@@ -347,7 +399,7 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
     socket_to_destroy.pop_back();
     SgFlow* flow = flow_from_sock.at(ns3_socket);
     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
-      XBT_DEBUG("Removing socket %p of action %p", ns3_socket.c_str(), flow->action_);
+      XBT_DEBUG("Removing socket %s of action %p", ns3_socket.c_str(), flow->action_);
     }
     delete flow;
     flow_from_sock.erase(ns3_socket);
@@ -366,57 +418,6 @@ LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwid
   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 != 0, "Link name '%s' does not match the 'wifi_link' property of a host.", name.c_str());
-    NetPointNs3* 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());
 }
 
@@ -442,6 +443,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)){
@@ -450,9 +465,7 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
     }
   }
 
-  XBT_DEBUG("Communicate from %s to %s", src->get_cname(), dst->get_cname());
-
-  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_;
@@ -461,25 +474,23 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
   xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
              dst->get_netpoint()->get_cname());
 
-  XBT_DEBUG("ns3: Create flow of %.0f Bytes from %s to %s with Interface %s", totalBytes, src->get_cname(),
-            dst->get_cname(), addr.c_str());
   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
   ns3::ApplicationContainer apps = sink.Install(dst_node);
 
   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
 
+  XBT_DEBUG("Create socket %s for a flow of %.0f Bytes from %s to %s with Interface %s",
+            transform_socket_ptr(sock).c_str(), totalBytes, src->get_cname(), dst->get_cname(), addr.c_str());
+
   flow_from_sock.insert({transform_socket_ptr(sock), new SgFlow(totalBytes, this)});
   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);
 }
@@ -533,46 +544,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;
 
@@ -586,6 +558,7 @@ void ns3_add_direct_route(simgrid::kernel::routing::NetPoint* src, simgrid::kern
     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);
 
     host_src->ipv4_address_ = transformIpv4Address(addresses.GetAddress(0));