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