src/surf/instr_routing.cpp

   1 /* Copyright (c) 2010-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 "src/instr/instr_private.hpp"
   7
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "simgrid/s4u/Host.hpp"
  10 #include "src/kernel/routing/NetZoneImpl.hpp"
  11 #include "src/kernel/routing/NetPoint.hpp"
  12 #include "src/surf/network_interface.hpp"
  13 #include "src/surf/xml/platf_private.hpp"
  14 #include "surf/surf.h"
  15 #include "xbt/graph.h"
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
  18
  19 static int platform_created = 0;            /* indicate whether the platform file has been traced */
  20 static std::vector<container_t> currentContainer; /* push and pop, used only in creation */
  21
  22 static const char *instr_node_name (xbt_node_t node)
  23 {
  24   void *data = xbt_graph_node_get_data(node);
  25   return static_cast<char*>(data);
  26 }
  27
  28 static container_t lowestCommonAncestor (container_t a1, container_t a2)
  29 {
  30   //this is only an optimization (since most of a1 and a2 share the same parent)
  31   if (a1->father_ == a2->father_)
  32     return a1->father_;
  33
  34   //create an array with all ancestors of a1
  35   std::vector<container_t> ancestors_a1;
  36   container_t p = a1->father_;
  37   while (p){
  38     ancestors_a1.push_back(p);
  39     p = p->father_;
  40   }
  41
  42   //create an array with all ancestors of a2
  43   std::vector<container_t> ancestors_a2;
  44   p = a2->father_;
  45   while (p){
  46     ancestors_a2.push_back(p);
  47     p = p->father_;
  48   }
  49
  50   //find the lowest ancestor
  51   p = nullptr;
  52   int i = ancestors_a1.size() - 1;
  53   int j = ancestors_a2.size() - 1;
  54   while (i >= 0 && j >= 0){
  55     container_t a1p = ancestors_a1.at(i);
  56     container_t a2p = ancestors_a2.at(j);
  57     if (a1p == a2p){
  58       p = a1p;
  59     }else{
  60       break;
  61     }
  62     i--;
  63     j--;
  64   }
  65   return p;
  66 }
  67
  68 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
  69 {
  70   //ignore loopback
  71   if (src->name_ == "__loopback__" || dst->name_ == "__loopback__") {
  72     XBT_DEBUG ("  linkContainers: ignoring loopback link");
  73     return;
  74   }
  75
  76   //find common father
  77   container_t father = lowestCommonAncestor (src, dst);
  78   if (not father) {
  79     xbt_die ("common father unknown, this is a tracing problem");
  80   }
  81
  82   // check if we already register this pair (we only need one direction)
  83   std::string aux1 = src->name_ + dst->name_;
  84   std::string aux2 = dst->name_ + src->name_;
  85   if (filter->find(aux1) != filter->end()) {
  86     XBT_DEBUG("  linkContainers: already registered %s <-> %s (1)", src->name_.c_str(), dst->name_.c_str());
  87     return;
  88   }
  89   if (filter->find(aux2) != filter->end()) {
  90     XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->name_.c_str(), src->name_.c_str());
  91     return;
  92   }
  93
  94   // ok, not found, register it
  95   filter->insert(aux1);
  96   filter->insert(aux2);
  97
  98   //declare type
  99   char link_typename[INSTR_DEFAULT_STR_SIZE];
 100   snprintf(link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s", father->type_->getCname(), src->type_->getCname(),
 101            src->type_->getId(), dst->type_->getCname(), dst->type_->getId());
 102   simgrid::instr::Type* link_type = father->type_->getChildOrNull(link_typename);
 103   if (link_type == nullptr)
 104     link_type = father->type_->addLinkType(link_typename, src->type_, dst->type_);
 105
 106   //register EDGE types for triva configuration
 107   trivaEdgeTypes.insert(link_type->getName());
 108
 109   //create the link
 110   static long long counter = 0;
 111
 112   char key[INSTR_DEFAULT_STR_SIZE];
 113   snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
 114   counter++;
 115
 116   new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), father, link_type, src, "topology", key);
 117   new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), father, link_type, dst, "topology", key);
 118
 119   XBT_DEBUG("  linkContainers %s <-> %s", src->name_.c_str(), dst->name_.c_str());
 120 }
 121
 122 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
 123                                      std::set<std::string>* filter)
 124 {
 125   if (not TRACE_platform_topology()) {
 126     XBT_DEBUG("Graph extraction disabled by user.");
 127     return;
 128   }
 129   XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
 130   if (not netzone->getChildren()->empty()) {
 131     //bottom-up recursion
 132     for (auto const& nz_son : *netzone->getChildren()) {
 133       container_t child_container = container->children_.at(nz_son->getCname());
 134       recursiveGraphExtraction(nz_son, child_container, filter);
 135     }
 136   }
 137
 138   xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
 139   xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
 140   xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
 141   xbt_edge_t edge = nullptr;
 142
 143   xbt_dict_cursor_t cursor = nullptr;
 144   char *edge_name;
 145
 146   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
 147   xbt_dict_foreach(edges,cursor,edge_name,edge) {
 148     linkContainers(simgrid::instr::Container::byName(static_cast<const char*>(edge->src->data)),
 149                    simgrid::instr::Container::byName(static_cast<const char*>(edge->dst->data)), filter);
 150   }
 151   xbt_dict_free (&nodes);
 152   xbt_dict_free (&edges);
 153   xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
 154 }
 155
 156 /*
 157  * Callbacks
 158  */
 159 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
 160 {
 161   std::string id = netzone.getName();
 162
 163   if (PJ_container_get_root() == nullptr){
 164     container_t root = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, nullptr);
 165     PJ_container_set_root (root);
 166
 167     if (TRACE_smpi_is_enabled()) {
 168       simgrid::instr::Type* mpi = root->type_->getChildOrNull("MPI");
 169       if (mpi == nullptr){
 170         mpi = simgrid::instr::Type::containerNew("MPI", root->type_);
 171         if (not TRACE_smpi_is_grouped())
 172           mpi->addStateType("MPI_STATE");
 173         PJ_type_get_root()->addLinkType("MPI_LINK", mpi, mpi);
 174       }
 175     }
 176
 177     if (TRACE_needs_platform()){
 178       currentContainer.push_back(root);
 179     }
 180     return;
 181   }
 182
 183   if (TRACE_needs_platform()){
 184     container_t father = currentContainer.back();
 185     container_t container = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, father);
 186     currentContainer.push_back(container);
 187   }
 188 }
 189
 190 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
 191 {
 192   if (TRACE_needs_platform()){
 193     currentContainer.pop_back();
 194   }
 195 }
 196
 197 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
 198 {
 199   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
 200     return;
 201   container_t father = currentContainer.back();
 202
 203   double bandwidth_value = link.bandwidth();
 204   double latency_value   = link.latency();
 205
 206   container_t container = new simgrid::instr::Container(link.name(), simgrid::instr::INSTR_LINK, father);
 207
 208   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
 209     simgrid::instr::Type* bandwidth = container->type_->getChildOrNull("bandwidth");
 210     if (bandwidth == nullptr)
 211       bandwidth                   = container->type_->addVariableType("bandwidth", "");
 212     simgrid::instr::Type* latency = container->type_->getChildOrNull("latency");
 213     if (latency == nullptr)
 214       latency = container->type_->addVariableType("latency", "");
 215     new simgrid::instr::SetVariableEvent(0, container, bandwidth, bandwidth_value);
 216     new simgrid::instr::SetVariableEvent(0, container, latency, latency_value);
 217   }
 218   if (TRACE_uncategorized()) {
 219     simgrid::instr::Type* bandwidth_used = container->type_->getChildOrNull("bandwidth_used");
 220     if (bandwidth_used == nullptr)
 221       container->type_->addVariableType("bandwidth_used", "0.5 0.5 0.5");
 222   }
 223 }
 224
 225 static void sg_instr_new_host(simgrid::s4u::Host& host)
 226 {
 227   container_t father = currentContainer.back();
 228   container_t container = new simgrid::instr::Container(host.getCname(), simgrid::instr::INSTR_HOST, father);
 229
 230   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
 231     simgrid::instr::Type* speed = container->type_->getChildOrNull("power");
 232     if (speed == nullptr){
 233       speed = container->type_->addVariableType("power", "");
 234     }
 235
 236     double current_speed_state = host.getSpeed();
 237     new simgrid::instr::SetVariableEvent(0, container, speed, current_speed_state);
 238   }
 239   if (TRACE_uncategorized()){
 240     simgrid::instr::Type* speed_used = container->type_->getChildOrNull("power_used");
 241     if (speed_used == nullptr){
 242       container->type_->addVariableType("power_used", "0.5 0.5 0.5");
 243     }
 244   }
 245
 246   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 247     simgrid::instr::Type* mpi = container->type_->getChildOrNull("MPI");
 248     if (mpi == nullptr){
 249       mpi = simgrid::instr::Type::containerNew("MPI", container->type_);
 250       mpi->addStateType("MPI_STATE");
 251     }
 252   }
 253
 254   if (TRACE_msg_process_is_enabled()) {
 255     simgrid::instr::Type* msg_process = container->type_->getChildOrNull("MSG_PROCESS");
 256     if (msg_process == nullptr){
 257       msg_process                 = simgrid::instr::Type::containerNew("MSG_PROCESS", container->type_);
 258       simgrid::instr::Type* state = msg_process->addStateType("MSG_PROCESS_STATE");
 259       simgrid::instr::Value::byNameOrCreate("suspend", "1 0 1", state);
 260       simgrid::instr::Value::byNameOrCreate("sleep", "1 1 0", state);
 261       simgrid::instr::Value::byNameOrCreate("receive", "1 0 0", state);
 262       simgrid::instr::Value::byNameOrCreate("send", "0 0 1", state);
 263       simgrid::instr::Value::byNameOrCreate("task_execute", "0 1 1", state);
 264       PJ_type_get_root()->addLinkType("MSG_PROCESS_LINK", msg_process, msg_process);
 265       PJ_type_get_root()->addLinkType("MSG_PROCESS_TASK_LINK", msg_process, msg_process);
 266     }
 267   }
 268
 269   if (TRACE_msg_vm_is_enabled()) {
 270     simgrid::instr::Type* msg_vm = container->type_->getChildOrNull("MSG_VM");
 271     if (msg_vm == nullptr){
 272       msg_vm                      = simgrid::instr::Type::containerNew("MSG_VM", container->type_);
 273       simgrid::instr::Type* state = msg_vm->addStateType("MSG_VM_STATE");
 274       simgrid::instr::Value::byNameOrCreate("suspend", "1 0 1", state);
 275       simgrid::instr::Value::byNameOrCreate("sleep", "1 1 0", state);
 276       simgrid::instr::Value::byNameOrCreate("receive", "1 0 0", state);
 277       simgrid::instr::Value::byNameOrCreate("send", "0 0 1", state);
 278       simgrid::instr::Value::byNameOrCreate("task_execute", "0 1 1", state);
 279       PJ_type_get_root()->addLinkType("MSG_VM_LINK", msg_vm, msg_vm);
 280       PJ_type_get_root()->addLinkType("MSG_VM_PROCESS_LINK", msg_vm, msg_vm);
 281     }
 282   }
 283 }
 284
 285 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
 286 {
 287   if (not netpoint->isRouter())
 288     return;
 289   if (TRACE_is_enabled() && TRACE_needs_platform()) {
 290     container_t father = currentContainer.back();
 291     new simgrid::instr::Container(netpoint->cname(), simgrid::instr::INSTR_ROUTER, father);
 292   }
 293 }
 294
 295 static void instr_routing_parse_end_platform ()
 296 {
 297   currentContainer.clear();
 298   std::set<std::string>* filter = new std::set<std::string>;
 299   XBT_DEBUG ("Starting graph extraction.");
 300   recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), PJ_container_get_root(), filter);
 301   XBT_DEBUG ("Graph extraction finished.");
 302   delete filter;
 303   platform_created = 1;
 304   TRACE_paje_dump_buffer(1);
 305 }
 306
 307 void instr_routing_define_callbacks ()
 308 {
 309   // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
 310   if (not TRACE_is_enabled())
 311     return;
 312   if (TRACE_needs_platform()) {
 313     simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
 314     simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
 315     simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
 316   }
 317   simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
 318   simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
 319   simgrid::kernel::routing::NetPoint::onCreation.connect(&sg_instr_new_router);
 320 }
 321 /*
 322  * user categories support
 323  */
 324 static void recursiveNewVariableType(const char* new_typename, const char* color, simgrid::instr::Type* root)
 325 {
 326   if (root->getName() == "HOST" || root->getName() == "MSG_VM")
 327     root->addVariableType(std::string("p") + new_typename, color == nullptr ? "" : color);
 328
 329   if (root->getName() == "LINK")
 330     root->addVariableType(std::string("b") + new_typename, color == nullptr ? "" : color);
 331
 332   for (auto elm : root->children_) {
 333     recursiveNewVariableType(new_typename, color == nullptr ? "" : color, elm.second);
 334   }
 335 }
 336
 337 void instr_new_variable_type (const char *new_typename, const char *color)
 338 {
 339   recursiveNewVariableType (new_typename, color, PJ_type_get_root());
 340 }
 341
 342 static void recursiveNewUserVariableType(const char* father_type, const char* new_typename, const char* color,
 343                                          simgrid::instr::Type* root)
 344 {
 345   if (root->getName() == father_type) {
 346     root->addVariableType(new_typename, color == nullptr ? "" : color);
 347   }
 348   for (auto elm : root->children_)
 349     recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
 350 }
 351
 352 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 353 {
 354   recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
 355 }
 356
 357 static void recursiveNewUserStateType(const char* father_type, const char* new_typename, simgrid::instr::Type* root)
 358 {
 359   if (root->getName() == father_type) {
 360     root->addStateType(new_typename);
 361   }
 362   for (auto elm : root->children_)
 363     recursiveNewUserStateType(father_type, new_typename, elm.second);
 364 }
 365
 366 void instr_new_user_state_type (const char *father_type, const char *new_typename)
 367 {
 368   recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
 369 }
 370
 371 static void recursiveNewValueForUserStateType(const char* type_name, const char* val, const char* color,
 372                                               simgrid::instr::Type* root)
 373 {
 374   if (root->getName() == type_name)
 375     simgrid::instr::Value::byNameOrCreate(val, color, root);
 376
 377   for (auto elm : root->children_)
 378     recursiveNewValueForUserStateType(type_name, val, color, elm.second);
 379 }
 380
 381 void instr_new_value_for_user_state_type (const char *type_name, const char *value, const char *color)
 382 {
 383   recursiveNewValueForUserStateType (type_name, value, color, PJ_type_get_root());
 384 }
 385
 386 int instr_platform_traced ()
 387 {
 388   return platform_created;
 389 }
 390
 391 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 392
 393 static void recursiveXBTGraphExtraction(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, sg_netzone_t netzone,
 394                                         container_t container)
 395 {
 396   if (not netzone->getChildren()->empty()) {
 397     //bottom-up recursion
 398     for (auto const& netzone_child : *netzone->getChildren()) {
 399       container_t child_container = container->children_.at(netzone_child->getCname());
 400       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
 401     }
 402   }
 403
 404   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
 405 }
 406
 407 xbt_graph_t instr_routing_platform_graph ()
 408 {
 409   xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
 410   xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
 411   xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
 412   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
 413                               PJ_container_get_root());
 414   xbt_dict_free (&nodes);
 415   xbt_dict_free (&edges);
 416   return ret;
 417 }
 418
 419 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 420 {
 421   unsigned int cursor = 0;
 422   xbt_node_t node = nullptr;
 423   xbt_edge_t edge = nullptr;
 424
 425   FILE *file = fopen(filename, "w");
 426   xbt_assert(file, "Failed to open %s \n", filename);
 427
 428   if (g->directed)
 429     fprintf(file, "digraph test {\n");
 430   else
 431     fprintf(file, "graph test {\n");
 432
 433   fprintf(file, "  graph [overlap=scale]\n");
 434
 435   fprintf(file, "  node [shape=box, style=filled]\n");
 436   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 437
 438   xbt_dynar_foreach(g->nodes, cursor, node) {
 439     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 440   }
 441   xbt_dynar_foreach(g->edges, cursor, edge) {
 442     const char *src_s = instr_node_name (edge->src);
 443     const char *dst_s = instr_node_name (edge->dst);
 444     if (g->directed)
 445       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 446     else
 447       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 448   }
 449   fprintf(file, "}\n");
 450   fclose(file);
 451 }