1 /* Copyright (c) 2007-2017. 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. */
6 #include <unordered_set>
8 #include "xbt/config.hpp"
10 #include "ns3/core-module.h"
13 #include "network_ns3.hpp"
14 #include "ns3/ns3_simulator.hpp"
16 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
17 #include "src/kernel/routing/NetPoint.hpp"
19 #include "simgrid/s4u/Engine.hpp"
20 #include "simgrid/s4u/NetZone.hpp"
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
24 std::vector<char*> IPV4addr;
30 extern xbt_dict_t flowFromSock;
32 static ns3::InternetStackHelper stack;
33 static ns3::NodeContainer nodes;
34 static ns3::NodeContainer Cluster_nodes;
35 static ns3::Ipv4InterfaceContainer interfaces;
37 static int number_of_nodes = 0;
38 static int number_of_clusters_nodes = 0;
39 static int number_of_links = 1;
40 static int number_of_networks = 1;
41 static int port_number = 1025; //Port number is limited from 1025 to 65 000
43 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
45 NetPointNs3::NetPointNs3()
47 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
50 node_num = number_of_nodes++;
57 static void clusterCreation_cb(ClusterCreationArgs* cluster)
59 for (int const& i : *cluster->radicals) {
60 // Routers don't create a router on the other end of the private link by themselves.
61 // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
62 NetPointNs3* host_dst = new NetPointNs3();
64 // Create private link
65 std::string host_id = cluster->prefix + std::to_string(i) + cluster->suffix;
66 NetPointNs3* host_src = sg_host_by_name(host_id.c_str())->pimpl_netpoint->extension<NetPointNs3>();
67 xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id.c_str());
69 // Any NS3 route is symmetrical
70 ns3_add_link(host_src, host_dst, cluster->bw, cluster->lat);
75 //Create link backbone
76 ns3_add_cluster(cluster->id.c_str(), cluster->bb_bw, cluster->bb_lat);
79 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
80 simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
81 simgrid::kernel::routing::NetPoint* gw_dst,
82 std::vector<simgrid::surf::LinkImpl*>* link_list)
84 if (link_list->size() == 1) {
85 simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
87 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->getCname(), dst->getCname(), link->getCname(),
88 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
90 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
91 XBT_DEBUG("\tLink (%s) bw:%fbps lat:%fs", link->getCname(), link->bandwidth(), link->latency());
94 NetPointNs3* host_src = src->extension<NetPointNs3>();
95 NetPointNs3* host_dst = dst->extension<NetPointNs3>();
97 xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->getCname());
98 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->getCname());
100 ns3_add_link(host_src, host_dst, link->bandwidth(), link->latency());
102 static bool warned_about_long_routes = false;
104 if (not warned_about_long_routes)
105 XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with NS3.\n"
106 "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
108 "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
110 src->getCname(), dst->getCname(), link_list->size());
111 warned_about_long_routes = true;
115 /* Create the ns3 topology based on routing strategy */
116 static void postparse_cb()
118 IPV4addr.shrink_to_fit();
120 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
121 ns3::GlobalRouteManager::InitializeRoutes();
127 void surf_network_model_init_NS3()
129 if (surf_network_model)
132 surf_network_model = new simgrid::surf::NetworkNS3Model();
133 all_existing_models->push_back(surf_network_model);
136 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
137 "The ns3 tcp model can be : NewReno or Reno or Tahoe", "NewReno");
142 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
143 NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
145 flowFromSock = xbt_dict_new_homogeneous([](void* p) { delete static_cast<SgFlow*>(p); });
146 ns3_initialize(ns3_tcp_model.get().c_str());
148 simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint* pt) {
149 pt->extension_set<NetPointNs3>(new NetPointNs3());
150 XBT_VERB("SimGrid's %s is known as node %d within NS3", pt->getCname(), pt->extension<NetPointNs3>()->node_num);
152 simgrid::surf::on_cluster.connect(&clusterCreation_cb);
153 simgrid::s4u::onPlatformCreated.connect(&postparse_cb);
154 simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
156 LogComponentEnable("PacketSink", ns3::LOG_LEVEL_INFO);
157 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
158 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
161 NetworkNS3Model::~NetworkNS3Model() {
162 for (auto const& addr : IPV4addr)
165 xbt_dict_free(&flowFromSock);
168 LinkImpl* NetworkNS3Model::createLink(const std::string& name, double bandwidth, double latency,
169 e_surf_link_sharing_policy_t policy)
171 return new LinkNS3(this, name, bandwidth, latency);
174 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
176 return new NetworkNS3Action(this, size, src, dst);
179 double NetworkNS3Model::nextOccuringEvent(double now)
181 double time_to_next_flow_completion;
182 XBT_DEBUG("ns3_next_occuring_event");
184 //get the first relevant value from the running_actions list
185 if (not getRunningActionSet()->size() || now == 0.0)
190 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
191 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
193 XBT_DEBUG("min : %f", now);
194 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
195 XBT_DEBUG("surf time : %f", surf_get_clock());
196 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
198 return time_to_next_flow_completion;
201 void NetworkNS3Model::updateActionsState(double now, double delta)
203 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
205 /* If there are no running flows, advance the NS3 simulator and return */
206 if (getRunningActionSet()->empty()) {
208 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
209 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
214 xbt_dict_cursor_t cursor = nullptr;
217 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
218 NetworkNS3Action * action = sgFlow->action_;
219 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
220 action->setRemains(action->getCost() - sgFlow->sentBytes_);
222 if (TRACE_is_enabled() &&
223 action->getState() == Action::State::running){
224 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
226 std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
228 action->src_->routeTo(action->dst_, &route, nullptr);
229 for (auto const& link : route)
230 TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
233 action->lastSent_ = sgFlow->sentBytes_;
236 if(sgFlow->finished_){
237 xbt_dynar_push(socket_to_destroy,&ns3Socket);
238 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
239 action->finish(Action::State::done);
243 while (not xbt_dynar_is_empty(socket_to_destroy)) {
244 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
246 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
247 SgFlow* flow = static_cast<SgFlow*>(xbt_dict_get(flowFromSock, ns3Socket));
248 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
250 xbt_dict_remove(flowFromSock, ns3Socket);
258 LinkNS3::LinkNS3(NetworkNS3Model* model, const std::string& name, double bandwidth, double latency)
259 : LinkImpl(model, name, nullptr)
261 bandwidth_.peak = bandwidth;
262 latency_.peak = latency;
264 s4u::Link::onCreation(this->piface_);
267 LinkNS3::~LinkNS3() = default;
269 void LinkNS3::apply_event(tmgr_trace_event_t event, double value)
273 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
274 xbt_die("The NS3 network model doesn't support bandwidth traces");
276 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
277 xbt_die("The NS3 network model doesn't support latency traces");
284 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
285 : NetworkAction(model, size, false)
287 XBT_DEBUG("Communicate from %s to %s", src->getCname(), dst->getCname());
291 ns3_create_flow(src, dst, size, this);
293 s4u::Link::onCommunicate(this, src, dst);
296 void NetworkNS3Action::suspend() {
300 void NetworkNS3Action::resume() {
304 std::list<LinkImpl*> NetworkNS3Action::links()
309 /* Test whether a flow is suspended */
310 bool NetworkNS3Action::isSuspended()
315 int NetworkNS3Action::unref()
319 if (action_hook.is_linked())
320 stateSet_->erase(stateSet_->iterator_to(*this));
321 XBT_DEBUG ("Removing action %p", this);
331 void ns3_simulator(double maxSeconds)
333 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
334 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
335 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
336 ns3::Simulator::Run ();
339 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst,
340 u_int32_t TotalBytes,
341 simgrid::surf::NetworkNS3Action* action) {
342 unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
343 unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
345 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
346 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
348 xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
349 dst->pimpl_netpoint->getCname());
350 char* addr = IPV4addr.at(node2);
351 xbt_assert(addr != nullptr, "Element %s is unknown to NS3. Is it connected to any one-hop link?",
352 dst->pimpl_netpoint->getCname());
354 XBT_DEBUG("ns3_create_flow %u Bytes from %u to %u with Interface %s", TotalBytes, node1, node2, addr);
355 ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
356 sink.Install (dst_node);
358 ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket(src_node, ns3::TcpSocketFactory::GetTypeId());
360 xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr);
362 sock->Bind(ns3::InetSocketAddress(port_number));
364 ns3::Simulator::ScheduleNow(&StartFlow, sock, addr, port_number);
367 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
370 // initialize the NS3 interface and environment
371 void ns3_initialize(const char* TcpProtocol){
377 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1000));
378 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
379 ns3::Config::SetDefault ("ns3::TcpSocketBase::Timestamp", ns3::BooleanValue (false));
381 if (not strcmp(TcpProtocol, "default"))
384 if (not strcmp(TcpProtocol, "Reno")) {
385 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
386 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
389 if (not strcmp(TcpProtocol, "NewReno")) {
390 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
391 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
394 if (not strcmp(TcpProtocol, "Tahoe")) {
395 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
396 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
400 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
403 void ns3_add_cluster(const char* id, double bw, double lat) {
404 ns3::NodeContainer Nodes;
406 for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
407 Nodes.Add(Cluster_nodes.Get(i));
408 XBT_DEBUG("Add node %u to cluster", i);
410 number_of_clusters_nodes = Cluster_nodes.GetN();
412 XBT_DEBUG("Add router %u to cluster", nodes.GetN() - Nodes.GetN() - 1);
413 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
415 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
416 ns3::CsmaHelper csma;
417 csma.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
418 csma.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
419 ns3::NetDeviceContainer devices = csma.Install(Nodes);
420 XBT_DEBUG("Create CSMA");
422 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
423 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
424 ns3::Ipv4AddressHelper ipv4;
425 ipv4.SetBase (adr, "255.255.0.0");
427 interfaces.Add(ipv4.Assign (devices));
429 if(number_of_links == 255){
430 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
432 number_of_networks++;
436 XBT_DEBUG("Number of nodes in Cluster_nodes: %u", Cluster_nodes.GetN());
439 static char* transformIpv4Address (ns3::Ipv4Address from){
440 std::stringstream sstream;
442 std::string s = sstream.str();
443 return bprintf("%s",s.c_str());
446 void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, double bw, double lat) {
447 ns3::PointToPointHelper pointToPoint;
449 ns3::Ipv4AddressHelper address;
451 int srcNum = src->node_num;
452 int dstNum = dst->node_num;
454 ns3::Ptr<ns3::Node> a = nodes.Get(srcNum);
455 ns3::Ptr<ns3::Node> b = nodes.Get(dstNum);
457 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%f Bps' lat:'%fs'", srcNum, dstNum, bw, lat);
458 pointToPoint.SetDeviceAttribute("DataRate", ns3::DataRateValue(ns3::DataRate(bw*8)));// NS3 takes bps, but we provide Bps
459 pointToPoint.SetChannelAttribute("Delay", ns3::TimeValue(ns3::Seconds(lat)));
461 char *filename = bprintf("link-%d-%d.tr", srcNum, dstNum);
462 ns3::AsciiTraceHelper ascii;
463 pointToPoint.EnableAsciiAll (ascii.CreateFileStream (filename));
464 pointToPoint.EnablePcapAll ("tcp-bulk-send", false);
467 ns3::NetDeviceContainer netA;
468 netA.Add(pointToPoint.Install (a, b));
470 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
471 address.SetBase (adr, "255.255.0.0");
472 XBT_DEBUG("\tInterface stack '%s'",adr);
474 interfaces.Add(address.Assign (netA));
476 if (IPV4addr.size() <= (unsigned)srcNum)
477 IPV4addr.resize(srcNum + 1, nullptr);
478 IPV4addr.at(srcNum) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
480 if (IPV4addr.size() <= (unsigned)dstNum)
481 IPV4addr.resize(dstNum + 1, nullptr);
482 IPV4addr.at(dstNum) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
484 if (number_of_links == 255){
485 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
487 number_of_networks++;