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) continue;
 155
 156       //traverse the route connecting the containers
 157       unsigned int cpt;
 158       void *link;
 159       container_t current, previous;
 160       if (route->src_gateway){
 161         previous = PJ_container_get(route->src_gateway->name);
 162       }else{
 163         previous = child1;
 164       }
 165
 166       xbt_dynar_foreach (route->link_list, cpt, link) {
 167         char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 168         current = PJ_container_get(link_name);
 169         linkContainers(previous, current, filter);
 170         previous = current;
 171       }
 172       if (route->dst_gateway){
 173         current = PJ_container_get(route->dst_gateway->name);
 174       }else{
 175         current = child2;
 176       }
 177       linkContainers(previous, current, filter);
 178       generic_free_route(route);
 179     }
 180   }
 181 }
 182
 183 /*
 184  * Callbacks
 185  */
 186 static void instr_routing_parse_start_AS (const char*id,const char*routing)
 187 {
 188   if (PJ_container_get_root() == NULL){
 189     PJ_container_alloc ();
 190     PJ_type_alloc();
 191     container_t root = PJ_container_new (id, INSTR_AS, NULL);
 192     PJ_container_set_root (root);
 193
 194     if (TRACE_smpi_is_enabled()) {
 195       if (!TRACE_smpi_is_grouped()){
 196         type_t mpi = PJ_type_get_or_null ("MPI", root->type);
 197         if (mpi == NULL){
 198           mpi = PJ_type_container_new("MPI", root->type);
 199           PJ_type_state_new ("MPI_STATE", mpi);
 200           PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 201         }
 202       }
 203     }
 204
 205     if (TRACE_needs_platform()){
 206       currentContainer = xbt_dynar_new (sizeof(container_t), NULL);
 207       xbt_dynar_push (currentContainer, &root);
 208     }
 209     return;
 210   }
 211
 212   if (TRACE_needs_platform()){
 213     container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 214     container_t new = PJ_container_new (id, INSTR_AS, father);
 215     xbt_dynar_push (currentContainer, &new);
 216   }
 217 }
 218
 219 static void instr_routing_parse_end_AS ()
 220 {
 221   if (TRACE_needs_platform()){
 222     xbt_dynar_pop_ptr (currentContainer);
 223   }
 224 }
 225
 226 static void instr_routing_parse_start_link (sg_platf_link_cbarg_t link)
 227 {
 228   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 229
 230   double bandwidth_value = link->bandwidth;
 231   double latency_value = link->latency;
 232   xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
 233
 234   if (link->policy == SURF_LINK_FULLDUPLEX){
 235     char *up = bprintf("%s_UP", link->id);
 236     char *down = bprintf("%s_DOWN", link->id);
 237     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
 238     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
 239     free (up);
 240     free (down);
 241   }else{
 242     xbt_dynar_push_as (links_to_create, char*, strdup(link->id));
 243   }
 244
 245   char *link_name = NULL;
 246   unsigned int i;
 247   xbt_dynar_foreach (links_to_create, i, link_name){
 248
 249     container_t new = PJ_container_new (link_name, INSTR_LINK, father);
 250
 251     if (TRACE_categorized() || TRACE_uncategorized()){
 252       type_t bandwidth = PJ_type_get_or_null ("bandwidth", new->type);
 253       if (bandwidth == NULL){
 254         bandwidth = PJ_type_variable_new ("bandwidth", NULL, new->type);
 255       }
 256       type_t latency = PJ_type_get_or_null ("latency", new->type);
 257       if (latency == NULL){
 258         latency = PJ_type_variable_new ("latency", NULL, new->type);
 259       }
 260       new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
 261       new_pajeSetVariable (0, new, latency, latency_value);
 262     }
 263     if (TRACE_uncategorized()){
 264       type_t bandwidth_used = PJ_type_get_or_null ("bandwidth_used", new->type);
 265       if (bandwidth_used == NULL){
 266         bandwidth_used = PJ_type_variable_new ("bandwidth_used", "0.5 0.5 0.5", new->type);
 267       }
 268     }
 269   }
 270
 271   xbt_dynar_free (&links_to_create);
 272 }
 273
 274 static void instr_routing_parse_start_host (sg_platf_host_cbarg_t host)
 275 {
 276   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 277   container_t new = PJ_container_new (host->id, INSTR_HOST, father);
 278
 279   if (TRACE_categorized() || TRACE_uncategorized()) {
 280     type_t power = PJ_type_get_or_null ("power", new->type);
 281     if (power == NULL){
 282       power = PJ_type_variable_new ("power", NULL, new->type);
 283     }
 284     new_pajeSetVariable (0, new, power, host->power_peak);
 285   }
 286   if (TRACE_uncategorized()){
 287     type_t power_used = PJ_type_get_or_null ("power_used", new->type);
 288     if (power_used == NULL){
 289       power_used = PJ_type_variable_new ("power_used", "0.5 0.5 0.5", new->type);
 290     }
 291   }
 292
 293   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 294     type_t mpi = PJ_type_get_or_null ("MPI", new->type);
 295     if (mpi == NULL){
 296       mpi = PJ_type_container_new("MPI", new->type);
 297       PJ_type_state_new ("MPI_STATE", mpi);
 298       PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 299     }
 300   }
 301
 302   if (TRACE_msg_process_is_enabled()) {
 303     type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", new->type);
 304     if (msg_process == NULL){
 305       msg_process = PJ_type_container_new("MSG_PROCESS", new->type);
 306       type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
 307       PJ_value_new ("executing", "0 1 0", state);
 308       PJ_value_new ("suspend", "1 0 1", state);
 309       PJ_value_new ("sleep", "1 1 0", state);
 310       PJ_value_new ("receive", "1 0 0", state);
 311       PJ_value_new ("send", "0 0 1", state);
 312       PJ_value_new ("task_execute", "0 1 1", state);
 313       PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
 314       PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
 315     }
 316   }
 317 }
 318
 319 static void instr_routing_parse_start_router (sg_platf_router_cbarg_t router)
 320 {
 321   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 322   PJ_container_new (router->id, INSTR_ROUTER, father);
 323 }
 324
 325 static void instr_routing_parse_end_platform ()
 326 {
 327   xbt_dynar_free(&currentContainer);
 328   currentContainer = NULL;
 329   xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free);
 330   recursiveGraphExtraction (global_routing->root, PJ_container_get_root(), filter);
 331   xbt_dict_free(&filter);
 332   platform_created = 1;
 333   TRACE_paje_dump_buffer(1);
 334 }
 335
 336 void instr_routing_define_callbacks ()
 337 {
 338   if (!TRACE_is_enabled()) return;
 339   //always need the call backs to ASes (we need only the root AS),
 340   //to create the rootContainer and the rootType properly
 341   sg_platf_AS_begin_add_cb(instr_routing_parse_start_AS);
 342   sg_platf_AS_end_add_cb(instr_routing_parse_end_AS);
 343   if (!TRACE_needs_platform()) return;
 344   sg_platf_link_add_cb(instr_routing_parse_start_link);
 345   sg_platf_host_add_cb(instr_routing_parse_start_host);
 346   sg_platf_router_add_cb(instr_routing_parse_start_router);
 347
 348   sg_platf_postparse_add_cb(instr_routing_parse_end_platform);
 349 }
 350
 351 /*
 352  * user categories support
 353  */
 354 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
 355 {
 356   if (!strcmp (root->name, "HOST")){
 357     char tnstr[INSTR_DEFAULT_STR_SIZE];
 358     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 359     PJ_type_variable_new (tnstr, color, root);
 360   }
 361   if (!strcmp (root->name, "LINK")){
 362     char tnstr[INSTR_DEFAULT_STR_SIZE];
 363     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
 364     PJ_type_variable_new (tnstr, color, root);
 365   }
 366   xbt_dict_cursor_t cursor = NULL;
 367   type_t child_type;
 368   char *name;
 369   xbt_dict_foreach(root->children, cursor, name, child_type) {
 370     recursiveNewVariableType (new_typename, color, child_type);
 371   }
 372 }
 373
 374 void instr_new_variable_type (const char *new_typename, const char *color)
 375 {
 376   recursiveNewVariableType (new_typename, color, PJ_type_get_root());
 377 }
 378
 379 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
 380 {
 381   if (!strcmp (root->name, father_type)){
 382     PJ_type_variable_new (new_typename, color, root);
 383   }
 384   xbt_dict_cursor_t cursor = NULL;
 385   type_t child_type;
 386   char *name;
 387   xbt_dict_foreach(root->children, cursor, name, child_type) {
 388     recursiveNewUserVariableType (father_type, new_typename, color, child_type);
 389   }
 390 }
 391
 392 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 393 {
 394   recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
 395 }
 396
 397
 398
 399 int instr_platform_traced ()
 400 {
 401   return platform_created;
 402 }
 403
 404 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 405
 406
 407 static xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes)
 408 {
 409   xbt_node_t ret = xbt_dict_get_or_null (nodes, name);
 410   if (ret) return ret;
 411
 412   ret = xbt_graph_new_node (graph, xbt_strdup(name));
 413   xbt_dict_set (nodes, name, ret, NULL);
 414   return ret;
 415 }
 416
 417 static xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges)
 418 {
 419   xbt_edge_t ret;
 420
 421   const char *sn = instr_node_name (s);
 422   const char *dn = instr_node_name (d);
 423   int len = strlen(sn)+strlen(dn)+1;
 424   char *name = (char*)malloc(len * sizeof(char));
 425
 426
 427   snprintf (name, len, "%s%s", sn, dn);
 428   ret = xbt_dict_get_or_null (edges, name);
 429   if (ret == NULL){
 430     snprintf (name, len, "%s%s", dn, sn);
 431     ret = xbt_dict_get_or_null (edges, name);
 432   }
 433
 434   if (ret == NULL){
 435     ret = xbt_graph_new_edge(graph, s, d, NULL);
 436     xbt_dict_set (edges, name, ret, NULL);
 437   }
 438   free (name);
 439   return ret;
 440 }
 441
 442 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
 443     AS_t rc, container_t container)
 444 {
 445   if (!xbt_dict_is_empty(rc->routing_sons)){
 446     xbt_dict_cursor_t cursor = NULL;
 447     AS_t rc_son;
 448     char *child_name;
 449     //bottom-up recursion
 450     xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
 451       container_t child_container = xbt_dict_get (container->children, rc_son->name);
 452       recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
 453     }
 454   }
 455
 456   //let's get routes
 457   xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
 458   container_t child1, child2;
 459   const char *child1_name, *child2_name;
 460   xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
 461     //if child1 is not a link, a smpi node, a msg process or a msg task
 462     if (child1->kind == INSTR_LINK || child1->kind == INSTR_SMPI || child1->kind == INSTR_MSG_PROCESS || child1->kind == INSTR_MSG_TASK) continue;
 463
 464     xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
 465       //if child2 is not a link, a smpi node, a msg process or a msg task
 466       if (child2->kind == INSTR_LINK || child2->kind == INSTR_SMPI || child2->kind == INSTR_MSG_PROCESS || child2->kind == INSTR_MSG_TASK) continue;
 467
 468       //if child1 is not child2
 469       if (strcmp (child1_name, child2_name) == 0) continue;
 470
 471       //get the route
 472       route_t route = xbt_new0(s_route_t,1);
 473       route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
 474       rc->get_route_and_latency(rc, child1->net_elm, child2->net_elm,
 475                                 route, NULL);
 476
 477       //user might want to extract a graph using routes with only one link
 478       //see --cfg=tracing/onelink_only:1 or --help-tracing for details
 479       if (TRACE_onelink_only() && xbt_dynar_length (route->link_list) > 1) continue;
 480
 481       //traverse the route connecting the containers
 482       unsigned int cpt;
 483       void *link;
 484       xbt_node_t current, previous;
 485       if (route->src_gateway){
 486         previous = new_xbt_graph_node(graph, route->src_gateway->name, nodes);
 487       }else{
 488         previous = new_xbt_graph_node(graph, child1_name, nodes);
 489       }
 490
 491       xbt_dynar_foreach (route->link_list, cpt, link) {
 492         char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 493         current = new_xbt_graph_node(graph, link_name, nodes);
 494         new_xbt_graph_edge (graph, previous, current, edges);
 495         //previous -> current
 496         previous = current;
 497       }
 498       if (route->dst_gateway){
 499         current = new_xbt_graph_node(graph, route->dst_gateway->name, nodes);
 500       }else{
 501         current = new_xbt_graph_node(graph, child2_name, nodes);
 502       }
 503       new_xbt_graph_edge (graph, previous, current, edges);
 504       generic_free_route(route);
 505     }
 506   }
 507
 508 }
 509
 510 xbt_graph_t instr_routing_platform_graph (void)
 511 {
 512   xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
 513   xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
 514   xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
 515   recursiveXBTGraphExtraction (ret, nodes, edges, global_routing->root, PJ_container_get_root());
 516   xbt_dict_free (&nodes);
 517   xbt_dict_free (&edges);
 518   return ret;
 519 }
 520
 521 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 522 {
 523   unsigned int cursor = 0;
 524   xbt_node_t node = NULL;
 525   xbt_edge_t edge = NULL;
 526   FILE *file = NULL;
 527
 528   file = fopen(filename, "w");
 529   xbt_assert(file, "Failed to open %s \n", filename);
 530
 531   if (g->directed)
 532     fprintf(file, "digraph test {\n");
 533   else
 534     fprintf(file, "graph test {\n");
 535
 536   fprintf(file, "  graph [overlap=scale]\n");
 537
 538   fprintf(file, "  node [shape=box, style=filled]\n");
 539   fprintf(file,
 540           "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 541
 542   xbt_dynar_foreach(g->nodes, cursor, node) {
 543     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 544   }
 545   xbt_dynar_foreach(g->edges, cursor, edge) {
 546     const char *src_s = instr_node_name (edge->src);
 547     const char *dst_s = instr_node_name (edge->dst);
 548     if (g->directed)
 549       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 550     else
 551       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 552   }
 553   fprintf(file, "}\n");
 554   fclose(file);
 555
 556 }
 557
 558 #endif /* HAVE_TRACING */
 559