1 /* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include <unordered_set>
9 #include "xbt/config.hpp"
11 #include "xbt/string.hpp"
12 #include "xbt/utility.hpp"
14 #include <ns3/core-module.h>
15 #include <ns3/csma-helper.h>
16 #include <ns3/global-route-manager.h>
17 #include <ns3/internet-stack-helper.h>
18 #include <ns3/ipv4-address-helper.h>
19 #include <ns3/packet-sink-helper.h>
20 #include <ns3/point-to-point-helper.h>
21 #include <ns3/application-container.h>
22 #include <ns3/event-id.h>
24 #include "ns3/mobility-module.h"
25 #include "ns3/wifi-module.h"
27 #include "network_ns3.hpp"
28 #include "ns3/ns3_simulator.hpp"
30 #include "simgrid/kernel/routing/NetPoint.hpp"
31 #include "simgrid/kernel/routing/WifiZone.hpp"
32 #include "simgrid/plugins/energy.h"
33 #include "simgrid/s4u/Engine.hpp"
34 #include "simgrid/s4u/NetZone.hpp"
35 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
36 #include "src/surf/surf_interface.hpp"
37 #include "src/surf/xml/platf_private.hpp"
38 #include "surf/surf.hpp"
40 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network ns-3 module");
46 extern std::map<std::string, SgFlow*> flow_from_sock;
47 extern std::map<std::string, ns3::ApplicationContainer> sink_from_sock;
49 static ns3::InternetStackHelper stack;
51 static int number_of_links = 1;
52 static int number_of_networks = 1;
55 static ns3::WifiHelper wifi;
56 static ns3::YansWifiPhyHelper wifiPhy = ns3::YansWifiPhyHelper::Default();
57 static ns3::YansWifiChannelHelper wifiChannel = ns3::YansWifiChannelHelper::Default();
58 static ns3::WifiMacHelper wifiMac;
59 static ns3::MobilityHelper mobility;
61 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
63 static std::string transformIpv4Address(ns3::Ipv4Address from)
65 std::stringstream sstream;
70 NetPointNs3::NetPointNs3() : ns3_node_(ns3::CreateObject<ns3::Node>(0))
72 stack.Install(ns3_node_);
75 WifiZone::WifiZone(const std::string& name_, simgrid::s4u::Host* host_, ns3::Ptr<ns3::Node> ap_node_,
76 ns3::Ptr<ns3::YansWifiChannel> channel_, int mcs_, int nss_, int network_, int link_)
87 wifi_zones[name_] = this;
90 bool WifiZone::is_ap(ns3::Ptr<ns3::Node> node)
92 for (std::pair<std::string, WifiZone*> zone : wifi_zones)
93 if (zone.second->get_ap_node() == node)
98 WifiZone* WifiZone::by_name(const std::string& name)
102 zone = wifi_zones.at(name);
103 } catch (const std::out_of_range& oor) {
109 std::unordered_map<std::string, WifiZone*> WifiZone::wifi_zones;
111 static void initialize_ns3_wifi()
113 wifi.SetStandard(ns3::WIFI_PHY_STANDARD_80211n_5GHZ);
115 for (auto host : simgrid::s4u::Engine::get_instance()->get_all_hosts()) {
116 const char* wifi_link = host->get_property("wifi_link");
117 const char* wifi_mcs = host->get_property("wifi_mcs");
118 const char* wifi_nss = host->get_property("wifi_nss");
121 new WifiZone(wifi_link, host, host->get_netpoint()->extension<NetPointNs3>()->ns3_node_, wifiChannel.Create(),
122 wifi_mcs ? atoi(wifi_mcs) : 3, wifi_nss ? atoi(wifi_nss) : 1, 0, 0);
130 static void zoneCreation_cb(simgrid::s4u::NetZone const& zone) {
131 simgrid::kernel::routing::WifiZone* wifizone = dynamic_cast<simgrid::kernel::routing::WifiZone*> (zone.get_impl());
132 if (wifizone == nullptr) return;
134 wifi.SetStandard(ns3::WIFI_PHY_STANDARD_80211n_5GHZ);
136 std::string ssid = wifizone->get_name();
137 const char* mcs = wifizone->get_property("mcs");
138 const char* nss = wifizone->get_property("nss");
139 int mcs_value = mcs ? atoi(mcs) : 3;
140 int nss_value = nss ? atoi(nss) : 1;
141 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager",
142 "ControlMode", ns3::StringValue("HtMcs0"),
143 "DataMode", ns3::StringValue("HtMcs" + std::to_string(mcs_value)));
144 wifiPhy.SetChannel(wifiChannel.Create());
145 wifiPhy.Set("Antennas", ns3::UintegerValue(nss_value));
146 wifiPhy.Set("MaxSupportedTxSpatialStreams", ns3::UintegerValue(nss_value));
147 wifiPhy.Set("MaxSupportedRxSpatialStreams", ns3::UintegerValue(nss_value));
148 wifiMac.SetType("ns3::ApWifiMac",
149 "Ssid", ns3::SsidValue(ssid));
151 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
152 ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator>();
153 positionAllocS->Add(ns3::Vector(0, 0, 0));
155 ns3::NetDeviceContainer netDevices;
156 NetPointNs3* access_point_netpoint_ns3 = wifizone->get_access_point()->extension<NetPointNs3>();
158 ns3::Ptr<ns3::Node> access_point_ns3_node = access_point_netpoint_ns3->ns3_node_;
159 ns3::NodeContainer nodes = {access_point_ns3_node};
160 std::vector<NetPointNs3*> hosts_netpoints = {access_point_netpoint_ns3};
161 netDevices.Add(wifi.Install(wifiPhy, wifiMac,access_point_ns3_node));
163 wifiMac.SetType ("ns3::StaWifiMac",
164 "Ssid", ns3::SsidValue(ssid),
165 "ActiveProbing", ns3::BooleanValue(false));
167 NetPointNs3* station_netpoint_ns3 = nullptr;
168 ns3::Ptr<ns3::Node> station_ns3_node = nullptr;
169 const char* distance;
170 for (auto station_host : wifizone->get_all_hosts()) {
171 station_netpoint_ns3 = station_host->get_netpoint()->extension<NetPointNs3>();
172 if (station_netpoint_ns3 == access_point_netpoint_ns3)
174 hosts_netpoints.push_back(station_netpoint_ns3);
175 distance = station_host->get_property("wifi_distance");
176 positionAllocS->Add(ns3::Vector(distance ? atof(distance) : 10.0, 0, 0));
177 station_ns3_node = station_netpoint_ns3->ns3_node_;
178 nodes.Add(station_ns3_node);
179 netDevices.Add(wifi.Install(wifiPhy, wifiMac, station_ns3_node));
182 ns3::Config::Set("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue(40));
184 mobility.SetPositionAllocator(positionAllocS);
185 mobility.Install(nodes);
187 ns3::Ipv4AddressHelper address;
188 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
189 address.SetBase(addr.c_str(), "255.255.0.0");
190 XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
191 ns3::Ipv4InterfaceContainer addresses = address.Assign(netDevices);
192 for (int i = 0; i < hosts_netpoints.size(); i++) {
193 hosts_netpoints[i]->ipv4_address_ = transformIpv4Address(addresses.GetAddress(i));
196 if (number_of_links == 255) {
197 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
199 number_of_networks++;
205 static void clusterCreation_cb(simgrid::kernel::routing::ClusterCreationArgs const& cluster)
207 ns3::NodeContainer Nodes;
209 for (int const& i : *cluster.radicals) {
210 // Create private link
211 std::string host_id = cluster.prefix + std::to_string(i) + cluster.suffix;
212 auto* src = simgrid::s4u::Host::by_name(host_id)->get_netpoint();
213 auto* dst = simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(cluster.router_id);
214 xbt_assert(dst != nullptr, "No router named %s", cluster.router_id.c_str());
216 ns3_add_direct_route(src, dst, cluster.bw, cluster.lat, cluster.id,
217 cluster.sharing_policy); // Any ns-3 route is symmetrical
219 // Also add the host to the list of hosts that will be connected to the backbone
220 Nodes.Add(src->extension<NetPointNs3>()->ns3_node_);
223 // Create link backbone
225 xbt_assert(Nodes.GetN() <= 65000, "Cluster with ns-3 is limited to 65000 nodes");
226 ns3::CsmaHelper csma;
227 csma.SetChannelAttribute("DataRate",
228 ns3::DataRateValue(ns3::DataRate(cluster.bb_bw * 8))); // ns-3 takes bps, but we provide Bps
229 csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(cluster.bb_lat)));
230 ns3::NetDeviceContainer devices = csma.Install(Nodes);
231 XBT_DEBUG("Create CSMA");
233 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
234 XBT_DEBUG("Assign IP Addresses %s to CSMA.", addr.c_str());
235 ns3::Ipv4AddressHelper ipv4;
236 ipv4.SetBase(addr.c_str(), "255.255.0.0");
237 ipv4.Assign(devices);
239 if (number_of_links == 255) {
240 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
242 number_of_networks++;
248 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
249 simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* /*gw_src*/,
250 simgrid::kernel::routing::NetPoint* /*gw_dst*/,
251 std::vector<simgrid::kernel::resource::LinkImpl*> const& link_list)
253 if (link_list.size() == 1) {
254 auto const* link = static_cast<simgrid::kernel::resource::LinkNS3*>(link_list[0]);
256 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s %s", src->get_cname(), dst->get_cname(), link->get_cname(),
257 (link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI ? "(wifi)" : "(wired)"),
258 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
260 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
261 XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->get_cname(), link->get_bandwidth(), link->get_latency());
263 ns3_add_direct_route(src, dst, link->get_bandwidth(), link->get_latency(), link->get_name(),
264 link->get_sharing_policy());
266 static bool warned_about_long_routes = false;
268 if (not warned_about_long_routes)
269 XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with ns-3.\n"
270 "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
272 "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
274 src->get_cname(), dst->get_cname(), link_list.size());
275 warned_about_long_routes = true;
282 void surf_network_model_init_NS3()
284 xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
286 surf_network_model = new simgrid::kernel::resource::NetworkNS3Model();
289 static simgrid::config::Flag<std::string>
290 ns3_tcp_model("ns3/TcpModel", "The ns-3 tcp model can be: NewReno or Reno or Tahoe", "default");
291 static simgrid::config::Flag<std::string> ns3_seed(
293 "The random seed provided to ns-3. Either 'time' to seed with time(), blank to not set (default), or a number.", "",
294 [](std::string val) {
295 if (val.length() == 0)
297 if (strcasecmp(val.c_str(), "time") == 0) {
298 std::srand(time(NULL));
299 ns3::RngSeedManager::SetSeed(std::rand());
300 ns3::RngSeedManager::SetRun(std::rand());
302 int v = xbt_str_parse_int(
303 val.c_str(), "Invalid value for option ns3/seed. It must be either 'time', a number, or left empty.");
304 ns3::RngSeedManager::SetSeed(v);
305 ns3::RngSeedManager::SetRun(v);
313 NetworkNS3Model::NetworkNS3Model() : NetworkModel(Model::UpdateAlgo::FULL)
315 xbt_assert(not sg_link_energy_is_inited(),
316 "LinkEnergy plugin and ns-3 network models are not compatible. Are you looking for Ecofen, maybe?");
318 all_existing_models.push_back(this);
320 NetPointNs3::EXTENSION_ID = routing::NetPoint::extension_create<NetPointNs3>();
322 ns3::Config::SetDefault("ns3::TcpSocket::SegmentSize", ns3::UintegerValue(1000));
323 ns3::Config::SetDefault("ns3::TcpSocket::DelAckCount", ns3::UintegerValue(1));
324 ns3::Config::SetDefault("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue(false));
326 auto TcpProtocol = ns3_tcp_model.get();
327 if (TcpProtocol == "default") {
330 } else if (TcpProtocol == "Reno" || TcpProtocol == "NewReno" || TcpProtocol == "Tahoe") {
331 XBT_INFO("Switching Tcp protocol to '%s'", TcpProtocol.c_str());
332 ns3::Config::SetDefault("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::Tcp" + TcpProtocol));
335 xbt_die("The ns3/TcpModel must be: NewReno or Reno or Tahoe");
338 routing::NetPoint::on_creation.connect([](routing::NetPoint& pt) {
339 pt.extension_set<NetPointNs3>(new NetPointNs3());
340 XBT_VERB("Declare SimGrid's %s within ns-3", pt.get_cname());
343 s4u::Engine::on_platform_created.connect([]() {
344 /* Create the ns3 topology based on routing strategy */
345 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
346 ns3::GlobalRouteManager::InitializeRoutes();
348 routing::on_cluster_creation.connect(&clusterCreation_cb);
349 s4u::NetZone::on_route_creation.connect(&routeCreation_cb);
350 s4u::NetZone::on_seal.connect(&zoneCreation_cb);
353 LinkImpl* NetworkNS3Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
354 s4u::Link::SharingPolicy policy)
356 xbt_assert(bandwidths.size() == 1, "ns-3 links must use only 1 bandwidth.");
357 return new LinkNS3(this, name, bandwidths[0], latency, policy);
360 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
362 xbt_assert(rate == -1,
363 "Communication over ns-3 links cannot specify a specific rate. Please use -1 as a value instead of %f.",
365 return new NetworkNS3Action(this, size, src, dst);
368 double NetworkNS3Model::next_occurring_event(double now)
370 double time_to_next_flow_completion = 0.0;
371 XBT_DEBUG("ns3_next_occurring_event");
373 //get the first relevant value from the running_actions list
375 // If there is no comms in NS-3, then we do not move it forward.
376 // We will synchronize NS-3 with SimGrid when starting a new communication.
377 // (see NetworkNS3Action::NetworkNS3Action() for more details on this point)
378 if (get_started_action_set()->empty() || now == 0.0)
381 XBT_DEBUG("doing a ns3 simulation for a duration of %f", now);
383 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
384 // NS-3 stops as soon as a flow ends,
385 // but it does not process the other flows that may finish at the same (simulated) time.
386 // If another flow ends at the same time, time_to_next_flow_completion = 0
387 if(double_equals(time_to_next_flow_completion, 0, sg_surf_precision))
388 time_to_next_flow_completion = 0.0;
390 XBT_DEBUG("min : %f", now);
391 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
392 XBT_DEBUG("surf time : %f", surf_get_clock());
393 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
395 return time_to_next_flow_completion;
398 void NetworkNS3Model::update_actions_state(double now, double delta)
400 static std::vector<std::string> socket_to_destroy;
402 std::string ns3_socket;
403 for (const auto& elm : flow_from_sock) {
404 ns3_socket = elm.first;
405 SgFlow* sgFlow = elm.second;
406 NetworkNS3Action * action = sgFlow->action_;
407 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
408 // Because NS3 stops as soon as a flow is finished, the other flows that ends at the same time may remains in an
409 // inconsistent state (i.e. remains_ == 0 but finished_ == false).
410 // However, SimGrid considers sometimes that an action with remains_ == 0 is finished.
411 // Thus, to avoid inconsistencies between SimGrid and NS3, set remains to 0 only when the flow is finished in NS3
412 int remains = action->get_cost() - sgFlow->sent_bytes_;
414 action->set_remains(remains);
416 if (TRACE_is_enabled() && action->get_state() == kernel::resource::Action::State::STARTED) {
417 double data_delta_sent = sgFlow->sent_bytes_ - action->last_sent_;
419 std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
421 action->get_src().route_to(&action->get_dst(), route, nullptr);
422 for (auto const& link : route)
423 instr::resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(),
424 (data_delta_sent) / delta, now - delta, delta);
426 action->last_sent_ = sgFlow->sent_bytes_;
429 if ((sgFlow->finished_) && (remains <= 0)) { // finished_ should not become true before remains gets to 0, but it sometimes does. Let's play safe, here.
430 socket_to_destroy.push_back(ns3_socket);
431 XBT_DEBUG("Destroy socket %s of action %p", ns3_socket.c_str(), action);
432 action->set_remains(0);
433 action->finish(Action::State::FINISHED);
435 XBT_DEBUG("Socket %s sent %u bytes out of %u (%u remaining)", ns3_socket.c_str(), sgFlow->sent_bytes_,
436 sgFlow->total_bytes_, sgFlow->remaining_);
440 while (not socket_to_destroy.empty()) {
441 ns3_socket = socket_to_destroy.back();
442 socket_to_destroy.pop_back();
443 SgFlow* flow = flow_from_sock.at(ns3_socket);
444 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
445 XBT_DEBUG("Removing socket %s of action %p", ns3_socket.c_str(), flow->action_);
448 flow_from_sock.erase(ns3_socket);
449 sink_from_sock.erase(ns3_socket);
457 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency,
458 s4u::Link::SharingPolicy policy)
459 : LinkImpl(model, name, nullptr), sharing_policy_(policy)
461 bandwidth_.peak = bandwidth;
462 latency_.peak = latency;
464 /* If wifi, create the wifizone now. If not, don't do anything: the links will be created in routeCreate_cb */
466 if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
467 static bool wifi_init = false;
469 initialize_ns3_wifi();
473 ns3::NetDeviceContainer netA;
474 WifiZone* zone = WifiZone::by_name(name);
475 xbt_assert(zone != nullptr, "Link name '%s' does not match the 'wifi_link' property of a host.", name.c_str());
476 auto* netpoint_ns3 = zone->get_host()->get_netpoint()->extension<NetPointNs3>();
478 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager", "ControlMode", ns3::StringValue("HtMcs0"), "DataMode",
479 ns3::StringValue("HtMcs" + std::to_string(zone->get_mcs())));
481 wifiPhy.SetChannel(zone->get_channel());
482 wifiPhy.Set("Antennas", ns3::UintegerValue(zone->get_nss()));
483 wifiPhy.Set("MaxSupportedTxSpatialStreams", ns3::UintegerValue(zone->get_nss()));
484 wifiPhy.Set("MaxSupportedRxSpatialStreams", ns3::UintegerValue(zone->get_nss()));
486 wifiMac.SetType("ns3::ApWifiMac",
487 "Ssid", ns3::SsidValue(name));
489 netA.Add(wifi.Install(wifiPhy, wifiMac, zone->get_ap_node()));
491 ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator>();
492 positionAllocS->Add(ns3::Vector(0, 0, 0));
493 mobility.SetPositionAllocator(positionAllocS);
494 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
495 mobility.Install(zone->get_ap_node());
497 ns3::Ipv4AddressHelper address;
498 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
499 address.SetBase(addr.c_str(), "255.255.0.0");
500 XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
501 auto addresses = address.Assign(netA);
502 zone->set_network(number_of_networks);
503 zone->set_link(number_of_links);
505 netpoint_ns3->ipv4_address_ = transformIpv4Address(addresses.GetAddress(1));
507 if (number_of_links == 255) {
508 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
510 number_of_networks++;
515 s4u::Link::on_creation(*this->get_iface());
518 LinkNS3::~LinkNS3() = default;
520 void LinkNS3::apply_event(profile::Event*, double)
524 void LinkNS3::set_bandwidth_profile(profile::Profile*)
526 xbt_die("The ns-3 network model doesn't support bandwidth profiles");
528 void LinkNS3::set_latency_profile(profile::Profile*)
530 xbt_die("The ns-3 network model doesn't support latency profiles");
537 NetworkNS3Action::NetworkNS3Action(Model* model, double totalBytes, s4u::Host* src, s4u::Host* dst)
538 : NetworkAction(model, *src, *dst, totalBytes, false)
540 // If there is no other started actions, we need to move NS-3 forward to be sync with SimGrid
541 if (model->get_started_action_set()->size()==1){
542 while(double_positive(surf_get_clock() - ns3::Simulator::Now().GetSeconds(), sg_surf_precision)){
543 XBT_DEBUG("Synchronizing NS-3 (time %f) with SimGrid (time %f)", ns3::Simulator::Now().GetSeconds(), surf_get_clock());
544 ns3_simulator(surf_get_clock() - ns3::Simulator::Now().GetSeconds());
548 static int port_number = 1025; // Port number is limited from 1025 to 65 000
550 ns3::Ptr<ns3::Node> src_node = src->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
551 ns3::Ptr<ns3::Node> dst_node = dst->get_netpoint()->extension<NetPointNs3>()->ns3_node_;
553 std::string& addr = dst->get_netpoint()->extension<NetPointNs3>()->ipv4_address_;
554 xbt_assert(not addr.empty(), "Element %s is unknown to ns-3. Is it connected to any one-hop link?",
555 dst->get_netpoint()->get_cname());
557 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress(ns3::Ipv4Address::GetAny(), port_number));
558 ns3::ApplicationContainer apps = sink.Install(dst_node);
560 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
562 XBT_DEBUG("Create socket %s for a flow of %.0f Bytes from %s to %s with Interface %s",
563 transform_socket_ptr(sock).c_str(), totalBytes, src->get_cname(), dst->get_cname(), addr.c_str());
565 flow_from_sock.insert({transform_socket_ptr(sock), new SgFlow(totalBytes, this)});
566 sink_from_sock.insert({transform_socket_ptr(sock), apps});
568 sock->Bind(ns3::InetSocketAddress(port_number));
570 ns3::Simulator::ScheduleNow(&start_flow, sock, addr.c_str(), port_number);
573 if(port_number > 65000){
575 XBT_WARN("Too many connections! Port number is saturated. Trying to use the oldest ports.");
578 s4u::Link::on_communicate(*this);
581 void NetworkNS3Action::suspend() {
585 void NetworkNS3Action::resume() {
589 std::list<LinkImpl*> NetworkNS3Action::get_links() const
593 void NetworkNS3Action::update_remains_lazy(double /*now*/)
598 } // namespace resource
599 } // namespace kernel
600 } // namespace simgrid
602 void ns3_simulator(double maxSeconds)
605 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
606 id = ns3::Simulator::Schedule(ns3::Seconds(maxSeconds), &ns3::Simulator::Stop);
608 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
609 ns3::Simulator::Run ();
610 XBT_DEBUG("Simulator stopped at %fs", ns3::Simulator::Now().GetSeconds());
616 void ns3_add_direct_route(simgrid::kernel::routing::NetPoint* src, simgrid::kernel::routing::NetPoint* dst, double bw,
617 double lat, const std::string& link_name, simgrid::s4u::Link::SharingPolicy policy)
619 ns3::Ipv4AddressHelper address;
620 ns3::NetDeviceContainer netA;
623 auto* host_src = src->extension<NetPointNs3>();
624 auto* host_dst = dst->extension<NetPointNs3>();
626 xbt_assert(host_src != nullptr, "Network element %s does not seem to be ns-3-ready", src->get_cname());
627 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be ns-3-ready", dst->get_cname());
629 if (policy == simgrid::s4u::Link::SharingPolicy::WIFI) {
630 auto a = host_src->ns3_node_;
631 auto b = host_dst->ns3_node_;
632 xbt_assert(WifiZone::is_ap(a) != WifiZone::is_ap(b),
633 "A wifi route can only exist between an access point node and a station node.");
635 ns3::Ptr<ns3::Node> apNode = WifiZone::is_ap(a) ? a : b;
636 ns3::Ptr<ns3::Node> staNode = apNode == a ? b : a;
638 WifiZone* zone = WifiZone::by_name(link_name);
640 wifi.SetRemoteStationManager("ns3::ConstantRateWifiManager", "ControlMode", ns3::StringValue("HtMcs0"), "DataMode",
641 ns3::StringValue("HtMcs" + std::to_string(zone->get_mcs())));
643 wifiPhy.SetChannel(zone->get_channel());
644 wifiPhy.Set("Antennas", ns3::UintegerValue(zone->get_nss()));
645 wifiPhy.Set("MaxSupportedTxSpatialStreams", ns3::UintegerValue(zone->get_nss()));
646 wifiPhy.Set("MaxSupportedRxSpatialStreams", ns3::UintegerValue(zone->get_nss()));
648 wifiMac.SetType ("ns3::StaWifiMac",
649 "Ssid", ns3::SsidValue(link_name),
650 "ActiveProbing", ns3::BooleanValue(false));
652 netA.Add(wifi.Install(wifiPhy, wifiMac, staNode));
654 ns3::Config::Set("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", ns3::UintegerValue(40));
656 simgrid::kernel::routing::NetPoint* sta_netpoint = WifiZone::is_ap(host_src->ns3_node_) ? dst : src;
657 const char* wifi_distance = simgrid::s4u::Host::by_name(sta_netpoint->get_name())->get_property("wifi_distance");
658 ns3::Ptr<ns3::ListPositionAllocator> positionAllocS = ns3::CreateObject<ns3::ListPositionAllocator>();
659 positionAllocS->Add(ns3::Vector(wifi_distance ? atof(wifi_distance) : 10.0, 0, 0));
660 mobility.SetPositionAllocator(positionAllocS);
661 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
662 mobility.Install(staNode);
664 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", zone->get_network(), zone->get_link());
665 address.SetBase(addr.c_str(), "255.255.0.0", ("0.0.0." + std::to_string(zone->get_n_sta_nodes() + 2)).c_str());
666 zone->add_sta_node();
667 XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
668 auto addresses = address.Assign(netA);
669 host_dst->ipv4_address_ = transformIpv4Address(addresses.GetAddress(1));
671 ns3::PointToPointHelper pointToPoint;
673 XBT_DEBUG("\tAdd PTP from %s to %s bw:'%f Bps' lat:'%fs'", src->get_cname(), dst->get_cname(), bw, lat);
674 pointToPoint.SetDeviceAttribute("DataRate",
675 ns3::DataRateValue(ns3::DataRate(bw * 8))); // ns-3 takes bps, but we provide Bps
676 pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
678 netA.Add(pointToPoint.Install(host_src->ns3_node_, host_dst->ns3_node_));
680 std::string addr = simgrid::xbt::string_printf("%d.%d.0.0", number_of_networks, number_of_links);
681 address.SetBase(addr.c_str(), "255.255.0.0");
682 XBT_DEBUG("\tInterface stack '%s'", addr.c_str());
684 auto addresses = address.Assign(netA);
686 host_src->ipv4_address_ = transformIpv4Address(addresses.GetAddress(0));
687 host_dst->ipv4_address_ = transformIpv4Address(addresses.GetAddress(1));
689 if (number_of_links == 255) {
690 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
692 number_of_networks++;