X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d89181236202a111a0dae55a58283acb0e0a336c..cf6a1d5f1eddea2b377415ab57c5185058488269:/src/surf/network_ns3.cpp diff --git a/src/surf/network_ns3.cpp b/src/surf/network_ns3.cpp index 9d75c4d4d0..1180f02b1f 100644 --- a/src/surf/network_ns3.cpp +++ b/src/surf/network_ns3.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2007-2017. 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. */ @@ -7,183 +7,373 @@ #include #include "xbt/config.hpp" +#include "xbt/str.h" #include "xbt/string.hpp" #include "xbt/utility.hpp" -#include "ns3/core-module.h" -#include "ns3/node.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "ns3/mobility-module.h" +#include "ns3/wifi-module.h" #include "network_ns3.hpp" #include "ns3/ns3_simulator.hpp" -#include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals -#include "src/kernel/routing/NetPoint.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" -XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module"); - -std::vector IPV4addr; +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_ns3, res_network, "Network model based on ns-3"); /***************** * Crude globals * *****************/ -extern std::map flowFromSock; +extern std::map> flow_from_sock; +extern std::map> sink_from_sock; static ns3::InternetStackHelper stack; -static ns3::NodeContainer nodes; -static ns3::NodeContainer Cluster_nodes; -static ns3::Ipv4InterfaceContainer interfaces; -static int number_of_nodes = 0; -static int number_of_clusters_nodes = 0; -static int number_of_links = 1; +static int number_of_links = 1; static int number_of_networks = 1; -static int port_number = 1025; //Port number is limited from 1025 to 65 000 + +/* wifi globals */ +static ns3::WifiHelper wifi; +#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; simgrid::xbt::Extension NetPointNs3::EXTENSION_ID; -NetPointNs3::NetPointNs3() +static std::string transformIpv4Address(ns3::Ipv4Address from) { - ns3::Ptr node = ns3::CreateObject(0); - stack.Install(node); - nodes.Add(node); - node_num = number_of_nodes++; + std::stringstream sstream; + sstream << from; + return sstream.str(); +} + +NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject(0)) +{ + stack.Install(ns3_node_); +} + +static void resumeWifiDevice(ns3::Ptr device) +{ + device->GetPhy()->ResumeFromOff(); } /************* * Callbacks * *************/ -static void clusterCreation_cb(ClusterCreationArgs* cluster) +static void zoneCreation_cb(simgrid::s4u::NetZone const& zone) +{ + 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 + 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.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)); + } + + 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); + } + + 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 (unsigned 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) { - for (int const& i : *cluster->radicals) { - // Routers don't create a router on the other end of the private link by themselves. - // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one - NetPointNs3* host_dst = new NetPointNs3(); + ns3::NodeContainer Nodes; + + 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; - NetPointNs3* host_src = sg_host_by_name(host_id.c_str())->pimpl_netpoint->extension(); - xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id.c_str()); + std::string host_id = cluster.prefix + std::to_string(i) + cluster.suffix; + auto* src = simgrid::s4u::Host::by_name(host_id)->get_netpoint(); + auto* dst = simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(cluster.router_id); + xbt_assert(dst != nullptr, "No router named %s", cluster.router_id.c_str()); - // Any NS3 route is symmetrical - ns3_add_link(host_src, host_dst, cluster->bw, cluster->lat); + ns3_add_direct_route(src, dst, cluster.bw, cluster.lat, cluster.id, + cluster.sharing_policy); // Any ns-3 route is symmetrical - delete host_dst; + // Also add the host to the list of hosts that will be connected to the backbone + Nodes.Add(src->extension()->ns3_node_); } - //Create link backbone - ns3_add_cluster(cluster->id.c_str(), cluster->bb_bw, cluster->bb_lat); + // Create link backbone + + xbt_assert(Nodes.GetN() <= 65000, "Cluster with ns-3 is limited to 65000 nodes"); + ns3::CsmaHelper csma; + csma.SetChannelAttribute("DataRate", + ns3::DataRateValue(ns3::DataRate(cluster.bb_bw * 8))); // ns-3 takes bps, but we provide Bps + csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(cluster.bb_lat))); + ns3::NetDeviceContainer devices = csma.Install(Nodes); + XBT_DEBUG("Create CSMA"); + + std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links); + XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str()); + ns3::Ipv4AddressHelper ipv4; + ipv4.SetBase(addr.c_str(), "255.255.0.0"); + ipv4.Assign(devices); + + 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 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& link_list) + simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* /*gw_src*/, + simgrid::kernel::routing::NetPoint* /*gw_dst*/, + std::vector const& link_list) { + /* ignoring routes from StarZone, not supported */ + if (not src || not dst) + return; + if (link_list.size() == 1) { - simgrid::surf::LinkNS3* link = static_cast(link_list[0]); + auto const* link = static_cast(link_list[0]); - XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->getCname(), dst->getCname(), link->getCname(), + 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); - XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->getCname(), link->bandwidth(), link->latency()); + XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->get_cname(), link->get_bandwidth(), link->get_latency()); - // create link ns3 - NetPointNs3* host_src = src->extension(); - NetPointNs3* host_dst = dst->extension(); - - xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->getCname()); - xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->getCname()); - - ns3_add_link(host_src, host_dst, link->bandwidth(), link->latency()); + ns3_add_direct_route(src, dst, link->get_bandwidth(), link->get_latency(), link->get_name(), + link->get_sharing_policy()); } else { static bool warned_about_long_routes = false; if (not warned_about_long_routes) - XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with NS3.\n" + XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with ns-3.\n" "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes " "of length 1.\n" "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently " "ignored.", - src->getCname(), dst->getCname(), link_list.size()); + src->get_cname(), dst->get_cname(), link_list.size()); warned_about_long_routes = true; } } -/* Create the ns3 topology based on routing strategy */ -static void postparse_cb() -{ - IPV4addr.shrink_to_fit(); - - ns3::GlobalRouteManager::BuildGlobalRoutingDatabase(); - ns3::GlobalRouteManager::InitializeRoutes(); -} - /********* * Model * *********/ void surf_network_model_init_NS3() { - if (surf_network_model) - return; - - surf_network_model = new simgrid::surf::NetworkNS3Model(); - all_existing_models->push_back(surf_network_model); + auto net_model = std::make_shared("NS3 network model"); + simgrid::kernel::EngineImpl::get_instance()->add_model(net_model); + simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_network_model(net_model); } static simgrid::config::Flag - ns3_tcp_model("ns3/TcpModel", "The ns3 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 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.", "", + [](const 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 surf { +namespace kernel { +namespace resource { + +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?"); -NetworkNS3Model::NetworkNS3Model() : NetworkModel() { - NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create(); + NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create(); + + ns3::Config::SetDefault("ns3::TcpSocket::SegmentSize", ns3::UintegerValue(1000)); + ns3::Config::SetDefault("ns3::TcpSocket::DelAckCount", ns3::UintegerValue(1)); + ns3::Config::SetDefault("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue(false)); + + auto TcpProtocol = ns3_tcp_model.get(); + if (TcpProtocol == "default") { + /* nothing to do */ + + } else if (TcpProtocol == "Reno" || TcpProtocol == "NewReno" || TcpProtocol == "Tahoe") { + XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str()); + ns3::Config::SetDefault("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::Tcp" + TcpProtocol)); + + } else { + xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe"); + } - ns3_initialize(ns3_tcp_model.get().c_str()); + routing::NetPoint::on_creation.connect([](routing::NetPoint& pt) { + pt.extension_set(new NetPointNs3()); + XBT_VERB("Declare SimGrid's %s within ns-3", pt.get_cname()); + }); - simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint* pt) { - pt->extension_set(new NetPointNs3()); - XBT_VERB("SimGrid's %s is known as node %d within NS3", pt->getCname(), pt->extension()->node_num); + s4u::Engine::on_platform_created.connect([]() { + /* Create the ns3 topology based on routing strategy */ + ns3::GlobalRouteManager::BuildGlobalRoutingDatabase(); + ns3::GlobalRouteManager::InitializeRoutes(); }); - simgrid::surf::on_cluster.connect(&clusterCreation_cb); - simgrid::s4u::onPlatformCreated.connect(&postparse_cb); - simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb); + routing::on_cluster_creation.connect(&clusterCreation_cb); + s4u::NetZone::on_route_creation.connect(&routeCreation_cb); + s4u::NetZone::on_seal.connect(&zoneCreation_cb); } -NetworkNS3Model::~NetworkNS3Model() { - IPV4addr.clear(); +LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector& bandwidths) +{ + xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth."); + return (new LinkNS3(name, bandwidths[0]))->set_model(this); } -LinkImpl* NetworkNS3Model::createLink(const std::string& name, double bandwidth, double latency, - e_surf_link_sharing_policy_t policy) +LinkImpl* NetworkNS3Model::create_wifi_link(const std::string& name, const std::vector& bandwidths) { - return new LinkNS3(this, name, bandwidth, latency); + return create_link(name, bandwidths)->set_sharing_policy(s4u::Link::SharingPolicy::WIFI); } Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) { + xbt_assert(rate == -1, + "Communication over ns-3 links cannot specify a specific rate. Please use -1 as a value instead of %f.", + rate); return new NetworkNS3Action(this, size, src, dst); } -double NetworkNS3Model::nextOccuringEvent(double now) +double NetworkNS3Model::next_occurring_event(double now) { - double time_to_next_flow_completion; - XBT_DEBUG("ns3_next_occuring_event"); + double time_to_next_flow_completion = 0.0; + XBT_DEBUG("ns3_next_occurring_event"); - //get the first relevant value from the running_actions list - if (not getRunningActionSet()->size() || now == 0.0) + // 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. + // (see NetworkNS3Action::NetworkNS3Action() for more details on this point) + if (get_started_action_set()->empty() || now == 0.0) return -1.0; - else - do { - ns3_simulator(now); - time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock(); - } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision)); + + 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(); + // 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; XBT_DEBUG("min : %f", now); XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds()); @@ -193,57 +383,59 @@ double NetworkNS3Model::nextOccuringEvent(double now) return time_to_next_flow_completion; } -void NetworkNS3Model::updateActionsState(double now, double delta) +void NetworkNS3Model::update_actions_state(double now, double delta) { static std::vector socket_to_destroy; - /* If there are no running flows, advance the NS3 simulator and return */ - if (getRunningActionSet()->empty()) { - - while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision)) - ns3_simulator(now-ns3::Simulator::Now().GetSeconds()); - - return; - } - - std::string ns3Socket; - for (auto elm : flowFromSock) { - ns3Socket = elm.first; - SgFlow* sgFlow = elm.second; - NetworkNS3Action * action = sgFlow->action_; - XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action); - action->setRemains(action->getCost() - sgFlow->sentBytes_); - - if (TRACE_is_enabled() && - action->getState() == Action::State::running){ - double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_; + std::string ns3_socket; + for (const auto& elm : flow_from_sock) { + 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) + action->set_remains(remains); + + if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) { + double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_; std::vector route = std::vector(); - action->src_->routeTo(action->dst_, route, nullptr); + action->get_src().route_to(&action->get_dst(), route, nullptr); for (auto const& link : route) - TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), (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->lastSent_ = sgFlow->sentBytes_; + action->last_sent_ = sgFlow->sent_bytes_; } - if(sgFlow->finished_){ - socket_to_destroy.push_back(ns3Socket); - XBT_DEBUG("Destroy socket %p of action %p", ns3Socket.c_str(), action); - action->finish(Action::State::done); + 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); + action->finish(Action::State::FINISHED); + } else { + XBT_DEBUG("Socket %s sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_, + sgFlow->total_bytes_, sgFlow->remaining_); } } while (not socket_to_destroy.empty()) { - ns3Socket = socket_to_destroy.back(); + ns3_socket = socket_to_destroy.back(); socket_to_destroy.pop_back(); - SgFlow* flow = flowFromSock.at(ns3Socket); - if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) { - XBT_DEBUG("Removing socket %p of action %p", ns3Socket.c_str(), flow->action_); + SgFlow* flow = flow_from_sock.at(ns3_socket); + 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; - flowFromSock.erase(ns3Socket); + flow_from_sock.erase(ns3_socket); + sink_from_sock.erase(ns3_socket); } } @@ -251,226 +443,173 @@ void NetworkNS3Model::updateActionsState(double now, double delta) * Resource * ************/ -LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency) - : LinkImpl(model, name, nullptr) +LinkNS3::LinkNS3(const std::string& name, double bandwidth) : LinkImpl(name) { bandwidth_.peak = bandwidth; - latency_.peak = latency; - - s4u::Link::onCreation(this->piface_); } LinkNS3::~LinkNS3() = default; -void LinkNS3::apply_event(tmgr_trace_event_t event, double value) +void LinkNS3::apply_event(profile::Event*, double) { THROW_UNIMPLEMENTED; } -void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) { - xbt_die("The NS3 network model doesn't support bandwidth traces"); -} -void LinkNS3::setLatencyTrace(tmgr_trace_t trace) { - xbt_die("The NS3 network model doesn't support latency traces"); -} -/********** - * Action * - **********/ - -NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst) - : NetworkAction(model, size, false) +LinkImpl* LinkNS3::set_bandwidth_profile(profile::Profile* profile) { - XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname()); - - src_ = src; - dst_ = dst; - ns3_create_flow(src, dst, size, this); - - s4u::Link::onCommunicate(this, src, dst); + xbt_assert(profile == nullptr, "The ns-3 network model doesn't support bandwidth profiles"); + return this; } -void NetworkNS3Action::suspend() { - THROW_UNIMPLEMENTED; -} - -void NetworkNS3Action::resume() { - THROW_UNIMPLEMENTED; +LinkImpl* LinkNS3::set_latency_profile(profile::Profile* profile) +{ + xbt_assert(profile == nullptr, "The ns-3 network model doesn't support latency profiles"); + return this; } -std::list NetworkNS3Action::links() +LinkImpl* LinkNS3::set_latency(double latency) { - THROW_UNIMPLEMENTED; + latency_.peak = latency; + return this; } -/* Test whether a flow is suspended */ -bool NetworkNS3Action::isSuspended() +LinkImpl* LinkNS3::set_sharing_policy(s4u::Link::SharingPolicy policy) { - return false; + sharing_policy_ = policy; + return this; } +/********** + * Action * + **********/ -int NetworkNS3Action::unref() +NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst) + : NetworkAction(model, *src, *dst, totalBytes, false) { - refcount_--; - if (not refcount_) { - if (action_hook.is_linked()) - simgrid::xbt::intrusive_erase(*stateSet_, *this); - XBT_DEBUG ("Removing action %p", this); - delete this; - return 1; + // 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; } - return 0; -} -} -} - -void ns3_simulator(double maxSeconds) -{ - if (maxSeconds > 0.0) // If there is a maximum amount of time to run - ns3::Simulator::Stop(ns3::Seconds(maxSeconds)); - XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock()); - ns3::Simulator::Run (); -} + // 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()); + ns3_simulator(surf_get_clock() - ns3::Simulator::Now().GetSeconds()); + } + } -void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, - u_int32_t TotalBytes, - simgrid::surf::NetworkNS3Action* action) { - unsigned int node1 = src->pimpl_netpoint->extension()->node_num; - unsigned int node2 = dst->pimpl_netpoint->extension()->node_num; + static uint16_t port_number = 1; - ns3::Ptr src_node = nodes.Get(node1); - ns3::Ptr dst_node = nodes.Get(node2); + ns3::Ptr src_node = src->get_netpoint()->extension()->ns3_node_; + ns3::Ptr dst_node = dst->get_netpoint()->extension()->ns3_node_; - xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?", - dst->pimpl_netpoint->getCname()); - std::string& addr = IPV4addr[node2]; - xbt_assert(not addr.empty(), "Element %s is unknown to NS3. Is it connected to any one-hop link?", - dst->pimpl_netpoint->getCname()); + std::string& addr = dst->get_netpoint()->extension()->ipv4_address_; + 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 %u Bytes from %u to %u with Interface %s", TotalBytes, node1, node2, addr.c_str()); - ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number)); - sink.Install (dst_node); + ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number)); + ns3::ApplicationContainer apps = sink.Install(dst_node); ns3::Ptr sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId()); - flowFromSock.insert({transformSocketPtr(sock), new SgFlow(TotalBytes, action)}); + 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); - ns3::Simulator::ScheduleNow(&StartFlow, sock, addr.c_str(), port_number); + 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."); - port_number++; - xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated."); + s4u::Link::on_communicate(*this); } -// initialize the NS3 interface and environment -void ns3_initialize(const char* TcpProtocol){ -// tcpModel are: -// "ns3::TcpNewReno" -// "ns3::TcpReno" -// "ns3::TcpTahoe" - - ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000)); - ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1)); - ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false)); - - if (not strcmp(TcpProtocol, "default")) - return; - - if (not strcmp(TcpProtocol, "Reno")) { - XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol); - ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno")); - return; - } - if (not strcmp(TcpProtocol, "NewReno")) { - XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol); - ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno")); - return; - } - if (not strcmp(TcpProtocol, "Tahoe")) { - XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol); - ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe")); - return; - } - - xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe"); +void NetworkNS3Action::suspend() +{ + THROW_UNIMPLEMENTED; } -void ns3_add_cluster(const char* id, double bw, double lat) { - ns3::NodeContainer Nodes; +void NetworkNS3Action::resume() +{ + THROW_UNIMPLEMENTED; +} - for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) { - Nodes.Add(Cluster_nodes.Get(i)); - XBT_DEBUG("Add node %u to cluster", i); - } - number_of_clusters_nodes = Cluster_nodes.GetN(); +std::list NetworkNS3Action::get_links() const +{ + THROW_UNIMPLEMENTED; +} +void NetworkNS3Action::update_remains_lazy(double /*now*/) +{ + THROW_IMPOSSIBLE; +} - XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1); - Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1)); +} // namespace resource +} // namespace kernel +} // namespace simgrid - xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes"); - ns3::CsmaHelper csma; - csma.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw * 8))); // NS3 takes bps, but we provide Bps - csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat))); - ns3::NetDeviceContainer devices = csma.Install(Nodes); - XBT_DEBUG("Create CSMA"); +void ns3_simulator(double maxSeconds) +{ + 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); - std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links); - XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str()); - ns3::Ipv4AddressHelper ipv4; - ipv4.SetBase(addr.c_str(), "255.255.0.0"); - interfaces.Add(ipv4.Assign (devices)); + XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock()); + ns3::Simulator::Run(); + XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds()); - 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++; - } - XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN()); + if (maxSeconds > 0.0) + id.Cancel(); } -static std::string transformIpv4Address(ns3::Ipv4Address from) +void ns3_add_direct_route(simgrid::kernel::routing::NetPoint* src, simgrid::kernel::routing::NetPoint* dst, double bw, + double lat, const std::string& link_name, simgrid::s4u::Link::SharingPolicy policy) { - std::stringstream sstream; - sstream << from ; - return sstream.str(); -} + ns3::Ipv4AddressHelper address; + ns3::NetDeviceContainer netA; -void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) { - ns3::PointToPointHelper pointToPoint; + // create link ns3 + auto* host_src = src->extension(); + auto* host_dst = dst->extension(); - ns3::Ipv4AddressHelper address; + 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()); - int srcNum = src->node_num; - int dstNum = dst->node_num; + 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::Ptr a = nodes.Get(srcNum); - ns3::Ptr b = nodes.Get(dstNum); + ns3::PointToPointHelper pointToPoint; - XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, 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))); // NS3 takes bps, but we provide Bps + ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat))); - ns3::NetDeviceContainer netA; - netA.Add(pointToPoint.Install (a, b)); + 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()); - interfaces.Add(address.Assign (netA)); - if (IPV4addr.size() <= (unsigned)srcNum) - IPV4addr.resize(srcNum + 1); - IPV4addr[srcNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2)); + auto addresses = address.Assign(netA); - if (IPV4addr.size() <= (unsigned)dstNum) - IPV4addr.resize(dstNum + 1); - IPV4addr[dstNum] = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1)); + host_src->ipv4_address_ = transformIpv4Address(addresses.GetAddress(0)); + host_dst->ipv4_address_ = transformIpv4Address(addresses.GetAddress(1)); - if (number_of_links == 255){ + 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++;