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 container_t findChild (container_t root, container_t a1)
  22 {
  23   if (root == a1) return root;
  24
  25   xbt_dict_cursor_t cursor = NULL;
  26   container_t child;
  27   char *child_name;
  28   xbt_dict_foreach(root->children, cursor, child_name, child) {
  29     if (findChild (child, a1)) return child;
  30   }
  31   return NULL;
  32 }
  33
  34 static container_t findCommonFather (container_t root, container_t a1, container_t a2)
  35 {
  36   if (a1->father == a2->father) return a1->father;
  37
  38   xbt_dict_cursor_t cursor = NULL;
  39   container_t child;
  40   char *child_name;
  41   container_t a1_try = NULL;
  42   container_t a2_try = NULL;
  43   xbt_dict_foreach(root->children, cursor, child_name, child) {
  44     a1_try = findChild (child, a1);
  45     a2_try = findChild (child, a2);
  46     if (a1_try && a2_try) return child;
  47   }
  48   return NULL;
  49 }
  50
  51 static void linkContainers (container_t father, container_t src, container_t dst, xbt_dict_t filter)
  52 {
  53   //ignore loopback
  54   if (strcmp (src->name, "__loopback__") == 0 || strcmp (dst->name, "__loopback__") == 0)
  55     return;
  56
  57   if (filter != NULL){
  58     //check if we already register this pair (we only need one direction)
  59     char aux1[INSTR_DEFAULT_STR_SIZE], aux2[INSTR_DEFAULT_STR_SIZE];
  60     snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", src->name, dst->name);
  61     snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", dst->name, src->name);
  62     if (xbt_dict_get_or_null (filter, aux1)) return;
  63     if (xbt_dict_get_or_null (filter, aux2)) return;
  64
  65     //ok, not found, register it
  66     xbt_dict_set (filter, aux1, xbt_strdup ("1"), xbt_free);
  67     xbt_dict_set (filter, aux2, xbt_strdup ("1"), xbt_free);
  68   }
  69
  70   //declare type
  71   char link_typename[INSTR_DEFAULT_STR_SIZE];
  72   snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s", src->type->name, dst->type->name);
  73   type_t link_type = getLinkType (link_typename, father->type, src->type, dst->type);
  74
  75   //register EDGE types for triva configuration
  76   xbt_dict_set (trivaEdgeTypes, link_type->name, xbt_strdup("1"), xbt_free);
  77
  78   //create the link
  79   static long long counter = 0;
  80   char key[INSTR_DEFAULT_STR_SIZE];
  81   snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
  82   new_pajeStartLink(SIMIX_get_clock(), father, link_type, src, "G", key);
  83   new_pajeEndLink(SIMIX_get_clock(), father, link_type, dst, "G", key);
  84 }
  85
  86 static void recursiveGraphExtraction (AS_t rc, container_t container, xbt_dict_t filter)
  87 {
  88   if (xbt_dict_length (rc->routing_sons)){
  89     xbt_dict_cursor_t cursor = NULL;
  90     AS_t rc_son;
  91     char *child_name;
  92     //bottom-up recursion
  93     xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
  94       container_t child_container = xbt_dict_get (container->children, rc_son->name);
  95       recursiveGraphExtraction (rc_son, child_container, filter);
  96     }
  97   }
  98
  99   //let's get routes
 100   xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
 101   container_t child1, child2;
 102   const char *child1_name, *child2_name;
 103   xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
 104     if (child1->kind == INSTR_LINK) continue;
 105     xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
 106       if (child2->kind == INSTR_LINK) continue;
 107
 108       if ((child1->kind == INSTR_HOST || child1->kind == INSTR_ROUTER) &&
 109           (child2->kind == INSTR_HOST  || child2->kind == INSTR_ROUTER) &&
 110           strcmp (child1_name, child2_name) != 0){
 111
 112         xbt_dynar_t route = NULL;
 113         route = global_routing->get_route_or_null (child1_name, child2_name);
 114         if (route == NULL) continue;
 115
 116         if (TRACE_onelink_only()){
 117           if (xbt_dynar_length (route) > 1) continue;
 118         }
 119         container_t previous = child1;
 120         int i;
 121         for (i = 0; i < xbt_dynar_length(route); i++){
 122           link_CM02_t *link = ((link_CM02_t*)xbt_dynar_get_ptr (route, i));
 123           char *link_name = (*link)->lmm_resource.generic_resource.name;
 124           container_t current = getContainerByName(link_name);
 125           linkContainers(container, previous, current, filter);
 126           previous = current;
 127         }
 128         linkContainers(container, previous, child2, filter);
 129
 130       }else if (child1->kind == INSTR_AS &&
 131                 child2->kind == INSTR_AS &&
 132                 strcmp(child1_name, child2_name) != 0){
 133
 134         route_extended_t route = rc->get_route (rc, child1_name, child2_name);
 135         unsigned int cpt;
 136         void *link;
 137         container_t previous = getContainerByName(route->src_gateway);
 138         xbt_dynar_foreach (route->generic_route.link_list, cpt, link) {
 139           char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 140           container_t current = getContainerByName(link_name);
 141           linkContainers (container, previous, current, filter);
 142           previous = current;
 143         }
 144         container_t last = getContainerByName(route->dst_gateway);
 145         linkContainers (container, previous, last, filter);
 146       }
 147     }
 148   }
 149 }
 150
 151 /*
 152  * Callbacks
 153  */
 154 static void instr_routing_parse_start_AS (const char*id,const char*routing)
 155 {
 156   if (getRootContainer() == NULL){
 157     container_t root = newContainer (id, INSTR_AS, NULL);
 158     instr_paje_init (root);
 159
 160     if (TRACE_smpi_is_enabled()) {
 161       if (!TRACE_smpi_is_grouped()){
 162         type_t mpi = getContainerType("MPI", root->type);
 163         getStateType ("MPI_STATE", mpi);
 164         getLinkType ("MPI_LINK", getRootType(), mpi, mpi);
 165       }
 166     }
 167
 168     if (TRACE_needs_platform()){
 169       currentContainer = xbt_dynar_new (sizeof(container_t), NULL);
 170       xbt_dynar_push (currentContainer, &root);
 171     }
 172     return;
 173   }
 174
 175   if (TRACE_needs_platform()){
 176     container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 177     container_t new = newContainer (id, INSTR_AS, father);
 178     xbt_dynar_push (currentContainer, &new);
 179   }
 180 }
 181
 182 static void instr_routing_parse_end_AS ()
 183 {
 184   if (TRACE_needs_platform()){
 185     xbt_dynar_pop_ptr (currentContainer);
 186   }
 187 }
 188
 189 static void instr_routing_parse_start_link (sg_platf_link_cbarg_t link)
 190 {
 191   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 192
 193   double bandwidth_value = link->bandwidth;
 194   double latency_value = link->latency;
 195   xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
 196
 197   if (link->policy == SURF_LINK_FULLDUPLEX){
 198     char *up = bprintf("%s_UP", link->id);
 199     char *down = bprintf("%s_DOWN", link->id);
 200     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
 201     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
 202     free (up);
 203     free (down);
 204   }else{
 205     xbt_dynar_push_as (links_to_create, char*, strdup(link->id));
 206   }
 207
 208   char *link_name = NULL;
 209   unsigned int i;
 210   xbt_dynar_foreach (links_to_create, i, link_name){
 211
 212     container_t new = newContainer (link_name, INSTR_LINK, father);
 213
 214     if (TRACE_categorized() || TRACE_uncategorized()){
 215       type_t bandwidth = getVariableType ("bandwidth", NULL, new->type);
 216       type_t latency = getVariableType ("latency", NULL, new->type);
 217       new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
 218       new_pajeSetVariable (0, new, latency, latency_value);
 219     }
 220     if (TRACE_uncategorized()){
 221       getVariableType ("bandwidth_used", "0.5 0.5 0.5", new->type);
 222     }
 223   }
 224
 225   xbt_dynar_free (&links_to_create);
 226 }
 227
 228 static void instr_routing_parse_start_host (sg_platf_host_cbarg_t host)
 229 {
 230   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 231   container_t new = newContainer (host->id, INSTR_HOST, father);
 232
 233   if (TRACE_categorized() || TRACE_uncategorized()) {
 234     type_t power = getVariableType ("power", NULL, new->type);
 235     new_pajeSetVariable (0, new, power, host->power_peak);
 236   }
 237   if (TRACE_uncategorized()){
 238     getVariableType ("power_used", "0.5 0.5 0.5", new->type);
 239   }
 240
 241   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 242     type_t mpi = getContainerType("MPI", new->type);
 243     getStateType ("MPI_STATE", mpi);
 244     getLinkType ("MPI_LINK", getRootType(), mpi, mpi);
 245   }
 246
 247   if (TRACE_msg_process_is_enabled()) {
 248     type_t msg_process = getContainerType("MSG_PROCESS", new->type);
 249     type_t state = getStateType ("MSG_PROCESS_STATE", msg_process);
 250     getValue ("executing", "0 1 0", state);
 251     getValue ("suspend", "1 0 1", state);
 252     getValue ("sleep", "1 1 0", state);
 253     getValue ("receive", "1 0 0", state);
 254     getValue ("send", "0 0 1", state);
 255     getValue ("task_execute", "0 1 1", state);
 256     getLinkType ("MSG_PROCESS_LINK", getRootType(), msg_process, msg_process);
 257     getLinkType ("MSG_PROCESS_TASK_LINK", getRootType(), msg_process, msg_process);
 258   }
 259
 260   if (TRACE_msg_task_is_enabled()) {
 261     type_t msg_task = getContainerType ("MSG_TASK", new->type);
 262     type_t state = getStateType ("MSG_TASK_STATE", msg_task);
 263     getValue ("MSG_task_execute", "0 1 0", state);
 264     getValue ("created", "1 1 0", state);
 265     getLinkType ("MSG_TASK_LINK", getRootType(), msg_task, msg_task);
 266   }
 267 }
 268
 269 static void instr_routing_parse_start_router (sg_platf_router_cbarg_t router)
 270 {
 271   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 272   newContainer (router->id, INSTR_ROUTER, father);
 273 }
 274
 275 static void instr_routing_parse_end_platform ()
 276 {
 277   xbt_dynar_free(&currentContainer);
 278   currentContainer = NULL;
 279   xbt_dict_t filter = xbt_dict_new ();
 280   recursiveGraphExtraction (global_routing->root, getRootContainer(), filter);
 281   xbt_dict_free(&filter);
 282   platform_created = 1;
 283   TRACE_paje_dump_buffer(1);
 284 }
 285
 286 void instr_routing_define_callbacks ()
 287 {
 288   if (!TRACE_is_enabled()) return;
 289   //always need the call backs to ASes (we need only the root AS),
 290   //to create the rootContainer and the rootType properly
 291   sg_platf_AS_begin_add_cb(instr_routing_parse_start_AS);
 292   sg_platf_AS_end_add_cb(instr_routing_parse_end_AS);
 293   if (!TRACE_needs_platform()) return;
 294   sg_platf_link_add_cb(instr_routing_parse_start_link);
 295   sg_platf_host_add_cb(instr_routing_parse_start_host);
 296   sg_platf_router_add_cb(instr_routing_parse_start_router);
 297
 298   sg_platf_postparse_add_cb(instr_routing_parse_end_platform);
 299 }
 300
 301 /*
 302  * user categories support
 303  */
 304 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
 305 {
 306   if (!strcmp (root->name, "HOST")){
 307     char tnstr[INSTR_DEFAULT_STR_SIZE];
 308     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 309     getVariableType(tnstr, color, root);
 310   }
 311   if (!strcmp (root->name, "LINK")){
 312     char tnstr[INSTR_DEFAULT_STR_SIZE];
 313     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
 314     getVariableType(tnstr, color, root);
 315   }
 316   xbt_dict_cursor_t cursor = NULL;
 317   type_t child_type;
 318   char *name;
 319   xbt_dict_foreach(root->children, cursor, name, child_type) {
 320     recursiveNewVariableType (new_typename, color, child_type);
 321   }
 322 }
 323
 324 void instr_new_variable_type (const char *new_typename, const char *color)
 325 {
 326   recursiveNewVariableType (new_typename, color, getRootType());
 327 }
 328
 329 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
 330 {
 331   if (!strcmp (root->name, father_type)){
 332     getVariableType(new_typename, color, root);
 333   }
 334   xbt_dict_cursor_t cursor = NULL;
 335   type_t child_type;
 336   char *name;
 337   xbt_dict_foreach(root->children, cursor, name, child_type) {
 338     recursiveNewUserVariableType (father_type, new_typename, color, child_type);
 339   }
 340 }
 341
 342 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 343 {
 344   recursiveNewUserVariableType (father_type, new_typename, color, getRootType());
 345 }
 346
 347
 348
 349 int instr_platform_traced ()
 350 {
 351   return platform_created;
 352 }
 353
 354 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 355
 356
 357 static xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes)
 358 {
 359   xbt_node_t ret = xbt_dict_get_or_null (nodes, name);
 360   if (ret) return ret;
 361
 362   ret = xbt_graph_new_node (graph, xbt_strdup(name));
 363   xbt_dict_set (nodes, name, ret, NULL);
 364   return ret;
 365 }
 366
 367 static xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges)
 368 {
 369   xbt_edge_t ret;
 370   char *name;
 371
 372   const char *sn = TRACE_node_name (s);
 373   const char *dn = TRACE_node_name (d);
 374
 375   name = bprintf ("%s%s", sn, dn);
 376   ret = xbt_dict_get_or_null (edges, name);
 377   if (ret) return ret;
 378   free (name);
 379   name = bprintf ("%s%s", dn, sn);
 380   ret = xbt_dict_get_or_null (edges, name);
 381   if (ret) return ret;
 382
 383   ret = xbt_graph_new_edge(graph, s, d, NULL);
 384   xbt_dict_set (edges, name, ret, NULL);
 385   return ret;
 386 }
 387
 388 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
 389     AS_t rc, container_t container)
 390 {
 391   if (xbt_dict_length (rc->routing_sons)){
 392     xbt_dict_cursor_t cursor = NULL;
 393     AS_t rc_son;
 394     char *child_name;
 395     //bottom-up recursion
 396     xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
 397       container_t child_container = xbt_dict_get (container->children, rc_son->name);
 398       recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
 399     }
 400   }
 401
 402   //let's get routes
 403   xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
 404   container_t child1, child2;
 405   const char *child1_name, *child2_name;
 406   xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
 407     if (child1->kind == INSTR_LINK) continue;
 408     xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
 409       if (child2->kind == INSTR_LINK) continue;
 410
 411       if ((child1->kind == INSTR_HOST || child1->kind == INSTR_ROUTER) &&
 412           (child2->kind == INSTR_HOST  || child2->kind == INSTR_ROUTER) &&
 413           strcmp (child1_name, child2_name) != 0){
 414
 415         xbt_dynar_t route = global_routing->get_route (child1_name, child2_name);
 416         if (TRACE_onelink_only()){
 417           if (xbt_dynar_length (route) > 1) continue;
 418         }
 419         unsigned int cpt;
 420         void *link;
 421         xbt_node_t current, previous = new_xbt_graph_node(graph, child1_name, nodes);
 422         xbt_dynar_foreach (route, cpt, link) {
 423           char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 424           current = new_xbt_graph_node(graph, link_name, nodes);
 425           new_xbt_graph_edge (graph, previous, current, edges);
 426           //previous -> current
 427           previous = current;
 428         }
 429         current = new_xbt_graph_node(graph, child2_name, nodes);
 430         new_xbt_graph_edge (graph, previous, current, edges);
 431
 432       }else if (child1->kind == INSTR_AS &&
 433                 child2->kind == INSTR_AS &&
 434                 strcmp(child1_name, child2_name) != 0){
 435
 436         route_extended_t route = rc->get_route (rc, child1_name, child2_name);
 437         unsigned int cpt;
 438         void *link;
 439         xbt_node_t current, previous = new_xbt_graph_node(graph, route->src_gateway, nodes);
 440         xbt_dynar_foreach (route->generic_route.link_list, cpt, link) {
 441           char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 442           current = new_xbt_graph_node(graph, link_name, nodes);
 443           //previous -> current
 444           previous = current;
 445         }
 446         current = new_xbt_graph_node(graph, route->dst_gateway, nodes);
 447         new_xbt_graph_edge (graph, previous, current, edges);
 448       }
 449     }
 450   }
 451
 452 }
 453
 454 xbt_graph_t instr_routing_platform_graph (void)
 455 {
 456   xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
 457   xbt_dict_t nodes = xbt_dict_new ();
 458   xbt_dict_t edges = xbt_dict_new ();
 459   recursiveXBTGraphExtraction (ret, nodes, edges, global_routing->root, getRootContainer());
 460   return ret;
 461 }
 462
 463 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 464 {
 465   unsigned int cursor = 0;
 466   xbt_node_t node = NULL;
 467   xbt_edge_t edge = NULL;
 468   FILE *file = NULL;
 469
 470   file = fopen(filename, "w");
 471   xbt_assert(file, "Failed to open %s \n", filename);
 472
 473   if (g->directed)
 474     fprintf(file, "digraph test {\n");
 475   else
 476     fprintf(file, "graph test {\n");
 477
 478   fprintf(file, "  graph [overlap=scale]\n");
 479
 480   fprintf(file, "  node [shape=box, style=filled]\n");
 481   fprintf(file,
 482           "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 483
 484   xbt_dynar_foreach(g->nodes, cursor, node) {
 485     fprintf(file, "  \"%s\";\n", TRACE_node_name(node));
 486   }
 487   xbt_dynar_foreach(g->edges, cursor, edge) {
 488     const char *src_s = TRACE_node_name (edge->src);
 489     const char *dst_s = TRACE_node_name (edge->dst);
 490     if (g->directed)
 491       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 492     else
 493       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 494   }
 495   fprintf(file, "}\n");
 496   fclose(file);
 497
 498 }
 499
 500 #endif /* HAVE_TRACING */
 501