src/surf/network_ns3.cpp

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