X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/67653c99534a66e824aebbcda75631a6c8e52c15..52866f1c7d5c27d9cf2b8484058e4b60e027d5cb:/src/surf/network_ns3.cpp diff --git a/src/surf/network_ns3.cpp b/src/surf/network_ns3.cpp index b2e8eaf79b..999e63e3e3 100644 --- a/src/surf/network_ns3.cpp +++ b/src/surf/network_ns3.cpp @@ -1,195 +1,348 @@ -/* Copyright (c) 2007-2017. 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. */ +#include #include #include "xbt/config.hpp" +#include "xbt/str.h" +#include "xbt/string.hpp" +#include "xbt/utility.hpp" + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "ns3/mobility-module.h" +#include "ns3/wifi-module.h" -#include "ns3/core-module.h" -#include "ns3/node.h" - -#include "ns3/ns3_simulator.h" #include "network_ns3.hpp" +#include "ns3/ns3_simulator.hpp" -#include "src/instr/instr_private.h" // 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/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/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(ns3, surf, "Logging specific to the SURF network ns-3 module"); /***************** * Crude globals * *****************/ -extern xbt_dict_t 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_networks = 1; -static int port_number = 1025; //Port number is limited from 1025 to 65 000 + +/* 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 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_); } /************* * Callbacks * *************/ -static void clusterCreation_cb(sg_platf_cluster_cbarg_t 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; + 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)); + } + + 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 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; + for (int const& i : *cluster.radicals) { // Create private link - char* host_id = bprintf("%s%d%s", cluster->prefix, i, cluster->suffix); - NetPointNs3* host_src = sg_host_by_name(host_id)->pimpl_netpoint->extension(); - xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id); + 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; - free(host_id); + // 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, 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) { - if (link_list->size() == 1) { - simgrid::surf::LinkNS3* link = static_cast(link_list->at(0)); + if (link_list.size() == 1) { + auto const* link = static_cast(link_list[0]); - XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->cname(), dst->cname(), link->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); - XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->cname(), 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->cname()); - xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->cname()); - - 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->cname(), dst->cname(), 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; + xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice"); - surf_network_model = new simgrid::surf::NetworkNS3Model(); - all_existing_models->push_back(surf_network_model); + surf_network_model = new simgrid::kernel::resource::NetworkNS3Model(); } -static simgrid::config::Flag ns3_tcp_model("ns3/TcpModel", - "The ns3 tcp model can be : NewReno or Reno or Tahoe", "NewReno"); +static simgrid::config::Flag + 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.", "", + [](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() : NetworkModel() { - NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create(); +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?"); - ns3_initialize(ns3_tcp_model.get().c_str()); + all_existing_models.push_back(this); - 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->cname(), pt->extension()->node_num); - }); - simgrid::surf::on_cluster.connect(&clusterCreation_cb); - simgrid::s4u::onPlatformCreated.connect(&postparse_cb); - simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb); + NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create(); - LogComponentEnable("PacketSink", ns3::LOG_LEVEL_INFO); - LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO); - LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO); -} + 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"); + } -NetworkNS3Model::~NetworkNS3Model() { - for (auto addr : IPV4addr) - free(addr); - IPV4addr.clear(); - xbt_dict_free(&flowFromSock); + 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()); + }); + + s4u::Engine::on_platform_created.connect([]() { + /* 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); } -LinkImpl* NetworkNS3Model::createLink(const char* name, double bandwidth, double latency, - e_surf_link_sharing_policy_t policy) +LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector& bandwidths, double latency, + s4u::Link::SharingPolicy policy) { - return new LinkNS3(this, name, bandwidth, latency); + xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth."); + return new LinkNS3(this, name, bandwidths[0], latency, policy); } 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) + + // 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()); @@ -199,57 +352,58 @@ 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 xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr); - - /* 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()); + static std::vector socket_to_destroy; - return; - } - - xbt_dict_cursor_t cursor = nullptr; - char *ns3Socket; - SgFlow *sgFlow; - xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){ + 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 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_; + 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); - for (auto link : route) - TRACE_surf_link_set_utilization(link->cname(), action->getCategory(), (data_delta_sent) / delta, now - delta, - delta); + action->get_src().route_to(&action->get_dst(), route, nullptr); + for (auto const& link : route) + 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_){ - xbt_dynar_push(socket_to_destroy,&ns3Socket); - XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action); - action->finish(); - action->setState(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 xbt_dynar_is_empty(socket_to_destroy)) { - xbt_dynar_pop(socket_to_destroy,&ns3Socket); - + while (not socket_to_destroy.empty()) { + 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)) { - SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket); - XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_); + XBT_DEBUG("Removing socket %s of action %p", ns3_socket.c_str(), flow->action_); } - xbt_dict_remove(flowFromSock, ns3Socket); + delete flow; + flow_from_sock.erase(ns3_socket); + sink_from_sock.erase(ns3_socket); } } @@ -257,42 +411,88 @@ void NetworkNS3Model::updateActionsState(double now, double delta) * Resource * ************/ -LinkNS3::LinkNS3(NetworkNS3Model* model, const char* name, double bandwidth, double latency) - : LinkImpl(model, name, nullptr) +LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency, + s4u::Link::SharingPolicy policy) + : LinkImpl(model, name, nullptr), sharing_policy_(policy) { bandwidth_.peak = bandwidth; latency_.peak = latency; - s4u::Link::onCreation(this->piface_); + s4u::Link::on_creation(*this->get_iface()); } 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::set_bandwidth_profile(profile::Profile*) +{ + xbt_die("The ns-3 network model doesn't support bandwidth profiles"); } -void LinkNS3::setLatencyTrace(tmgr_trace_t trace) { - xbt_die("The NS3 network model doesn't support latency traces"); +void LinkNS3::set_latency_profile(profile::Profile*) +{ + xbt_die("The ns-3 network model doesn't support latency profiles"); } /********** * Action * **********/ -NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst) - : NetworkAction(model, size, false) +NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst) + : NetworkAction(model, *src, *dst, totalBytes, false) { - XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname()); + // 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)){ + 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()); + } + } + + static uint16_t port_number = 1; + + ns3::Ptr src_node = src->get_netpoint()->extension()->ns3_node_; + ns3::Ptr dst_node = dst->get_netpoint()->extension()->ns3_node_; + + 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()); + + ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number)); + ns3::ApplicationContainer apps = sink.Install(dst_node); - src_ = src; - dst_ = dst; - ns3_create_flow(src, dst, size, this); + ns3::Ptr 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); - s4u::Link::onCommunicate(this, src, dst); + 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() { @@ -303,191 +503,73 @@ void NetworkNS3Action::resume() { THROW_UNIMPLEMENTED; } -std::list NetworkNS3Action::links() +std::list NetworkNS3Action::get_links() const { THROW_UNIMPLEMENTED; } - -/* Test whether a flow is suspended */ -bool NetworkNS3Action::isSuspended() -{ - return false; -} - -int NetworkNS3Action::unref() +void NetworkNS3Action::update_remains_lazy(double /*now*/) { - refcount_--; - if (not refcount_) { - if (action_hook.is_linked()) - stateSet_->erase(stateSet_->iterator_to(*this)); - XBT_DEBUG ("Removing action %p", this); - delete this; - return 1; - } - return 0; + THROW_IMPOSSIBLE; } -} -} +} // namespace resource +} // namespace kernel +} // namespace simgrid void ns3_simulator(double maxSeconds) { + ns3::EventId id; if (maxSeconds > 0.0) // If there is a maximum amount of time to run - ns3::Simulator::Stop(ns3::Seconds(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 (); -} - -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; - - ns3::Ptr src_node = nodes.Get(node1); - ns3::Ptr dst_node = nodes.Get(node2); - - xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?", - dst->pimpl_netpoint->cname()); - char* addr = IPV4addr.at(node2); - xbt_assert(addr != nullptr, "Element %s is unknown to NS3. Is it connected to any one-hop link?", - dst->pimpl_netpoint->cname()); - - XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr); - ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number)); - sink.Install (dst_node); - - ns3::Ptr sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId()); - - xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr); - - sock->Bind(ns3::InetSocketAddress(port_number)); - - ns3::Simulator::ScheduleNow(&StartFlow, sock, addr, port_number); - - port_number++; - xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated."); -} - -// 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_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds()); - xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe"); + if(maxSeconds > 0.0) + id.Cancel(); } -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++) { - Nodes.Add(Cluster_nodes.Get(i)); - XBT_DEBUG("Add node %d to cluster",i); - } - number_of_clusters_nodes = Cluster_nodes.GetN(); - - XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1); - Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1)); - - 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"); - - char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links); - XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr); - ns3::Ipv4AddressHelper ipv4; - ipv4.SetBase (adr, "255.255.0.0"); - free(adr); - interfaces.Add(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++; - } - XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN()); -} - -static char* transformIpv4Address (ns3::Ipv4Address from){ - std::stringstream sstream; - sstream << from ; - std::string s = sstream.str(); - return bprintf("%s",s.c_str()); -} - -void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) { - ns3::PointToPointHelper pointToPoint; - +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) +{ ns3::Ipv4AddressHelper address; + ns3::NetDeviceContainer netA; - int srcNum = src->node_num; - int dstNum = dst->node_num; + // create link ns3 + auto* host_src = src->extension(); + auto* host_dst = dst->extension(); - ns3::Ptr a = nodes.Get(srcNum); - ns3::Ptr b = nodes.Get(dstNum); + 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()); - 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)));// NS3 takes bps, but we provide Bps - pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat))); + 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; - char *filename = bprintf("link-%d-%d.tr", srcNum, dstNum); - ns3::AsciiTraceHelper ascii; - pointToPoint.EnableAsciiAll (ascii.CreateFileStream (filename)); - pointToPoint.EnablePcapAll ("tcp-bulk-send", false); - xbt_free(filename); + 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))); - ns3::NetDeviceContainer netA; - netA.Add(pointToPoint.Install (a, b)); + netA.Add(pointToPoint.Install(host_src->ns3_node_, host_dst->ns3_node_)); - char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links); - address.SetBase (adr, "255.255.0.0"); - XBT_DEBUG("\tInterface stack '%s'",adr); - free(adr); - interfaces.Add(address.Assign (netA)); + 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()); - if (IPV4addr.size() <= (unsigned)srcNum) - IPV4addr.resize(srcNum + 1, nullptr); - IPV4addr.at(srcNum) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2)); + auto addresses = address.Assign(netA); - if (IPV4addr.size() <= (unsigned)dstNum) - IPV4addr.resize(dstNum + 1, nullptr); - IPV4addr.at(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){ - 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++; + } } }