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