-/* Copyright (c) 2007-2021. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2007-2022. 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 "simgrid/plugins/ns3.hpp"
+
#include <string>
#include <unordered_set>
#include <ns3/global-route-manager.h>
#include <ns3/internet-stack-helper.h>
#include <ns3/ipv4-address-helper.h>
+#include <ns3/ipv4-global-routing-helper.h>
#include <ns3/packet-sink-helper.h>
#include <ns3/point-to-point-helper.h>
#include "ns3/ns3_simulator.hpp"
#include "simgrid/kernel/routing/NetPoint.hpp"
+#include "simgrid/kernel/routing/NetZoneImpl.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"
+#include "src/surf/xml/platf_private.hpp" // ClusterCreationArgs
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_ns3, res_network, "Network model based on ns-3");
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");
+ xbt_assert(nss_value == 1 + (mcs_value / 8),
+ "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.Set("Antennas", ns3::UintegerValue(nss_value));
wifiPhy.Set("MaxSupportedTxSpatialStreams", ns3::UintegerValue(nss_value));
wifiPhy.Set("MaxSupportedRxSpatialStreams", ns3::UintegerValue(nss_value));
+#if NS3_MINOR_VERSION > 33
+ wifiPhy.Set("ChannelWidth", ns3::UintegerValue(40));
+#endif
wifiMac.SetType("ns3::ApWifiMac", "Ssid", ns3::SsidValue(ssid));
mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
ns3::Simulator::Schedule(ns3::Seconds(start_time_value), &resumeWifiDevice, device);
}
+#if NS3_MINOR_VERSION < 33
+ // This fails with "The channel width does not uniquely identify an operating channel" on v3.34,
+ // so we specified the ChannelWidth of wifiPhy to 40, above, when creating wifiPhy with v3.34 and higher
ns3::Config::Set("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue(40));
+#endif
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");
} else {
number_of_links++;
}
+ /* in theory we can compute the routing table only only once at the platform seal
+ * however put it here since or platform_created signal is called before the seal right now */
+ ns3::Ipv4GlobalRoutingHelper::RecomputeRoutingTables();
}
static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
{
ns3::NodeContainer Nodes;
- for (int const& i : *cluster.radicals) {
+ xbt_assert(cluster.topology == simgrid::kernel::routing::ClusterTopology::FLAT,
+ "NS-3 is supported only by flat clusters. Do not use with other topologies");
+
+ for (int const& i : cluster.radicals) {
// Create private link
std::string host_id = cluster.prefix + std::to_string(i) + cluster.suffix;
auto* src = simgrid::s4u::Host::by_name(host_id)->get_netpoint();
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*/,
- std::vector<simgrid::kernel::resource::LinkImpl*> const& link_list)
+ std::vector<simgrid::kernel::resource::StandardLinkImpl*> const& link_list)
{
+ /* ignoring routes from StarZone, not supported */
+ if (not src || not dst)
+ return;
+
if (link_list.size() == 1) {
auto const* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
*********/
void surf_network_model_init_NS3()
{
- /* FIXME[donassolo]: this smells bad, but works
- * (the constructor saves its pointer in all_existing_models and models_by_type :O).
- * We need a manager for these models */
- new simgrid::kernel::resource::NetworkNS3Model();
+ auto net_model = std::make_shared<simgrid::kernel::resource::NetworkNS3Model>("NS3 network model");
+ auto* engine = simgrid::kernel::EngineImpl::get_instance();
+ engine->add_model(net_model);
+ engine->get_netzone_root()->set_network_model(net_model);
}
static simgrid::config::Flag<std::string>
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) {
+ [](const std::string& val) {
if (val.length() == 0)
return;
if (strcasecmp(val.c_str(), "time") == 0) {
namespace kernel {
namespace resource {
-NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
+NetworkNS3Model::NetworkNS3Model(const std::string& name) : NetworkModel(name)
{
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);
- models_by_type[simgrid::kernel::resource::Model::Type::NETWORK].push_back(this);
-
NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create<NetPointNs3>();
ns3::Config::SetDefault("ns3::TcpSocket::SegmentSize", ns3::UintegerValue(1000));
XBT_VERB("Declare SimGrid's %s within ns-3", pt.get_cname());
});
- s4u::Engine::on_platform_created.connect([]() {
+ s4u::Engine::on_platform_created_cb([]() {
/* Create the ns3 topology based on routing strategy */
ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
ns3::GlobalRouteManager::InitializeRoutes();
});
routing::on_cluster_creation.connect(&clusterCreation_cb);
- s4u::NetZone::on_route_creation.connect(&routeCreation_cb);
- s4u::NetZone::on_seal.connect(&zoneCreation_cb);
+ routing::NetZoneImpl::on_route_creation.connect(&routeCreation_cb);
+ s4u::NetZone::on_seal_cb(&zoneCreation_cb);
}
-LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths,
- s4u::Link::SharingPolicy policy)
+StandardLinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
{
xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
- return new LinkNS3(name, bandwidths[0], policy);
+ auto* link = new LinkNS3(name, bandwidths[0]);
+ link->set_model(this);
+ return link;
+}
+
+StandardLinkImpl* NetworkNS3Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
+{
+ auto* link = create_link(name, bandwidths);
+ link->set_sharing_policy(s4u::Link::SharingPolicy::WIFI, {});
+ return link;
}
Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
XBT_DEBUG("doing a ns3 simulation for a duration of %f", now);
ns3_simulator(now);
- time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
+ time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - EngineImpl::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
XBT_DEBUG("min : %f", now);
XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
- XBT_DEBUG("surf time : %f", surf_get_clock());
+ XBT_DEBUG("surf time : %f", EngineImpl::get_clock());
XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
return time_to_next_flow_completion;
if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) {
double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_;
- std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
+ std::vector<StandardLinkImpl*> route = std::vector<StandardLinkImpl*>();
action->get_src().route_to(&action->get_dst(), route, nullptr);
for (auto const& link : route)
* Resource *
************/
-LinkNS3::LinkNS3(const std::string& name, double bandwidth, s4u::Link::SharingPolicy policy)
- : LinkImpl(name), sharing_policy_(policy)
+LinkNS3::LinkNS3(const std::string& name, double bandwidth) : StandardLinkImpl(name)
{
bandwidth_.peak = bandwidth;
}
{
THROW_UNIMPLEMENTED;
}
-void LinkNS3::set_bandwidth_profile(profile::Profile*)
+
+void LinkNS3::set_bandwidth_profile(profile::Profile* profile)
{
- xbt_die("The ns-3 network model doesn't support bandwidth profiles");
+ xbt_assert(profile == nullptr, "The ns-3 network model doesn't support bandwidth profiles");
}
-void LinkNS3::set_latency_profile(profile::Profile*)
+
+void LinkNS3::set_latency_profile(profile::Profile* profile)
{
- xbt_die("The ns-3 network model doesn't support latency profiles");
+ xbt_assert(profile == nullptr, "The ns-3 network model doesn't support latency profiles");
}
+void LinkNS3::set_latency(double latency)
+{
+ latency_.peak = latency;
+}
+
+void LinkNS3::set_sharing_policy(s4u::Link::SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
+{
+ sharing_policy_ = policy;
+}
/**********
* Action *
**********/
// 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)) {
+ while (double_positive(EngineImpl::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());
+ EngineImpl::get_clock());
+ ns3_simulator(EngineImpl::get_clock() - ns3::Simulator::Now().GetSeconds());
}
}
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_;
+ ns3::Ptr<ns3::Node> src_node = get_ns3node_from_sghost(src);
+ ns3::Ptr<ns3::Node> dst_node = get_ns3node_from_sghost(dst);
std::string& addr = dst->get_netpoint()->extension<NetPointNs3>()->ipv4_address_;
xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
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);
}
void NetworkNS3Action::suspend()
THROW_UNIMPLEMENTED;
}
-std::list<LinkImpl*> NetworkNS3Action::get_links() const
+std::list<StandardLinkImpl*> NetworkNS3Action::get_links() const
{
THROW_UNIMPLEMENTED;
}
} // namespace resource
} // namespace kernel
+
+ns3::Ptr<ns3::Node> get_ns3node_from_sghost(simgrid::s4u::Host* host)
+{
+ xbt_assert(host->get_netpoint()->extension<NetPointNs3>() != nullptr, "Please only use this function on ns-3 nodes");
+ return host->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
+}
} // namespace simgrid
void ns3_simulator(double maxSeconds)
if (maxSeconds > 0.0) // If there is a maximum amount of time to run
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());
+ XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, simgrid::kernel::EngineImpl::get_clock());
ns3::Simulator::Run();
XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds());
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());
- if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
- xbt_die("The wifi sharing policy is not supported for links. You want to use a wifi zone (see documentation).");
- } else {
- ns3::PointToPointHelper pointToPoint;
+ xbt_assert(policy != simgrid::s4u::Link::SharingPolicy::WIFI,
+ "The wifi sharing policy is not supported for links. You want to use a wifi zone (see documentation).");
+
+ ns3::PointToPointHelper pointToPoint;
- XBT_DEBUG("\tAdd PTP from %s to %s bw:'%f Bps' lat:'%fs'", src->get_cname(), dst->get_cname(), 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)));
+ XBT_DEBUG("\tAdd PTP from %s to %s bw:'%f Bps' lat:'%fs'", src->get_cname(), dst->get_cname(), 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(host_src->ns3_node_, host_dst->ns3_node_));
+ netA.Add(pointToPoint.Install(host_src->ns3_node_, host_dst->ns3_node_));
- 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());
+ 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);
+ auto addresses = address.Assign(netA);
- host_src->ipv4_address_ = transformIpv4Address(addresses.GetAddress(0));
- host_dst->ipv4_address_ = transformIpv4Address(addresses.GetAddress(1));
+ host_src->ipv4_address_ = transformIpv4Address(addresses.GetAddress(0));
+ host_dst->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++;
- }
+ 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++;
}
}
