Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
moved a line for comprehension
[simgrid.git] / src / surf / network_ns3.cpp
index be6a65d..824a3bf 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2020. 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. */
@@ -20,6 +20,9 @@
 #include <ns3/application-container.h>
 #include <ns3/event-id.h>
 
+#include "ns3/wifi-module.h"
+#include "ns3/mobility-module.h"
+
 #include "network_ns3.hpp"
 #include "ns3/ns3_simulator.hpp"
 
@@ -35,6 +38,7 @@
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network ns-3 module");
 
 std::vector<std::string> IPV4addr;
+static std::string transformIpv4Address(ns3::Ipv4Address from);
 
 /*****************
  * Crude globals *
@@ -53,6 +57,13 @@ static int number_of_clusters_nodes = 0;
 static int number_of_links = 1;
 static int number_of_networks = 1;
 
+/* wifi globals */
+static ns3::WifiHelper wifi;
+static ns3::YansWifiPhyHelper wifiPhy = ns3::YansWifiPhyHelper::Default ();
+static ns3::YansWifiChannelHelper wifiChannel = ns3::YansWifiChannelHelper::Default ();
+static ns3::WifiMacHelper wifiMac;
+static ns3::MobilityHelper mobility;
+
 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
 
 NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject<ns3::Node>(0))
@@ -62,6 +73,48 @@ NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject<ns3::Node>(0))
   node_num = number_of_nodes++;
 }
 
+WifiZone::WifiZone(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;
+}
+
+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(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);
+    }
+}
+
 /*************
  * Callbacks *
  *************/
@@ -79,7 +132,7 @@ static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs con
     xbt_assert(host_src, "Cannot find a ns-3 host of name %s", host_id.c_str());
 
     // Any ns-3 route is symmetrical
-    ns3_add_link(host_src, host_dst, cluster.bw, cluster.lat);
+    ns3_add_direct_route(host_src, host_dst, cluster.bw, cluster.lat, cluster.id, cluster.sharing_policy);
 
     delete host_dst;
   }
@@ -89,14 +142,15 @@ static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs con
 }
 
 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
-                             simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
-                             simgrid::kernel::routing::NetPoint* gw_dst,
+                             simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* /*gw_src*/,
+                             simgrid::kernel::routing::NetPoint* /*gw_dst*/,
                              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]);
 
-    XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->get_cname(), dst->get_cname(), link->get_cname(),
+    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)"),
               (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
 
     //   XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
@@ -106,10 +160,13 @@ static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoin
     auto* host_src = src->extension<NetPointNs3>();
     auto* host_dst = dst->extension<NetPointNs3>();
 
+    host_src->set_name(src->get_name());
+    host_dst->set_name(dst->get_name());
+
     xbt_assert(host_src != nullptr, "Network element %s does not seem to be ns-3-ready", src->get_cname());
     xbt_assert(host_dst != nullptr, "Network element %s does not seem to be ns-3-ready", dst->get_cname());
 
-    ns3_add_link(host_src, host_dst, link->get_bandwidth(), link->get_latency());
+    ns3_add_direct_route(host_src, host_dst, link->get_bandwidth(), link->get_latency(), link->get_name(), link->get_sharing_policy());
   } else {
     static bool warned_about_long_routes = false;
 
@@ -128,7 +185,6 @@ static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoin
 static void postparse_cb()
 {
   IPV4addr.shrink_to_fit();
-
   ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
   ns3::GlobalRouteManager::InitializeRoutes();
 }
@@ -165,7 +221,7 @@ NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
     pt.extension_set<NetPointNs3>(new NetPointNs3());
     XBT_VERB("SimGrid's %s is known as node %d within ns-3", pt.get_cname(), pt.extension<NetPointNs3>()->node_num);
   });
-  surf::on_cluster.connect(&clusterCreation_cb);
+  routing::on_cluster_creation.connect(&clusterCreation_cb);
 
   s4u::Engine::on_platform_created.connect(&postparse_cb);
   s4u::NetZone::on_route_creation.connect(&routeCreation_cb);
@@ -176,10 +232,10 @@ NetworkNS3Model::~NetworkNS3Model() {
 }
 
 LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
-                                       s4u::Link::SharingPolicy)
+                                       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);
+  return new LinkNS3(this, name, bandwidths[0], latency, policy);
 }
 
 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
@@ -204,14 +260,14 @@ double NetworkNS3Model::next_occurring_event(double now)
     return -1.0;
 
   XBT_DEBUG("doing a ns3 simulation for a duration of %f", now);
-  ns3_simulator(now);  
+  ns3_simulator(now);
   time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
   // NS-3 stops as soon as a flow ends,
   // but it does not process the other flows that may finish at the same (simulated) time.
   // If another flow ends at the same time, time_to_next_flow_completion = 0
   if(double_equals(time_to_next_flow_completion, 0, sg_surf_precision))
-    time_to_next_flow_completion = 0.0; 
+    time_to_next_flow_completion = 0.0;
+
   XBT_DEBUG("min       : %f", now);
   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
   XBT_DEBUG("surf time : %f", surf_get_clock());
@@ -243,10 +299,10 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
 
       std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
 
-      action->src_->route_to(action->dst_, route, nullptr);
+      action->get_src().route_to(&action->get_dst(), route, nullptr);
       for (auto const& link : route)
-        TRACE_surf_resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(),
-                                            (data_delta_sent) / delta, now - delta, delta);
+        instr::resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(),
+                                        (data_delta_sent) / delta, now - delta, delta);
 
       action->last_sent_ = sgFlow->sent_bytes_;
     }
@@ -255,7 +311,7 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
       socket_to_destroy.push_back(ns3_socket);
       XBT_DEBUG("Destroy socket %p of action %p", ns3_socket.c_str(), action);
       action->set_remains(0);
