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