1 /* Copyright (c) 2007-2016. 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 "ns3/ns3_interface.h"
14 #include "ns3/ns3_simulator.h"
15 #include "network_ns3.hpp"
17 #include "simgrid/sg_config.h"
18 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
19 #include "src/kernel/routing/NetCard.hpp"
20 #include "src/surf/HostImpl.hpp"
21 #include "src/surf/surf_private.h"
23 #include "simgrid/s4u/NetZone.hpp"
24 #include "simgrid/s4u/engine.hpp"
26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
28 std::vector<char*> IPV4addr;
34 extern xbt_dict_t flowFromSock;
36 static ns3::InternetStackHelper stack;
37 static ns3::NodeContainer nodes;
38 static ns3::NodeContainer Cluster_nodes;
39 static ns3::Ipv4InterfaceContainer interfaces;
41 static int number_of_nodes = 0;
42 static int number_of_clusters_nodes = 0;
43 static int number_of_links = 1;
44 static int number_of_networks = 1;
45 static int port_number = 1025; //Port number is limited from 1025 to 65 000
47 simgrid::xbt::Extension<simgrid::kernel::routing::NetCard, NetCardNs3> NetCardNs3::EXTENSION_ID;
49 NetCardNs3::NetCardNs3()
51 ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
54 node_num = number_of_nodes++;
61 static void netcardCreation_cb(simgrid::kernel::routing::NetCard* netcard)
63 netcard->extension_set<NetCardNs3>(new NetCardNs3());
66 static void clusterCreation_cb(sg_platf_cluster_cbarg_t cluster)
68 char* lat = bprintf("%fs", cluster->lat);
69 char* bw = bprintf("%fBps", cluster->bw);
71 for (int i : *cluster->radicals) {
72 // Routers don't create a router on the other end of the private link by themselves.
73 // We just need this router to be given an ID so we create a temporary NetCardNS3 so that it gets one
74 NetCardNs3* host_dst = new NetCardNs3();
76 // Create private link
77 char* host_id = bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
78 NetCardNs3* host_src = sg_host_by_name(host_id)->pimpl_netcard->extension<NetCardNs3>();
79 xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id);
81 ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
89 //Create link backbone
90 lat = bprintf("%fs", cluster->bb_lat);
91 bw = bprintf("%fBps", cluster->bb_bw);
92 ns3_add_cluster(cluster->id, bw, lat);
97 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetCard* src,
98 simgrid::kernel::routing::NetCard* dst, simgrid::kernel::routing::NetCard* gw_src,
99 simgrid::kernel::routing::NetCard* gw_dst, std::vector<Link*>* link_list)
101 if (link_list->size() == 1) {
102 simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
104 XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->cname(), dst->cname(), link->getName(),
105 (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
106 char* link_bdw = bprintf("%fBps", link->bandwidth());
107 char* link_lat = bprintf("%fs", link->latency());
109 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
110 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
113 NetCardNs3* host_src = src->extension<NetCardNs3>();
114 NetCardNs3* host_dst = dst->extension<NetCardNs3>();
116 xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->cname());
117 xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->cname());
119 ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
121 ns3_add_link(host_dst->node_num, host_src->node_num, link_bdw, link_lat);
128 /* Create the ns3 topology based on routing strategy */
129 static void postparse_cb(void)
131 IPV4addr.shrink_to_fit();
133 ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
134 ns3::GlobalRouteManager::InitializeRoutes();
140 void surf_network_model_init_NS3()
142 if (surf_network_model)
145 surf_network_model = new simgrid::surf::NetworkNS3Model();
146 all_existing_models->push_back(surf_network_model);
149 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
150 "The ns3 tcp model can be : NewReno or Reno or Tahoe",
156 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
157 NetCardNs3::EXTENSION_ID = simgrid::kernel::routing::NetCard::extension_create<NetCardNs3>();
159 ns3_initialize(ns3_tcp_model.get().c_str());
161 simgrid::kernel::routing::NetCard::onCreation.connect(&netcardCreation_cb);
162 simgrid::surf::on_cluster.connect(&clusterCreation_cb);
163 simgrid::surf::on_postparse.connect(&postparse_cb);
164 simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
166 LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
167 LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
170 NetworkNS3Model::~NetworkNS3Model() {
171 for (auto addr : IPV4addr)
174 xbt_dict_free(&flowFromSock);
177 Link* NetworkNS3Model::createLink(const char* name, double bandwidth, double latency,
178 e_surf_link_sharing_policy_t policy)
180 return new LinkNS3(this, name, bandwidth, latency);
183 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
185 return new NetworkNS3Action(this, size, src, dst);
188 double NetworkNS3Model::nextOccuringEvent(double now)
190 double time_to_next_flow_completion;
191 XBT_DEBUG("ns3_next_occuring_event");
193 //get the first relevant value from the running_actions list
194 if (!getRunningActionSet()->size() || now == 0.0)
199 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
200 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
202 XBT_DEBUG("min : %f", now);
203 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
204 XBT_DEBUG("surf time : %f", surf_get_clock());
205 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
207 return time_to_next_flow_completion;
210 void NetworkNS3Model::updateActionsState(double now, double delta)
212 static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
214 /* If there are no running flows, advance the NS3 simulator and return */
215 if (getRunningActionSet()->empty()) {
217 while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
218 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
223 xbt_dict_cursor_t cursor = nullptr;
226 xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
227 NetworkNS3Action * action = sgFlow->action_;
228 XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
229 action->setRemains(action->getCost() - sgFlow->sentBytes_);
231 if (TRACE_is_enabled() &&
232 action->getState() == Action::State::running){
233 double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
235 std::vector<Link*> route = std::vector<Link*>();
237 action->src_->routeTo(action->dst_, &route, nullptr);
238 for (auto link : route)
239 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
241 action->lastSent_ = sgFlow->sentBytes_;
244 if(sgFlow->finished_){
245 xbt_dynar_push(socket_to_destroy,&ns3Socket);
246 XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
248 action->setState(Action::State::done);
252 while (!xbt_dynar_is_empty(socket_to_destroy)){
253 xbt_dynar_pop(socket_to_destroy,&ns3Socket);
255 if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
256 SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
257 XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
259 xbt_dict_remove(flowFromSock, ns3Socket);
267 LinkNS3::LinkNS3(NetworkNS3Model* model, const char* name, double bandwidth, double latency)
268 : Link(model, name, nullptr)
270 bandwidth_.peak = bandwidth;
271 latency_.peak = latency;
273 Link::onCreation(this);
276 LinkNS3::~LinkNS3() = default;
278 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
282 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
283 xbt_die("The NS3 network model doesn't support bandwidth traces");
285 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
286 xbt_die("The NS3 network model doesn't support latency traces");
293 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
294 : NetworkAction(model, size, false)
296 XBT_DEBUG("Communicate from %s to %s", src->cname(), dst->cname());
300 ns3_create_flow(src, dst, surf_get_clock(), size, this);
302 Link::onCommunicate(this, src, dst);
305 void NetworkNS3Action::suspend() {
309 void NetworkNS3Action::resume() {
313 /* Test whether a flow is suspended */
314 bool NetworkNS3Action::isSuspended()
319 int NetworkNS3Action::unref()
323 if (action_hook.is_linked())
324 stateSet_->erase(stateSet_->iterator_to(*this));
325 XBT_DEBUG ("Removing action %p", this);
335 void ns3_simulator(double maxSeconds)
337 if (maxSeconds > 0.0) // If there is a maximum amount of time to run
338 ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
339 XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
340 ns3::Simulator::Run ();
343 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double startTime, u_int32_t TotalBytes,
344 simgrid::surf::NetworkNS3Action* action)
346 int node1 = src->pimpl_netcard->extension<NetCardNs3>()->node_num;
347 int node2 = dst->pimpl_netcard->extension<NetCardNs3>()->node_num;
349 ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
350 ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
352 char* addr = IPV4addr.at(node2);
354 XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d 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));
363 XBT_DEBUG("Create flow starting to %fs + %fs = %fs",
364 startTime-ns3::Simulator::Now().GetSeconds(), ns3::Simulator::Now().GetSeconds(), startTime);
366 ns3::Simulator::Schedule (ns3::Seconds(startTime-ns3::Simulator::Now().GetSeconds()),
367 &StartFlow, sock, addr, port_number);
370 xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
373 // initialize the NS3 interface and environment
374 void ns3_initialize(const char* TcpProtocol){
380 ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
381 ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
383 if (!strcmp(TcpProtocol,"default"))
386 if (!strcmp(TcpProtocol,"Reno")) {
387 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
388 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
391 if (!strcmp(TcpProtocol,"NewReno")) {
392 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
393 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
396 if(!strcmp(TcpProtocol,"Tahoe")){
397 XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
398 ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
402 xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
405 void ns3_add_cluster(const char* id, char* bw, char* lat)
407 ns3::NodeContainer Nodes;
409 for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
410 Nodes.Add(Cluster_nodes.Get(i));
411 XBT_DEBUG("Add node %d to cluster",i);
413 number_of_clusters_nodes = Cluster_nodes.GetN();
415 XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
416 Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
418 xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
419 ns3::CsmaHelper csma;
420 csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
421 csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
422 ns3::NetDeviceContainer devices = csma.Install (Nodes);
423 XBT_DEBUG("Create CSMA");
425 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
426 XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
427 ns3::Ipv4AddressHelper ipv4;
428 ipv4.SetBase (adr, "255.255.0.0");
430 interfaces.Add(ipv4.Assign (devices));
432 if(number_of_links == 255){
433 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
435 number_of_networks++;
439 XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
442 static char* transformIpv4Address (ns3::Ipv4Address from){
443 std::stringstream sstream;
445 std::string s = sstream.str();
446 return bprintf("%s",s.c_str());
449 void ns3_add_link(int src, int dst, char *bw, char *lat)
451 ns3::PointToPointHelper pointToPoint;
453 ns3::NetDeviceContainer netA;
454 ns3::Ipv4AddressHelper address;
456 ns3::Ptr<ns3::Node> a = nodes.Get(src);
457 ns3::Ptr<ns3::Node> b = nodes.Get(dst);
459 XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
460 pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
461 pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
463 netA.Add(pointToPoint.Install (a, b));
465 char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
466 address.SetBase (adr, "255.255.0.0");
467 XBT_DEBUG("\tInterface stack '%s'",adr);
469 interfaces.Add(address.Assign (netA));
471 if (IPV4addr.size() <= (unsigned)src)
472 IPV4addr.resize(src + 1, nullptr);
473 IPV4addr.at(src) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
475 if (IPV4addr.size() <= (unsigned)dst)
476 IPV4addr.resize(dst + 1, nullptr);
477 IPV4addr.at(dst) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
479 if (number_of_links == 255){
480 xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
482 number_of_networks++;