src/surf/network_ns3.cpp

   1 /* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #include <unordered_set>
   7
   8 #include "xbt/config.hpp"
   9
  10 #include "ns3/core-module.h"
  11 #include "ns3/node.h"
  12
  13 #include "ns3/ns3_simulator.h"
  14 #include "network_ns3.hpp"
  15
  16 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  17 #include "src/kernel/routing/NetPoint.hpp"
  18
  19 #include "simgrid/s4u/Engine.hpp"
  20 #include "simgrid/s4u/NetZone.hpp"
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
  23
  24 std::vector<char*> IPV4addr;
  25
  26 /*****************
  27  * Crude globals *
  28  *****************/
  29
  30 extern xbt_dict_t flowFromSock;
  31
  32 static ns3::InternetStackHelper stack;
  33 static ns3::NodeContainer nodes;
  34 static ns3::NodeContainer Cluster_nodes;
  35 static ns3::Ipv4InterfaceContainer interfaces;
  36
  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
  42
  43 simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
  44
  45 NetPointNs3::NetPointNs3()
  46 {
  47   ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
  48   stack.Install(node);
  49   nodes.Add(node);
  50   node_num = number_of_nodes++;
  51 }
  52
  53 /*************
  54  * Callbacks *
  55  *************/
  56
  57 static void clusterCreation_cb(sg_platf_cluster_cbarg_t cluster)
  58 {
  59   char* lat = bprintf("%fs", cluster->lat);
  60   char* bw  = bprintf("%fBps", cluster->bw);
  61
  62   for (int i : *cluster->radicals) {
  63     // Routers don't create a router on the other end of the private link by themselves.
  64     // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
  65     NetPointNs3* host_dst = new NetPointNs3();
  66
  67     // Create private link
  68     char* host_id = bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
  69     NetPointNs3* host_src = sg_host_by_name(host_id)->pimpl_netpoint->extension<NetPointNs3>();
  70     xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id);
  71
  72     ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
  73
  74     delete host_dst;
  75     free(host_id);
  76   }
  77   xbt_free(lat);
  78   xbt_free(bw);
  79
  80   //Create link backbone
  81   lat = bprintf("%fs", cluster->bb_lat);
  82   bw =  bprintf("%fBps", cluster->bb_bw);
  83   ns3_add_cluster(cluster->id, bw, lat);
  84   xbt_free(lat);
  85   xbt_free(bw);
  86 }
  87
  88 static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
  89                              simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
  90                              simgrid::kernel::routing::NetPoint* gw_dst,
  91                              std::vector<simgrid::surf::LinkImpl*>* link_list)
  92 {
  93   if (link_list->size() == 1) {
  94     simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
  95
  96     XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->cname(), dst->cname(), link->cname(),
  97               (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
  98     char* link_bdw = bprintf("%fBps", link->bandwidth());
  99     char* link_lat = bprintf("%fs", link->latency());
 100
 101     //   XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
 102     XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->cname(), link_bdw, link_lat);
 103
 104     // create link ns3
 105     NetPointNs3* host_src = src->extension<NetPointNs3>();
 106     NetPointNs3* host_dst = dst->extension<NetPointNs3>();
 107
 108     xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->cname());
 109     xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->cname());
 110
 111     ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
 112     if (symmetrical)
 113       ns3_add_link(host_dst->node_num, host_src->node_num, link_bdw, link_lat);
 114
 115     xbt_free(link_bdw);
 116     xbt_free(link_lat);
 117   }
 118 }
 119
 120 /* Create the ns3 topology based on routing strategy */
 121 static void postparse_cb(void)
 122 {
 123   IPV4addr.shrink_to_fit();
 124
 125   ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
 126   ns3::GlobalRouteManager::InitializeRoutes();
 127 }
 128
 129 /*********
 130  * Model *
 131  *********/
 132 void surf_network_model_init_NS3()
 133 {
 134   if (surf_network_model)
 135     return;
 136
 137   surf_network_model = new simgrid::surf::NetworkNS3Model();
 138   all_existing_models->push_back(surf_network_model);
 139 }
 140
 141 static simgrid::config::Flag<std::string> ns3_tcp_model("ns3/TcpModel",
 142   "The ns3 tcp model can be : NewReno or Reno or Tahoe",
 143   "default");
 144
 145 namespace simgrid {
 146 namespace surf {
 147
 148 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
 149   NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
 150
 151   ns3_initialize(ns3_tcp_model.get().c_str());
 152
 153   simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint* pt) {
 154     pt->extension_set<NetPointNs3>(new NetPointNs3());
 155
 156   });
 157   simgrid::surf::on_cluster.connect(&clusterCreation_cb);
 158   simgrid::s4u::onPlatformCreated.connect(&postparse_cb);
 159   simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
 160
 161   LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
 162   LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
 163 }
 164
 165 NetworkNS3Model::~NetworkNS3Model() {
 166   for (auto addr : IPV4addr)
 167     free(addr);
 168   IPV4addr.clear();
 169   xbt_dict_free(&flowFromSock);
 170 }
 171
 172 LinkImpl* NetworkNS3Model::createLink(const char* name, double bandwidth, double latency,
 173                                       e_surf_link_sharing_policy_t policy)
 174 {
 175   return new LinkNS3(this, name, bandwidth, latency);
 176 }
 177
 178 Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 179 {
 180   return new NetworkNS3Action(this, size, src, dst);
 181 }
 182
 183 double NetworkNS3Model::nextOccuringEvent(double now)
 184 {
 185   double time_to_next_flow_completion;
 186   XBT_DEBUG("ns3_next_occuring_event");
 187
 188   //get the first relevant value from the running_actions list
 189   if (!getRunningActionSet()->size() || now == 0.0)
 190     return -1.0;
 191   else
 192     do {
 193       ns3_simulator(now);
 194       time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();
 195     } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
 196
 197   XBT_DEBUG("min       : %f", now);
 198   XBT_DEBUG("ns3  time : %f", ns3::Simulator::Now().GetSeconds());
 199   XBT_DEBUG("surf time : %f", surf_get_clock());
 200   XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
 201
 202   return time_to_next_flow_completion;
 203 }
 204
 205 void NetworkNS3Model::updateActionsState(double now, double delta)
 206 {
 207   static xbt_dynar_t socket_to_destroy = xbt_dynar_new(sizeof(char*),nullptr);
 208
 209   /* If there are no running flows, advance the NS3 simulator and return */
 210   if (getRunningActionSet()->empty()) {
 211
 212     while(double_positive(now - ns3::Simulator::Now().GetSeconds(), sg_surf_precision))
 213       ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
 214
 215     return;
 216   }
 217
 218   xbt_dict_cursor_t cursor = nullptr;
 219   char *ns3Socket;
 220   SgFlow *sgFlow;
 221   xbt_dict_foreach(flowFromSock,cursor,ns3Socket,sgFlow){
 222     NetworkNS3Action * action = sgFlow->action_;
 223     XBT_DEBUG("Processing socket %p (action %p)",sgFlow,action);
 224     action->setRemains(action->getCost() - sgFlow->sentBytes_);
 225
 226     if (TRACE_is_enabled() &&
 227         action->getState() == Action::State::running){
 228       double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
 229
 230       std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
 231
 232       action->src_->routeTo(action->dst_, &route, nullptr);
 233       for (auto link : route)
 234         TRACE_surf_link_set_utilization(link->cname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
 235                                         delta);
 236
 237       action->lastSent_ = sgFlow->sentBytes_;
 238     }
 239
 240     if(sgFlow->finished_){
 241       xbt_dynar_push(socket_to_destroy,&ns3Socket);
 242       XBT_DEBUG("Destroy socket %p of action %p", ns3Socket, action);
 243       action->finish();
 244       action->setState(Action::State::done);
 245     }
 246   }
 247
 248   while (!xbt_dynar_is_empty(socket_to_destroy)){
 249     xbt_dynar_pop(socket_to_destroy,&ns3Socket);
 250
 251     if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
 252       SgFlow *flow = (SgFlow*)xbt_dict_get (flowFromSock, ns3Socket);
 253       XBT_DEBUG ("Removing socket %p of action %p", ns3Socket, flow->action_);
 254     }
 255     xbt_dict_remove(flowFromSock, ns3Socket);
 256   }
 257 }
 258
 259 /************
 260  * Resource *
 261  ************/
 262
 263 LinkNS3::LinkNS3(NetworkNS3Model* model, const char* name, double bandwidth, double latency)
 264     : LinkImpl(model, name, nullptr)
 265 {
 266   bandwidth_.peak = bandwidth;
 267   latency_.peak   = latency;
 268
 269   s4u::Link::onCreation(this->piface_);
 270 }
 271
 272 LinkNS3::~LinkNS3() = default;
 273
 274 void LinkNS3::apply_event(tmgr_trace_event_t event, double value)
 275 {
 276   THROW_UNIMPLEMENTED;
 277 }
 278 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
 279   xbt_die("The NS3 network model doesn't support bandwidth traces");
 280 }
 281 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
 282   xbt_die("The NS3 network model doesn't support latency traces");
 283 }
 284
 285 /**********
 286  * Action *
 287  **********/
 288
 289 NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
 290     : NetworkAction(model, size, false)
 291 {
 292   XBT_DEBUG("Communicate from %s to %s", src->cname(), dst->cname());
 293
 294   src_ = src;
 295   dst_ = dst;
 296   ns3_create_flow(src, dst, surf_get_clock(), size, this);
 297
 298   s4u::Link::onCommunicate(this, src, dst);
 299 }
 300
 301 void NetworkNS3Action::suspend() {
 302   THROW_UNIMPLEMENTED;
 303 }
 304
 305 void NetworkNS3Action::resume() {
 306   THROW_UNIMPLEMENTED;
 307 }
 308
 309   /* Test whether a flow is suspended */
 310 bool NetworkNS3Action::isSuspended()
 311 {
 312   return false;
 313 }
 314
 315 int NetworkNS3Action::unref()
 316 {
 317   refcount_--;
 318   if (!refcount_) {
 319     if (action_hook.is_linked())
 320       stateSet_->erase(stateSet_->iterator_to(*this));
 321     XBT_DEBUG ("Removing action %p", this);
 322     delete this;
 323     return 1;
 324   }
 325   return 0;
 326 }
 327
 328 }
 329 }
 330
 331 void ns3_simulator(double maxSeconds)
 332 {
 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 ();
 337 }
 338
 339 void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double startTime, u_int32_t TotalBytes,
 340                      simgrid::surf::NetworkNS3Action* action)
 341 {
 342   int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
 343   int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
 344
 345   ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
 346   ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
 347
 348   char* addr = IPV4addr.at(node2);
 349
 350   XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
 351   ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
 352   sink.Install (dst_node);
 353
 354   ns3::Ptr<ns3::Socket> sock = ns3::Socket::CreateSocket (src_node, ns3::TcpSocketFactory::GetTypeId());
 355
 356   xbt_dict_set(flowFromSock, transformSocketPtr(sock), new SgFlow(TotalBytes, action), nullptr);
 357
 358   sock->Bind(ns3::InetSocketAddress(port_number));
 359   XBT_DEBUG("Create flow starting to %fs + %fs = %fs",
 360       startTime-ns3::Simulator::Now().GetSeconds(), ns3::Simulator::Now().GetSeconds(), startTime);
 361
 362   ns3::Simulator::Schedule (ns3::Seconds(startTime-ns3::Simulator::Now().GetSeconds()),
 363       &StartFlow, sock, addr, port_number);
 364
 365   port_number++;
 366   xbt_assert(port_number <= 65000, "Too many connections! Port number is saturated.");
 367 }
 368
 369 // initialize the NS3 interface and environment
 370 void ns3_initialize(const char* TcpProtocol){
 371 //  tcpModel are:
 372 //  "ns3::TcpNewReno"
 373 //  "ns3::TcpReno"
 374 //  "ns3::TcpTahoe"
 375
 376   ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
 377   ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
 378
 379   if (!strcmp(TcpProtocol,"default"))
 380     return;
 381
 382   if (!strcmp(TcpProtocol,"Reno")) {
 383     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 384     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
 385     return;
 386   }
 387   if (!strcmp(TcpProtocol,"NewReno")) {
 388     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 389     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
 390     return;
 391   }
 392   if(!strcmp(TcpProtocol,"Tahoe")){
 393     XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
 394     ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
 395     return;
 396   }
 397
 398   xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
 399 }
 400
 401 void ns3_add_cluster(const char* id, char* bw, char* lat)
 402 {
 403   ns3::NodeContainer Nodes;
 404
 405   for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
 406     Nodes.Add(Cluster_nodes.Get(i));
 407     XBT_DEBUG("Add node %d to cluster",i);
 408   }
 409   number_of_clusters_nodes = Cluster_nodes.GetN();
 410
 411   XBT_DEBUG("Add router %d to cluster",nodes.GetN()-Nodes.GetN()-1);
 412   Nodes.Add(nodes.Get(nodes.GetN()-Nodes.GetN()-1));
 413
 414   xbt_assert(Nodes.GetN() <= 65000, "Cluster with NS3 is limited to 65000 nodes");
 415   ns3::CsmaHelper csma;
 416   csma.SetChannelAttribute ("DataRate", ns3::StringValue (bw));
 417   csma.SetChannelAttribute ("Delay", ns3::StringValue (lat));
 418   ns3::NetDeviceContainer devices = csma.Install (Nodes);
 419   XBT_DEBUG("Create CSMA");
 420
 421   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
 422   XBT_DEBUG("Assign IP Addresses %s to CSMA.",adr);
 423   ns3::Ipv4AddressHelper ipv4;
 424   ipv4.SetBase (adr, "255.255.0.0");
 425   free(adr);
 426   interfaces.Add(ipv4.Assign (devices));
 427
 428   if(number_of_links == 255){
 429     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 430     number_of_links = 1;
 431     number_of_networks++;
 432   }else{
 433     number_of_links++;
 434   }
 435   XBT_DEBUG("Number of nodes in Cluster_nodes: %d",Cluster_nodes.GetN());
 436 }
 437
 438 static char* transformIpv4Address (ns3::Ipv4Address from){
 439   std::stringstream sstream;
 440   sstream << from ;
 441   std::string s = sstream.str();
 442   return bprintf("%s",s.c_str());
 443 }
 444
 445 void ns3_add_link(int src, int dst, char *bw, char *lat)
 446 {
 447   ns3::PointToPointHelper pointToPoint;
 448
 449   ns3::NetDeviceContainer netA;
 450   ns3::Ipv4AddressHelper address;
 451
 452   ns3::Ptr<ns3::Node> a = nodes.Get(src);
 453   ns3::Ptr<ns3::Node> b = nodes.Get(dst);
 454
 455   XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
 456   pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
 457   pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
 458
 459   netA.Add(pointToPoint.Install (a, b));
 460
 461   char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
 462   address.SetBase (adr, "255.255.0.0");
 463   XBT_DEBUG("\tInterface stack '%s'",adr);
 464   free(adr);
 465   interfaces.Add(address.Assign (netA));
 466
 467   if (IPV4addr.size() <= (unsigned)src)
 468     IPV4addr.resize(src + 1, nullptr);
 469   IPV4addr.at(src) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
 470
 471   if (IPV4addr.size() <= (unsigned)dst)
 472     IPV4addr.resize(dst + 1, nullptr);
 473   IPV4addr.at(dst) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
 474
 475   if (number_of_links == 255){
 476     xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");
 477     number_of_links = 1;
 478     number_of_networks++;
 479   } else {
 480     number_of_links++;
 481   }
 482 }