src/surf/instr_routing.cpp

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