src/instr/instr_routing.c

   1 /* Copyright (c) 2010. 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 "instr/instr_private.h"
   8
   9 #ifdef HAVE_TRACING
  10 #include "surf/surf_private.h"
  11 #include "surf/network_private.h"
  12 #include "xbt/graph.h"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
  15
  16 extern xbt_dict_t defined_types; /* from instr_interface.c */
  17
  18 static int platform_created = 0;            /* indicate whether the platform file has been traced */
  19 static xbt_dynar_t currentContainer = NULL; /* push and pop, used only in creation */
  20
  21 static const char *instr_node_name (xbt_node_t node)
  22 {
  23   void *data = xbt_graph_node_get_data(node);
  24   char *str = (char*)data;
  25   return str;
  26 }
  27
  28
  29 static container_t lowestCommonAncestor (container_t a1, container_t a2)
  30 {
  31   //this is only an optimization (since most of a1 and a2 share the same parent)
  32   if (a1->father == a2->father) return a1->father;
  33
  34   //create an array with all ancestors of a1
  35   xbt_dynar_t ancestors_a1 = xbt_dynar_new(sizeof(container_t), NULL);
  36   container_t p;
  37   p = a1->father;
  38   while (p){
  39     xbt_dynar_push_as (ancestors_a1, container_t, p);
  40     p = p->father;
  41   }
  42
  43   //create an array with all ancestors of a2
  44   xbt_dynar_t ancestors_a2 = xbt_dynar_new(sizeof(container_t), NULL);
  45   p = a2->father;
  46   while (p){
  47     xbt_dynar_push_as (ancestors_a2, container_t, p);
  48     p = p->father;
  49   }
  50
  51   //find the lowest ancestor
  52   p = NULL;
  53   int i = xbt_dynar_length (ancestors_a1) - 1;
  54   int j = xbt_dynar_length (ancestors_a2) - 1;
  55   while (i >= 0 && j >= 0){
  56     container_t a1p = *(container_t*)xbt_dynar_get_ptr (ancestors_a1, i);
  57     container_t a2p = *(container_t*)xbt_dynar_get_ptr (ancestors_a2, j);
  58     if (a1p == a2p){
  59       p = a1p;
  60     }else{
  61       break;
  62     }
  63     i--;
  64     j--;
  65   }
  66   xbt_dynar_free (&ancestors_a1);
  67   xbt_dynar_free (&ancestors_a2);
  68   return p;
  69 }
  70
  71 static void linkContainers (container_t src, container_t dst, xbt_dict_t filter)
  72 {
  73   //ignore loopback
  74   if (strcmp (src->name, "__loopback__") == 0 || strcmp (dst->name, "__loopback__") == 0)
  75     return;
  76
  77   //find common father
  78   container_t father = lowestCommonAncestor (src, dst);
  79   if (!father){
  80     xbt_die ("common father unknown, this is a tracing problem");
  81   }
  82
  83   if (filter != NULL){
  84     //check if we already register this pair (we only need one direction)
  85     char aux1[INSTR_DEFAULT_STR_SIZE], 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)) return;
  89     if (xbt_dict_get_or_null (filter, aux2)) return;
  90
  91     //ok, not found, register it
  92     xbt_dict_set (filter, aux1, xbt_strdup ("1"), NULL);
  93     xbt_dict_set (filter, aux2, xbt_strdup ("1"), NULL);
  94   }
  95
  96   //declare type
  97   char link_typename[INSTR_DEFAULT_STR_SIZE];
  98   snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s",
  99             father->type->name,
 100             src->type->name, src->type->id,
 101             dst->type->name, dst->type->id);
 102   type_t link_type = PJ_type_get_or_null (link_typename, father->type);
 103   if (link_type == NULL){
 104     link_type = PJ_type_link_new (link_typename, father->type, src->type, dst->type);
 105   }
 106
 107   //register EDGE types for triva configuration
 108   xbt_dict_set (trivaEdgeTypes, link_type->name, xbt_strdup("1"), NULL);
 109
 110   //create the link
 111   static long long counter = 0;
 112   char key[INSTR_DEFAULT_STR_SIZE];
 113   snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
 114   new_pajeStartLink(SIMIX_get_clock(), father, link_type, src, "G", key);
 115   new_pajeEndLink(SIMIX_get_clock(), father, link_type, dst, "G", key);
 116 }
 117
 118 static void recursiveGraphExtraction (AS_t rc, container_t container, xbt_dict_t filter)
 119 {
 120   if (!xbt_dict_is_empty(rc->routing_sons)){
 121     xbt_dict_cursor_t cursor = NULL;
 122     AS_t rc_son;
 123     char *child_name;
 124     //bottom-up recursion
 125     xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
 126       container_t child_container = xbt_dict_get (container->children, rc_son->name);
 127       recursiveGraphExtraction (rc_son, child_container, filter);
 128     }
 129   }
 130
 131   //let's get routes
 132   xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
 133   container_t child1, child2;
 134   const char *child1_name, *child2_name;
 135   xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
 136     //if child1 is not a link, a smpi node, a msg process or a msg task
 137     if (child1->kind == INSTR_LINK || child1->kind == INSTR_SMPI || child1->kind == INSTR_MSG_PROCESS || child1->kind == INSTR_MSG_TASK) continue;
 138
 139     xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
 140       //if child2 is not a link, a smpi node, a msg process or a msg task
 141       if (child2->kind == INSTR_LINK || child2->kind == INSTR_SMPI || child2->kind == INSTR_MSG_PROCESS || child2->kind == INSTR_MSG_TASK) continue;
 142
 143       //if child1 is not child2
 144       if (strcmp (child1_name, child2_name) == 0) continue;
 145
 146       //get the route
 147       route_t route = xbt_new0(s_route_t,1);
 148       route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
 149       rc->get_route_and_latency(rc, child1->net_elm, child2->net_elm,
 150                                 route, NULL);
 151
 152       //user might want to extract a graph using routes with only one link
 153       //see --cfg=tracing/onelink_only:1 or --help-tracing for details
 154       if (TRACE_onelink_only() && xbt_dynar_length (route->link_list) > 1){
 155         generic_free_route(route);
 156         continue;
 157       }
 158
 159       //traverse the route connecting the containers
 160       unsigned int cpt;
 161       void *link;
 162       container_t current, previous;
 163       if (route->src_gateway){
 164         previous = PJ_container_get(route->src_gateway->name);
 165       }else{
 166         previous = child1;
 167       }
 168
 169       xbt_dynar_foreach (route->link_list, cpt, link) {
 170         char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 171         current = PJ_container_get(link_name);
 172         linkContainers(previous, current, filter);
 173         previous = current;
 174       }
 175       if (route->dst_gateway){
 176         current = PJ_container_get(route->dst_gateway->name);
 177       }else{
 178         current = child2;
 179       }
 180       linkContainers(previous, current, filter);
 181       generic_free_route(route);
 182     }
 183   }
 184 }
 185
 186 /*
 187  * Callbacks
 188  */
 189 static void instr_routing_parse_start_AS (const char*id,const char*routing)
 190 {
 191   if (PJ_container_get_root() == NULL){
 192     PJ_container_alloc ();
 193     PJ_type_alloc();
 194     container_t root = PJ_container_new (id, INSTR_AS, NULL);
 195     PJ_container_set_root (root);
 196
 197     if (TRACE_smpi_is_enabled()) {
 198       if (!TRACE_smpi_is_grouped()){
 199         type_t mpi = PJ_type_get_or_null ("MPI", root->type);
 200         if (mpi == NULL){
 201           mpi = PJ_type_container_new("MPI", root->type);
 202           PJ_type_state_new ("MPI_STATE", mpi);
 203           PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 204         }
 205       }
 206     }
 207
 208     if (TRACE_needs_platform()){
 209       currentContainer = xbt_dynar_new (sizeof(container_t), NULL);
 210       xbt_dynar_push (currentContainer, &root);
 211     }
 212     return;
 213   }
 214
 215   if (TRACE_needs_platform()){
 216     container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 217     container_t new = PJ_container_new (id, INSTR_AS, father);
 218     xbt_dynar_push (currentContainer, &new);
 219   }
 220 }
 221
 222 static void instr_routing_parse_end_AS ()
 223 {
 224   if (TRACE_needs_platform()){
 225     xbt_dynar_pop_ptr (currentContainer);
 226   }
 227 }
 228
 229 static void instr_routing_parse_start_link (sg_platf_link_cbarg_t link)
 230 {
 231   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 232
 233   double bandwidth_value = link->bandwidth;
 234   double latency_value = link->latency;
 235   xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
 236
 237   if (link->policy == SURF_LINK_FULLDUPLEX){
 238     char *up = bprintf("%s_UP", link->id);
 239     char *down = bprintf("%s_DOWN", link->id);
 240     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
 241     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
 242     free (up);
 243     free (down);
 244   }else{
 245     xbt_dynar_push_as (links_to_create, char*, strdup(link->id));
 246   }
 247
 248   char *link_name = NULL;
 249   unsigned int i;
 250   xbt_dynar_foreach (links_to_create, i, link_name){
 251
 252     container_t new = PJ_container_new (link_name, INSTR_LINK, father);
 253
 254     if (TRACE_categorized() || TRACE_uncategorized()){
 255       type_t bandwidth = PJ_type_get_or_null ("bandwidth", new->type);
 256       if (bandwidth == NULL){
 257         bandwidth = PJ_type_variable_new ("bandwidth", NULL, new->type);
 258       }
 259       type_t latency = PJ_type_get_or_null ("latency", new->type);
 260       if (latency == NULL){
 261         latency = PJ_type_variable_new ("latency", NULL, new->type);
 262       }
 263       new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
 264       new_pajeSetVariable (0, new, latency, latency_value);
 265     }
 266     if (TRACE_uncategorized()){
 267       type_t bandwidth_used = PJ_type_get_or_null ("bandwidth_used", new->type);
 268       if (bandwidth_used == NULL){
 269         bandwidth_used = PJ_type_variable_new ("bandwidth_used", "0.5 0.5 0.5", new->type);
 270       }
 271     }
 272   }
 273
 274   xbt_dynar_free (&links_to_create);
 275 }
 276
 277 static void instr_routing_parse_start_host (sg_platf_host_cbarg_t host)
 278 {
 279   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 280   container_t new = PJ_container_new (host->id, INSTR_HOST, father);
 281
 282   if (TRACE_categorized() || TRACE_uncategorized()) {
 283     type_t power = PJ_type_get_or_null ("power", new->type);
 284     if (power == NULL){
 285       power = PJ_type_variable_new ("power", NULL, new->type);
 286     }
 287     new_pajeSetVariable (0, new, power, host->power_peak);
 288   }
 289   if (TRACE_uncategorized()){
 290     type_t power_used = PJ_type_get_or_null ("power_used", new->type);
 291     if (power_used == NULL){
 292       power_used = PJ_type_variable_new ("power_used", "0.5 0.5 0.5", new->type);
 293     }
 294   }
 295
 296   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 297     type_t mpi = PJ_type_get_or_null ("MPI", new->type);
 298     if (mpi == NULL){
 299       mpi = PJ_type_container_new("MPI", new->type);
 300       PJ_type_state_new ("MPI_STATE", mpi);
 301       PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 302     }
 303   }
 304
 305   if (TRACE_msg_process_is_enabled()) {
 306     type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", new->type);
 307     if (msg_process == NULL){
 308       msg_process = PJ_type_container_new("MSG_PROCESS", new->type);
 309       type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
 310       PJ_value_new ("executing", "0 1 0", state);
 311       PJ_value_new ("suspend", "1 0 1", state);
 312       PJ_value_new ("sleep", "1 1 0", state);
 313       PJ_value_new ("receive", "1 0 0", state);
 314       PJ_value_new ("send", "0 0 1", state);
 315       PJ_value_new ("task_execute", "0 1 1", state);
 316       PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
 317       PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
 318     }
 319   }
 320 }
 321
 322 static void instr_routing_parse_start_router (sg_platf_router_cbarg_t router)
 323 {
 324   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 325   PJ_container_new (router->id, INSTR_ROUTER, father);
 326 }
 327
 328 static void instr_routing_parse_end_platform ()
 329 {
 330   xbt_dynar_free(&currentContainer);
 331   currentContainer = NULL;
 332   xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free);
 333   recursiveGraphExtraction (global_routing->root, PJ_container_get_root(), filter);
 334   xbt_dict_free(&filter);
 335   platform_created = 1;
 336   TRACE_paje_dump_buffer(1);
 337 }
 338
 339 void instr_routing_define_callbacks ()
 340 {
 341   if (!TRACE_is_enabled()) return;
 342   //always need the call backs to ASes (we need only the root AS),
 343   //to create the rootContainer and the rootType properly
 344   sg_platf_AS_begin_add_cb(instr_routing_parse_start_AS);
 345   sg_platf_AS_end_add_cb(instr_routing_parse_end_AS);
 346   if (!TRACE_needs_platform()) return;
 347   sg_platf_link_add_cb(instr_routing_parse_start_link);
 348   sg_platf_host_add_cb(instr_routing_parse_start_host);
 349   sg_platf_router_add_cb(instr_routing_parse_start_router);
 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, "LINK")){
 365     char tnstr[INSTR_DEFAULT_STR_SIZE];
 366     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
 367     PJ_type_variable_new (tnstr, color, root);
 368   }
 369   xbt_dict_cursor_t cursor = NULL;
 370   type_t child_type;
 371   char *name;
 372   xbt_dict_foreach(root->children, cursor, name, child_type) {
 373     recursiveNewVariableType (new_typename, color, child_type);
 374   }
 375 }
 376
 377 void instr_new_variable_type (const char *new_typename, const char *color)
 378 {
 379   recursiveNewVariableType (new_typename, color, PJ_type_get_root());
 380 }
 381
 382 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
 383 {
 384   if (!strcmp (root->name, father_type)){
 385     PJ_type_variable_new (new_typename, color, root);
 386   }
 387   xbt_dict_cursor_t cursor = NULL;
 388   type_t child_type;
 389   char *name;
 390   xbt_dict_foreach(root->children, cursor, name, child_type) {
 391     recursiveNewUserVariableType (father_type, new_typename, color, child_type);
 392   }
 393 }
 394
 395 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 396 {
 397   recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
 398 }
 399
 400
 401
 402 int instr_platform_traced ()
 403 {
 404   return platform_created;
 405 }
 406
 407 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 408
 409
 410 static xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes)
 411 {
 412   xbt_node_t ret = xbt_dict_get_or_null (nodes, name);
 413   if (ret) return ret;
 414
 415   ret = xbt_graph_new_node (graph, xbt_strdup(name));
 416   xbt_dict_set (nodes, name, ret, NULL);
 417   return ret;
 418 }
 419
 420 static xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges)
 421 {
 422   xbt_edge_t ret;
 423
 424   const char *sn = instr_node_name (s);
 425   const char *dn = instr_node_name (d);
 426   int len = strlen(sn)+strlen(dn)+1;
 427   char *name = (char*)malloc(len * sizeof(char));
 428
 429
 430   snprintf (name, len, "%s%s", sn, dn);
 431   ret = xbt_dict_get_or_null (edges, name);
 432   if (ret == NULL){
 433     snprintf (name, len, "%s%s", dn, sn);
 434     ret = xbt_dict_get_or_null (edges, name);
 435   }
 436
 437   if (ret == NULL){
 438     ret = xbt_graph_new_edge(graph, s, d, NULL);
 439     xbt_dict_set (edges, name, ret, NULL);
 440   }
 441   free (name);
 442   return ret;
 443 }
 444
 445 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
 446     AS_t rc, container_t container)
 447 {
 448   if (!xbt_dict_is_empty(rc->routing_sons)){
 449     xbt_dict_cursor_t cursor = NULL;
 450     AS_t rc_son;
 451     char *child_name;
 452     //bottom-up recursion
 453     xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
 454       container_t child_container = xbt_dict_get (container->children, rc_son->name);
 455       recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
 456     }
 457   }
 458
 459   //let's get routes
 460   xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
 461   container_t child1, child2;
 462   const char *child1_name, *child2_name;
 463   xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
 464     //if child1 is not a link, a smpi node, a msg process or a msg task
 465     if (child1->kind == INSTR_LINK || child1->kind == INSTR_SMPI || child1->kind == INSTR_MSG_PROCESS || child1->kind == INSTR_MSG_TASK) continue;
 466
 467     xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
 468       //if child2 is not a link, a smpi node, a msg process or a msg task
 469       if (child2->kind == INSTR_LINK || child2->kind == INSTR_SMPI || child2->kind == INSTR_MSG_PROCESS || child2->kind == INSTR_MSG_TASK) continue;
 470
 471       //if child1 is not child2
 472       if (strcmp (child1_name, child2_name) == 0) continue;
 473
 474       //get the route
 475       route_t route = xbt_new0(s_route_t,1);
 476       route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
 477       rc->get_route_and_latency(rc, child1->net_elm, child2->net_elm,
 478                                 route, NULL);
 479
 480       //user might want to extract a graph using routes with only one link
 481       //see --cfg=tracing/onelink_only:1 or --help-tracing for details
 482       if (TRACE_onelink_only() && xbt_dynar_length (route->link_list) > 1) continue;
 483
 484       //traverse the route connecting the containers
 485       unsigned int cpt;
 486       void *link;
 487       xbt_node_t current, previous;
 488       if (route->src_gateway){
 489         previous = new_xbt_graph_node(graph, route->src_gateway->name, nodes);
 490       }else{
 491         previous = new_xbt_graph_node(graph, child1_name, nodes);
 492       }
 493
 494       xbt_dynar_foreach (route->link_list, cpt, link) {
 495         char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 496         current = new_xbt_graph_node(graph, link_name, nodes);
 497         new_xbt_graph_edge (graph, previous, current, edges);
 498         //previous -> current
 499         previous = current;
 500       }
 501       if (route->dst_gateway){
 502         current = new_xbt_graph_node(graph, route->dst_gateway->name, nodes);
 503       }else{
 504         current = new_xbt_graph_node(graph, child2_name, nodes);
 505       }
 506       new_xbt_graph_edge (graph, previous, current, edges);
 507       generic_free_route(route);
 508     }
 509   }
 510
 511 }
 512
 513 xbt_graph_t instr_routing_platform_graph (void)
 514 {
 515   xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
 516   xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
 517   xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
 518   recursiveXBTGraphExtraction (ret, nodes, edges, global_routing->root, PJ_container_get_root());
 519   xbt_dict_free (&nodes);
 520   xbt_dict_free (&edges);
 521   return ret;
 522 }
 523
 524 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 525 {
 526   unsigned int cursor = 0;
 527   xbt_node_t node = NULL;
 528   xbt_edge_t edge = NULL;
 529   FILE *file = NULL;
 530
 531   file = fopen(filename, "w");
 532   xbt_assert(file, "Failed to open %s \n", filename);
 533
 534   if (g->directed)
 535     fprintf(file, "digraph test {\n");
 536   else
 537     fprintf(file, "graph test {\n");
 538
 539   fprintf(file, "  graph [overlap=scale]\n");
 540
 541   fprintf(file, "  node [shape=box, style=filled]\n");
 542   fprintf(file,
 543           "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 544
 545   xbt_dynar_foreach(g->nodes, cursor, node) {
 546     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 547   }
 548   xbt_dynar_foreach(g->edges, cursor, edge) {
 549     const char *src_s = instr_node_name (edge->src);
 550     const char *dst_s = instr_node_name (edge->dst);
 551     if (g->directed)
 552       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 553     else
 554       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 555   }
 556   fprintf(file, "}\n");
 557   fclose(file);
 558
 559 }
 560
 561 #endif /* HAVE_TRACING */
 562