-      action->finish(kernel::resource::Action::State::FINISHED);
+      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_,
                 sgFlow->total_bytes_, sgFlow->remaining_);
@@ -279,13 +335,67 @@ void NetworkNS3Model::update_actions_state(double now, double delta)
  * Resource *
  ************/
 
-LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency)
+LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency,
+                 s4u::Link::SharingPolicy policy)
     : LinkImpl(model, name, nullptr)
 {
   bandwidth_.peak = bandwidth;
   latency_.peak   = latency;
-
-  s4u::Link::on_creation(this->piface_);
+  sharing_policy_ = policy;
+
+  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());
+
+      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());
+      interfaces.Add(address.Assign (netA));
+      zone->set_network(number_of_networks);
+      zone->set_link(number_of_links);
+
+      NetPointNs3* netpoint_ns3 = zone->get_host()->get_netpoint()->extension<NetPointNs3>(); 
+      int nodeNum = netpoint_ns3->node_num;
+      if (IPV4addr.size() <= (unsigned)nodeNum)
+        IPV4addr.resize(nodeNum + 1);
+      IPV4addr[nodeNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 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;
@@ -308,9 +418,8 @@ void LinkNS3::set_latency_profile(profile::Profile*)
  **********/
 
 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
-    : NetworkAction(model, totalBytes, false), src_(src), dst_(dst)
+    : NetworkAction(model, *src, *dst, totalBytes, false)
 {
-  
   // 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)){
@@ -355,7 +464,7 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s
   }
   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
 
-  s4u::Link::on_communicate(*this, src, dst);
+  s4u::Link::on_communicate(*this);
 }
 
 void NetworkNS3Action::suspend() {
@@ -366,7 +475,7 @@ void NetworkNS3Action::resume() {
   THROW_UNIMPLEMENTED;
 }
 
-std::list<LinkImpl*> NetworkNS3Action::links() const
+std::list<LinkImpl*> NetworkNS3Action::get_links() const
 {
   THROW_UNIMPLEMENTED;
 }
@@ -381,7 +490,7 @@ void NetworkNS3Action::update_remains_lazy(double /*now*/)
 
 void ns3_simulator(double maxSeconds)
 {
-  ns3::EventId id; 
+  ns3::EventId id;
   if (maxSeconds > 0.0) // If there is a maximum amount of time to run
     id = ns3::Simulator::Schedule(ns3::Seconds(maxSeconds), &ns3::Simulator::Stop);
 
@@ -425,7 +534,8 @@ void ns3_initialize(std::string TcpProtocol)
   }
 }
 
-void ns3_add_cluster(const char* id, double bw, double lat) {
+void ns3_add_cluster(const char* /*id*/, double bw, double lat)
+{
   ns3::NodeContainer Nodes;
 
   for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
@@ -467,10 +577,11 @@ static std::string transformIpv4Address(ns3::Ipv4Address from)
   return sstream.str();
 }
 
-void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
-  ns3::PointToPointHelper pointToPoint;
-
+void ns3_add_direct_route(NetPointNs3* src, NetPointNs3* dst, double bw, double lat, std::string link_name,
+                          simgrid::s4u::Link::SharingPolicy policy)
+{
   ns3::Ipv4AddressHelper address;
+  ns3::NetDeviceContainer netA;
 
   int srcNum = src->node_num;
   int dstNum = dst->node_num;
@@ -478,32 +589,75 @@ void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
   ns3::Ptr<ns3::Node> a = src->ns3_node_;
   ns3::Ptr<ns3::Node> b = dst->ns3_node_;
 
-  XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
-  pointToPoint.SetDeviceAttribute("DataRate",
-                                  ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
-  pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
+  if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
+      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::NetDeviceContainer netA;
-  netA.Add(pointToPoint.Install (a, b));
+      ns3::Ptr<ns3::Node> apNode = WifiZone::is_ap(a) ? a : b;
+      ns3::Ptr<ns3::Node> staNode = apNode == a ? b : a;
 
-  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());
-  interfaces.Add(address.Assign (netA));
+      WifiZone* zone = WifiZone::by_name(link_name);
 
-  if (IPV4addr.size() <= (unsigned)srcNum)
-    IPV4addr.resize(srcNum + 1);
-  IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
+      wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager",
+                                    "ControlMode", ns3::StringValue ("HtMcs0"),
+                                    "DataMode", ns3::StringValue ("HtMcs" + std::to_string(zone->get_mcs())));
 
-  if (IPV4addr.size() <= (unsigned)dstNum)
-    IPV4addr.resize(dstNum + 1);
-  IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
+      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()));
 
-  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++;
+      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));
+
+      NetPointNs3* sta_netpointNs3 = WifiZone::is_ap(src->ns3_node_) ? dst : src;
+      const char* wifi_distance = simgrid::s4u::Host::by_name(sta_netpointNs3->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());
+      interfaces.Add(address.Assign (netA));
+      if (IPV4addr.size() <= (unsigned)dstNum)
+        IPV4addr.resize(dstNum + 1);
+      IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
   } else {
-    number_of_links++;
+    ns3::PointToPointHelper pointToPoint;
+    XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
+    pointToPoint.SetDeviceAttribute("DataRate",
+                                    ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
+    pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
+
+    netA.Add(pointToPoint.Install(a, b));
+
+    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());
+    interfaces.Add(address.Assign (netA));
+
+    if (IPV4addr.size() <= (unsigned)srcNum)
+        IPV4addr.resize(srcNum + 1);
+    IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
+
+    if (IPV4addr.size() <= (unsigned)dstNum)
+        IPV4addr.resize(dstNum + 1);
+    IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 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++;
+    }
   }
 }