X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/534039d7635bc420c005444981b32e4bcd42ed77..e22da6010c6499813ff88c76041cf499ffbf2b67:/src/surf/network_ns3.cpp diff --git a/src/surf/network_ns3.cpp b/src/surf/network_ns3.cpp index c5e05259f3..8ba3f2ea52 100644 --- a/src/surf/network_ns3.cpp +++ b/src/surf/network_ns3.cpp @@ -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. */ @@ -11,15 +11,15 @@ #include "xbt/string.hpp" #include "xbt/utility.hpp" +#include #include #include +#include #include #include #include #include #include -#include -#include #include "ns3/mobility-module.h" #include "ns3/wifi-module.h" @@ -28,31 +28,37 @@ #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" #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals +#include "src/kernel/EngineImpl.hpp" #include "src/surf/surf_interface.hpp" #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 flow_from_sock; -extern std::map sink_from_sock; +extern std::map> flow_from_sock; +extern std::map> sink_from_sock; static ns3::InternetStackHelper stack; -static int number_of_links = 1; +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(); +#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; @@ -71,61 +77,109 @@ NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject(0)) stack.Install(ns3_node_); } -WifiZone::WifiZone(const std::string& name_, simgrid::s4u::Host* host_, ns3::Ptr ap_node_, - ns3::Ptr 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 device) { - n_sta_nodes = 0; - wifi_zones[name_] = this; + device->GetPhy()->ResumeFromOff(); } -bool WifiZone::is_ap(ns3::Ptr node) -{ - for (std::pair zone : wifi_zones) - if (zone.second->get_ap_node() == node) - return true; - return false; -} +/************* + * Callbacks * + *************/ -WifiZone* WifiZone::by_name(const std::string& name) +static void zoneCreation_cb(simgrid::s4u::NetZone const& zone) { - WifiZone* zone; - try { - zone = wifi_zones.at(name); - } catch (const std::out_of_range& oor) { - return nullptr; + simgrid::kernel::routing::WifiZone* wifizone = dynamic_cast(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))); + 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)); + + mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel"); + ns3::Ptr positionAllocS = ns3::CreateObject(); + positionAllocS->Add(ns3::Vector(0, 0, 255 * 100 * number_of_networks + 100 * number_of_links)); + + ns3::NetDeviceContainer netDevices; + NetPointNs3* access_point_netpoint_ns3 = wifizone->get_access_point()->extension(); + + ns3::Ptr access_point_ns3_node = access_point_netpoint_ns3->ns3_node_; + ns3::NodeContainer nodes = {access_point_ns3_node}; + std::vector hosts_netpoints = {access_point_netpoint_ns3}; + netDevices.Add(wifi.Install(wifiPhy, wifiMac, access_point_ns3_node)); + + wifiMac.SetType("ns3::StaWifiMac", "Ssid", ns3::SsidValue(ssid), "ActiveProbing", ns3::BooleanValue(false)); + + NetPointNs3* station_netpoint_ns3 = nullptr; + ns3::Ptr 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(); + 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)); } - return zone; -} -std::unordered_map WifiZone::wifi_zones; + 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 device = ns3::StaticCast(netDevices.Get(i)); + device->GetPhy()->SetOffMode(); + ns3::Simulator::Schedule(ns3::Seconds(start_time_value), &resumeWifiDevice, device); + } -static void initialize_ns3_wifi() -{ - wifi.SetStandard(ns3::WIFI_PHY_STANDARD_80211n_5GHZ); + ns3::Config::Set("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue(40)); - 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"); + 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 (unsigned int i = 0; i < hosts_netpoints.size(); i++) { + hosts_netpoints[i]->ipv4_address_ = transformIpv4Address(addresses.GetAddress(i)); + } - if (wifi_link) - new WifiZone(wifi_link, host, host->get_netpoint()->extension()->ns3_node_, wifiChannel.Create(), - wifi_mcs ? atoi(wifi_mcs) : 3, wifi_nss ? atoi(wifi_nss) : 1, 0, 0); + 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++; } } -/************* - * Callbacks * - *************/ - static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster) { ns3::NodeContainer Nodes; @@ -205,9 +259,9 @@ static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoin *********/ void surf_network_model_init_NS3() { - xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice"); - - surf_network_model = new simgrid::kernel::resource::NetworkNS3Model(); + auto net_model = std::make_unique(); + simgrid::kernel::EngineImpl::get_instance()->add_model(simgrid::kernel::resource::Model::Type::NETWORK, + std::move(net_model), true); } static simgrid::config::Flag @@ -239,8 +293,6 @@ NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL) xbt_assert(not sg_link_energy_is_inited(), "LinkEnergy plugin and ns-3 network models are not compatible. Are you looking for Ecofen, maybe?"); - all_existing_models.push_back(this); - NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create(); ns3::Config::SetDefault("ns3::TcpSocket::SegmentSize", ns3::UintegerValue(1000)); @@ -271,13 +323,16 @@ 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& bandwidths, double latency, +LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector& 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); + auto link = new LinkNS3(name, bandwidths[0], policy); + link->set_model(this); + return link; } Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) @@ -293,7 +348,7 @@ double NetworkNS3Model::next_occurring_event(double now) double time_to_next_flow_completion = 0.0; XBT_DEBUG("ns3_next_occurring_event"); - //get the first relevant value from the running_actions list + // get the first relevant value from the running_actions list // If there is no comms in NS-3, then we do not move it forward. // We will synchronize NS-3 with SimGrid when starting a new communication. @@ -307,7 +362,7 @@ double NetworkNS3Model::next_occurring_event(double now) // 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)) + if (double_equals(time_to_next_flow_completion, 0, sg_surf_precision)) time_to_next_flow_completion = 0.0; XBT_DEBUG("min : %f", now); @@ -324,16 +379,16 @@ void NetworkNS3Model::update_actions_state(double now, double delta) std::string ns3_socket; for (const auto& elm : flow_from_sock) { - ns3_socket = elm.first; - SgFlow* sgFlow = elm.second; - NetworkNS3Action * action = sgFlow->action_; + ns3_socket = elm.first; + SgFlow* sgFlow = elm.second; + NetworkNS3Action* action = 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. // Thus, to avoid inconsistencies between SimGrid and NS3, set remains to 0 only when the flow is finished in NS3 int remains = action->get_cost() - sgFlow->sent_bytes_; - if(remains > 0) + if (remains > 0) action->set_remains(remains); if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) { @@ -349,7 +404,8 @@ void NetworkNS3Model::update_actions_state(double now, double delta) action->last_sent_ = sgFlow->sent_bytes_; } - if ((sgFlow->finished_) && (remains <= 0)) { // finished_ should not become true before remains gets to 0, but it sometimes does. Let's play safe, here. + 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 %s of action %p", ns3_socket.c_str(), action); action->set_remains(0); @@ -364,7 +420,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; @@ -377,65 +433,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(); - - 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 positionAllocS = ns3::CreateObject(); - 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; @@ -475,9 +476,10 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s } // 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)){ - XBT_DEBUG("Synchronizing NS-3 (time %f) with SimGrid (time %f)", ns3::Simulator::Now().GetSeconds(), surf_get_clock()); + if (model->get_started_action_set()->size() == 1) { + while (double_positive(surf_get_clock() - ns3::Simulator::Now().GetSeconds(), sg_surf_precision)) { + XBT_DEBUG("Synchronizing NS-3 (time %f) with SimGrid (time %f)", ns3::Simulator::Now().GetSeconds(), + surf_get_clock()); ns3_simulator(surf_get_clock() - ns3::Simulator::Now().GetSeconds()); } } @@ -512,11 +514,13 @@ NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* s s4u::Link::on_communicate(*this); } -void NetworkNS3Action::suspend() { +void NetworkNS3Action::suspend() +{ THROW_UNIMPLEMENTED; } -void NetworkNS3Action::resume() { +void NetworkNS3Action::resume() +{ THROW_UNIMPLEMENTED; } @@ -540,10 +544,10 @@ void ns3_simulator(double maxSeconds) id = ns3::Simulator::Schedule(ns3::Seconds(maxSeconds), &ns3::Simulator::Stop); XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock()); - ns3::Simulator::Run (); + ns3::Simulator::Run(); XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds()); - if(maxSeconds > 0.0) + if (maxSeconds > 0.0) id.Cancel(); } @@ -561,46 +565,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 apNode = WifiZone::is_ap(a) ? a : b; - ns3::Ptr 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 positionAllocS = ns3::CreateObject(); - 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; @@ -614,6 +579,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));