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