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.h"
   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, xbt_dict_t filter)
  69 {
  70   //ignore loopback
  71   if (strcmp(src->name_, "__loopback__") == 0 || strcmp(dst->name_, "__loopback__") == 0) {
  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   if (filter != nullptr){
  83     //check if we already register this pair (we only need one direction)
  84     char aux1[INSTR_DEFAULT_STR_SIZE];
  85     char aux2[INSTR_DEFAULT_STR_SIZE];
  86     snprintf(aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", src->name_, dst->name_);
  87     snprintf(aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", dst->name_, src->name_);
  88     if (xbt_dict_get_or_null (filter, aux1)){
  89       XBT_DEBUG("  linkContainers: already registered %s <-> %s (1)", src->name_, dst->name_);
  90       return;
  91     }
  92     if (xbt_dict_get_or_null (filter, aux2)){
  93       XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->name_, src->name_);
  94       return;
  95     }
  96
  97     //ok, not found, register it
  98     xbt_dict_set (filter, aux1, xbt_strdup ("1"), nullptr);
  99     xbt_dict_set (filter, aux2, xbt_strdup ("1"), nullptr);
 100   }
 101
 102   //declare type
 103   char link_typename[INSTR_DEFAULT_STR_SIZE];
 104   snprintf(link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s", father->type_->name_, src->type_->name_,
 105            src->type_->id_, dst->type_->name_, dst->type_->id_);
 106   simgrid::instr::Type* link_type = simgrid::instr::Type::getOrNull(link_typename, father->type_);
 107   if (link_type == nullptr){
 108     link_type = simgrid::instr::Type::linkNew(link_typename, father->type_, src->type_, dst->type_);
 109   }
 110
 111   //register EDGE types for triva configuration
 112   trivaEdgeTypes.insert(link_type->name_);
 113
 114   //create the link
 115   static long long counter = 0;
 116
 117   char key[INSTR_DEFAULT_STR_SIZE];
 118   snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
 119   counter++;
 120
 121   new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), father, link_type, src, "topology", key);
 122   new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), father, link_type, dst, "topology", key);
 123
 124   XBT_DEBUG("  linkContainers %s <-> %s", src->name_, dst->name_);
 125 }
 126
 127 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container, xbt_dict_t filter)
 128 {
 129   if (not TRACE_platform_topology()) {
 130     XBT_DEBUG("Graph extraction disabled by user.");
 131     return;
 132   }
 133   XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
 134   if (not netzone->getChildren()->empty()) {
 135     //bottom-up recursion
 136     for (auto const& nz_son : *netzone->getChildren()) {
 137       container_t child_container = static_cast<container_t>(xbt_dict_get(container->children_, nz_son->getCname()));
 138       recursiveGraphExtraction(nz_son, child_container, filter);
 139     }
 140   }
 141
 142   xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
 143   xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
 144   xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
 145   xbt_edge_t edge = nullptr;
 146
 147   xbt_dict_cursor_t cursor = nullptr;
 148   char *edge_name;
 149
 150   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
 151   xbt_dict_foreach(edges,cursor,edge_name,edge) {
 152     linkContainers(
 153           PJ_container_get(static_cast<const char*>(edge->src->data)),
 154           PJ_container_get(static_cast<const char*>(edge->dst->data)), filter);
 155   }
 156   xbt_dict_free (&nodes);
 157   xbt_dict_free (&edges);
 158   xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
 159 }
 160
 161 /*
 162  * Callbacks
 163  */
 164 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
 165 {
 166   const char* id = netzone.getCname();
 167
 168   if (PJ_container_get_root() == nullptr){
 169     container_t root = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, nullptr);
 170     PJ_container_set_root (root);
 171
 172     if (TRACE_smpi_is_enabled()) {
 173       simgrid::instr::Type* mpi = simgrid::instr::Type::getOrNull("MPI", root->type_);
 174       if (mpi == nullptr){
 175         mpi = simgrid::instr::Type::containerNew("MPI", root->type_);
 176         if (not TRACE_smpi_is_grouped())
 177           simgrid::instr::Type::stateNew("MPI_STATE", mpi);
 178         simgrid::instr::Type::linkNew("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 179       }
 180     }
 181
 182     if (TRACE_needs_platform()){
 183       currentContainer.push_back(root);
 184     }
 185     return;
 186   }
 187
 188   if (TRACE_needs_platform()){
 189     container_t father = currentContainer.back();
 190     container_t container = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, father);
 191     currentContainer.push_back(container);
 192   }
 193 }
 194
 195 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
 196 {
 197   if (TRACE_needs_platform()){
 198     currentContainer.pop_back();
 199   }
 200 }
 201
 202 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
 203 {
 204   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
 205     return;
 206   container_t father = currentContainer.back();
 207
 208   double bandwidth_value = link.bandwidth();
 209   double latency_value   = link.latency();
 210
 211   container_t container = new simgrid::instr::Container(link.name(), simgrid::instr::INSTR_LINK, father);
 212
 213   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
 214     simgrid::instr::Type* bandwidth = simgrid::instr::Type::getOrNull("bandwidth", container->type_);
 215     if (bandwidth == nullptr) {
 216       bandwidth = simgrid::instr::Type::variableNew("bandwidth", nullptr, container->type_);
 217     }
 218     simgrid::instr::Type* latency = simgrid::instr::Type::getOrNull("latency", container->type_);
 219     if (latency == nullptr) {
 220       latency = simgrid::instr::Type::variableNew("latency", nullptr, container->type_);
 221     }
 222     new simgrid::instr::SetVariableEvent(0, container, bandwidth, bandwidth_value);
 223     new simgrid::instr::SetVariableEvent(0, container, latency, latency_value);
 224   }
 225   if (TRACE_uncategorized()) {
 226     simgrid::instr::Type* bandwidth_used = simgrid::instr::Type::getOrNull("bandwidth_used", container->type_);
 227     if (bandwidth_used == nullptr) {
 228       simgrid::instr::Type::variableNew("bandwidth_used", "0.5 0.5 0.5", container->type_);
 229     }
 230   }
 231 }
 232
 233 static void sg_instr_new_host(simgrid::s4u::Host& host)
 234 {
 235   container_t father = currentContainer.back();
 236   container_t container = new simgrid::instr::Container(host.getCname(), simgrid::instr::INSTR_HOST, father);
 237
 238   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
 239     simgrid::instr::Type* speed = simgrid::instr::Type::getOrNull("power", container->type_);
 240     if (speed == nullptr){
 241       speed = simgrid::instr::Type::variableNew("power", nullptr, container->type_);
 242     }
 243
 244     double current_speed_state = host.getSpeed();
 245     new simgrid::instr::SetVariableEvent(0, container, speed, current_speed_state);
 246   }
 247   if (TRACE_uncategorized()){
 248     simgrid::instr::Type* speed_used = simgrid::instr::Type::getOrNull("power_used", container->type_);
 249     if (speed_used == nullptr){
 250       simgrid::instr::Type::variableNew("power_used", "0.5 0.5 0.5", container->type_);
 251     }
 252   }
 253
 254   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 255     simgrid::instr::Type* mpi = simgrid::instr::Type::getOrNull("MPI", container->type_);
 256     if (mpi == nullptr){
 257       mpi = simgrid::instr::Type::containerNew("MPI", container->type_);
 258       simgrid::instr::Type::stateNew("MPI_STATE", mpi);
 259     }
 260   }
 261
 262   if (TRACE_msg_process_is_enabled()) {
 263     simgrid::instr::Type* msg_process = simgrid::instr::Type::getOrNull("MSG_PROCESS", container->type_);
 264     if (msg_process == nullptr){
 265       msg_process                 = simgrid::instr::Type::containerNew("MSG_PROCESS", container->type_);
 266       simgrid::instr::Type* state = simgrid::instr::Type::stateNew("MSG_PROCESS_STATE", msg_process);
 267       new simgrid::instr::Value("suspend", "1 0 1", state);
 268       simgrid::instr::Value::get_or_new("sleep", "1 1 0", state);
 269       simgrid::instr::Value::get_or_new("receive", "1 0 0", state);
 270       simgrid::instr::Value::get_or_new("send", "0 0 1", state);
 271       simgrid::instr::Value::get_or_new("task_execute", "0 1 1", state);
 272       simgrid::instr::Type::linkNew("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
 273       simgrid::instr::Type::linkNew("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
 274     }
 275   }
 276
 277   if (TRACE_msg_vm_is_enabled()) {
 278     simgrid::instr::Type* msg_vm = simgrid::instr::Type::getOrNull("MSG_VM", container->type_);
 279     if (msg_vm == nullptr){
 280       msg_vm                      = simgrid::instr::Type::containerNew("MSG_VM", container->type_);
 281       simgrid::instr::Type* state = simgrid::instr::Type::stateNew("MSG_VM_STATE", msg_vm);
 282       new simgrid::instr::Value("suspend", "1 0 1", state);
 283       simgrid::instr::Value::get_or_new("sleep", "1 1 0", state);
 284       simgrid::instr::Value::get_or_new("receive", "1 0 0", state);
 285       simgrid::instr::Value::get_or_new("send", "0 0 1", state);
 286       simgrid::instr::Value::get_or_new("task_execute", "0 1 1", state);
 287       simgrid::instr::Type::linkNew("MSG_VM_LINK", PJ_type_get_root(), msg_vm, msg_vm);
 288       simgrid::instr::Type::linkNew("MSG_VM_PROCESS_LINK", PJ_type_get_root(), msg_vm, msg_vm);
 289     }
 290   }
 291
 292 }
 293
 294 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
 295 {
 296   if (not netpoint->isRouter())
 297     return;
 298   if (TRACE_is_enabled() && TRACE_needs_platform()) {
 299     container_t father = currentContainer.back();
 300     new simgrid::instr::Container(netpoint->cname(), simgrid::instr::INSTR_ROUTER, father);
 301   }
 302 }
 303
 304 static void instr_routing_parse_end_platform ()
 305 {
 306   currentContainer.clear();
 307   xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free_f);
 308   XBT_DEBUG ("Starting graph extraction.");
 309   recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), PJ_container_get_root(), filter);
 310   XBT_DEBUG ("Graph extraction finished.");
 311   xbt_dict_free(&filter);
 312   platform_created = 1;
 313   TRACE_paje_dump_buffer(1);
 314 }
 315
 316 void instr_routing_define_callbacks ()
 317 {
 318   //always need the call backs to ASes (we need only the root AS),
 319   //to create the rootContainer and the rootType properly
 320   if (not TRACE_is_enabled())
 321     return;
 322   if (TRACE_needs_platform()) {
 323     simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
 324     simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
 325     simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
 326   }
 327   simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
 328   simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
 329   simgrid::kernel::routing::NetPoint::onCreation.connect(&sg_instr_new_router);
 330 }
 331 /*
 332  * user categories support
 333  */
 334 static void recursiveNewVariableType(const char* new_typename, const char* color, simgrid::instr::Type* root)
 335 {
 336   if (not strcmp(root->name_, "HOST")) {
 337     char tnstr[INSTR_DEFAULT_STR_SIZE];
 338     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 339     simgrid::instr::Type::variableNew(tnstr, color, root);
 340   }
 341   if (not strcmp(root->name_, "MSG_VM")) {
 342     char tnstr[INSTR_DEFAULT_STR_SIZE];
 343     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 344     simgrid::instr::Type::variableNew(tnstr, color, root);
 345   }
 346   if (not strcmp(root->name_, "LINK")) {
 347     char tnstr[INSTR_DEFAULT_STR_SIZE];
 348     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
 349     simgrid::instr::Type::variableNew(tnstr, color, root);
 350   }
 351   xbt_dict_cursor_t cursor = nullptr;
 352   simgrid::instr::Type* child_type;
 353   char *name;
 354   xbt_dict_foreach (root->children_, cursor, name, child_type) {
 355     recursiveNewVariableType (new_typename, color, child_type);
 356   }
 357 }
 358
 359 void instr_new_variable_type (const char *new_typename, const char *color)
 360 {
 361   recursiveNewVariableType (new_typename, color, PJ_type_get_root());
 362 }
 363
 364 static void recursiveNewUserVariableType(const char* father_type, const char* new_typename, const char* color,
 365                                          simgrid::instr::Type* root)
 366 {
 367   if (not strcmp(root->name_, father_type)) {
 368     simgrid::instr::Type::variableNew(new_typename, color, root);
 369   }
 370   xbt_dict_cursor_t cursor = nullptr;
 371   simgrid::instr::Type* child_type;
 372   char *name;
 373   xbt_dict_foreach (root->children_, cursor, name, child_type) {
 374     recursiveNewUserVariableType (father_type, new_typename, color, child_type);
 375   }
 376 }
 377
 378 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 379 {
 380   recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
 381 }
 382
 383 static void recursiveNewUserStateType(const char* father_type, const char* new_typename, simgrid::instr::Type* root)
 384 {
 385   if (not strcmp(root->name_, father_type)) {
 386     simgrid::instr::Type::stateNew(new_typename, root);
 387   }
 388   xbt_dict_cursor_t cursor = nullptr;
 389   simgrid::instr::Type* child_type;
 390   char *name;
 391   xbt_dict_foreach (root->children_, cursor, name, child_type) {
 392     recursiveNewUserStateType (father_type, new_typename, child_type);
 393   }
 394 }
 395
 396 void instr_new_user_state_type (const char *father_type, const char *new_typename)
 397 {
 398   recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
 399 }
 400
 401 static void recursiveNewValueForUserStateType(const char* type_name, const char* val, const char* color,
 402                                               simgrid::instr::Type* root)
 403 {
 404   if (not strcmp(root->name_, type_name)) {
 405     new simgrid::instr::Value(val, color, root);
 406   }
 407   xbt_dict_cursor_t cursor = nullptr;
 408   simgrid::instr::Type* child_type;
 409   char *name;
 410   xbt_dict_foreach (root->children_, cursor, name, child_type) {
 411     recursiveNewValueForUserStateType(type_name, val, color, child_type);
 412   }
 413 }
 414
 415 void instr_new_value_for_user_state_type (const char *type_name, const char *value, const char *color)
 416 {
 417   recursiveNewValueForUserStateType (type_name, value, color, PJ_type_get_root());
 418 }
 419
 420 int instr_platform_traced ()
 421 {
 422   return platform_created;
 423 }
 424
 425 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 426
 427 static void recursiveXBTGraphExtraction(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, sg_netzone_t netzone,
 428                                         container_t container)
 429 {
 430   if (not netzone->getChildren()->empty()) {
 431     //bottom-up recursion
 432     for (auto const& netzone_child : *netzone->getChildren()) {
 433       container_t child_container =
 434           static_cast<container_t>(xbt_dict_get(container->children_, netzone_child->getCname()));
 435       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
 436     }
 437   }
 438
 439   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
 440 }
 441
 442 xbt_graph_t instr_routing_platform_graph ()
 443 {
 444   xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
 445   xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
 446   xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
 447   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
 448                               PJ_container_get_root());
 449   xbt_dict_free (&nodes);
 450   xbt_dict_free (&edges);
 451   return ret;
 452 }
 453
 454 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 455 {
 456   unsigned int cursor = 0;
 457   xbt_node_t node = nullptr;
 458   xbt_edge_t edge = nullptr;
 459
 460   FILE *file = fopen(filename, "w");
 461   xbt_assert(file, "Failed to open %s \n", filename);
 462
 463   if (g->directed)
 464     fprintf(file, "digraph test {\n");
 465   else
 466     fprintf(file, "graph test {\n");
 467
 468   fprintf(file, "  graph [overlap=scale]\n");
 469
 470   fprintf(file, "  node [shape=box, style=filled]\n");
 471   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 472
 473   xbt_dynar_foreach(g->nodes, cursor, node) {
 474     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 475   }
 476   xbt_dynar_foreach(g->edges, cursor, edge) {
 477     const char *src_s = instr_node_name (edge->src);
 478     const char *dst_s = instr_node_name (edge->dst);
 479     if (g->directed)
 480       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 481     else
 482       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 483   }
 484   fprintf(file, "}\n");
 485   fclose(file);
 486 }