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 (routing_component_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     routing_component_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 ()
 155 {
 156   if (getRootContainer() == NULL){
 157     container_t root = newContainer (A_surfxml_AS_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 (A_surfxml_AS_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 ()
 190 {
 191   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 192   const char *link_id = A_surfxml_link_id;
 193
 194   double bandwidth_value = atof(A_surfxml_link_bandwidth);
 195   double latency_value = atof(A_surfxml_link_latency);
 196   xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
 197
 198   if (A_surfxml_link_sharing_policy == A_surfxml_link_sharing_policy_FULLDUPLEX){
 199     char *up = bprintf("%s_UP", link_id);
 200     char *down = bprintf("%s_DOWN", link_id);
 201     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
 202     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
 203     free (up);
 204     free (down);
 205   }else{
 206     xbt_dynar_push_as (links_to_create, char*, strdup(link_id));
 207   }
 208
 209   char *link_name = NULL;
 210   unsigned int i;
 211   xbt_dynar_foreach (links_to_create, i, link_name){
 212
 213     container_t new = newContainer (link_name, INSTR_LINK, father);
 214
 215     if (TRACE_categorized() || TRACE_uncategorized()){
 216       type_t bandwidth = getVariableType ("bandwidth", NULL, new->type);
 217       type_t latency = getVariableType ("latency", NULL, new->type);
 218       new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
 219       new_pajeSetVariable (0, new, latency, latency_value);
 220     }
 221     if (TRACE_uncategorized()){
 222       getVariableType ("bandwidth_used", "0.5 0.5 0.5", new->type);
 223     }
 224   }
 225
 226   xbt_dynar_free (&links_to_create);
 227 }
 228
 229 static void instr_routing_parse_end_link ()
 230 {
 231 }
 232
 233 static void instr_routing_parse_start_host ()
 234 {
 235   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 236   container_t new = newContainer (A_surfxml_host_id, INSTR_HOST, father);
 237
 238   if (TRACE_categorized() || TRACE_uncategorized()) {
 239     type_t power = getVariableType ("power", NULL, new->type);
 240     new_pajeSetVariable (0, new, power, atof(A_surfxml_host_power));
 241   }
 242   if (TRACE_uncategorized()){
 243     getVariableType ("power_used", "0.5 0.5 0.5", new->type);
 244   }
 245
 246   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 247     type_t mpi = getContainerType("MPI", new->type);
 248     getStateType ("MPI_STATE", mpi);
 249     getLinkType ("MPI_LINK", getRootType(), mpi, mpi);
 250   }
 251
 252   if (TRACE_msg_process_is_enabled()) {
 253     type_t msg_process = getContainerType("MSG_PROCESS", new->type);
 254     type_t state = getStateType ("MSG_PROCESS_STATE", msg_process);
 255     getValue ("executing", "0 1 0", state);
 256     getValue ("suspend", "1 0 1", state);
 257     getValue ("sleep", "1 1 0", state);
 258     getValue ("receive", "1 0 0", state);
 259     getValue ("send", "0 0 1", state);
 260     getValue ("task_execute", "0 1 1", state);
 261     getLinkType ("MSG_PROCESS_LINK", getRootType(), msg_process, msg_process);
 262     getLinkType ("MSG_PROCESS_TASK_LINK", getRootType(), msg_process, msg_process);
 263   }
 264
 265   if (TRACE_msg_task_is_enabled()) {
 266     type_t msg_task = getContainerType ("MSG_TASK", new->type);
 267     type_t state = getStateType ("MSG_TASK_STATE", msg_task);
 268     getValue ("MSG_task_execute", "0 1 0", state);
 269     getValue ("created", "1 1 0", state);
 270     getLinkType ("MSG_TASK_LINK", getRootType(), msg_task, msg_task);
 271   }
 272 }
 273
 274 static void instr_routing_parse_end_host ()
 275 {
 276 }
 277
 278 static void instr_routing_parse_start_router ()
 279 {
 280   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 281   newContainer (A_surfxml_router_id, INSTR_ROUTER, father);
 282 }
 283
 284 static void instr_routing_parse_end_router ()
 285 {
 286 }
 287
 288 static void instr_routing_parse_end_platform ()
 289 {
 290   xbt_dynar_free(&currentContainer);
 291   currentContainer = NULL;
 292   xbt_dict_t filter = xbt_dict_new ();
 293   recursiveGraphExtraction (global_routing->root, getRootContainer(), filter);
 294   xbt_dict_free(&filter);
 295   platform_created = 1;
 296   TRACE_paje_dump_buffer(1);
 297 }
 298
 299 void instr_routing_define_callbacks ()
 300 {
 301   if (!TRACE_is_enabled()) return;
 302   //always need the call backs to ASes (we need only the root AS),
 303   //to create the rootContainer and the rootType properly
 304   surfxml_add_callback(STag_surfxml_AS_cb_list, &instr_routing_parse_start_AS);
 305   surfxml_add_callback(ETag_surfxml_AS_cb_list, &instr_routing_parse_end_AS);
 306   if (!TRACE_needs_platform()) return;
 307   surfxml_add_callback(STag_surfxml_link_cb_list, &instr_routing_parse_start_link);
 308   surfxml_add_callback(ETag_surfxml_link_cb_list, &instr_routing_parse_end_link);
 309   surfxml_add_callback(STag_surfxml_host_cb_list, &instr_routing_parse_start_host);
 310   surfxml_add_callback(ETag_surfxml_host_cb_list, &instr_routing_parse_end_host);
 311   surfxml_add_callback(STag_surfxml_router_cb_list, &instr_routing_parse_start_router);
 312   surfxml_add_callback(ETag_surfxml_router_cb_list, &instr_routing_parse_end_router);
 313   surfxml_add_callback(ETag_surfxml_platform_cb_list, &instr_routing_parse_end_platform);
 314 }
 315
 316 /*
 317  * user categories support
 318  */
 319 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
 320 {
 321   if (!strcmp (root->name, "HOST")){
 322     char tnstr[INSTR_DEFAULT_STR_SIZE];
 323     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 324     getVariableType(tnstr, color, root);
 325   }
 326   if (!strcmp (root->name, "LINK")){
 327     char tnstr[INSTR_DEFAULT_STR_SIZE];
 328     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
 329     getVariableType(tnstr, color, root);
 330   }
 331   xbt_dict_cursor_t cursor = NULL;
 332   type_t child_type;
 333   char *name;
 334   xbt_dict_foreach(root->children, cursor, name, child_type) {
 335     recursiveNewVariableType (new_typename, color, child_type);
 336   }
 337 }
 338
 339 void instr_new_variable_type (const char *new_typename, const char *color)
 340 {
 341   recursiveNewVariableType (new_typename, color, getRootType());
 342 }
 343
 344 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
 345 {
 346   if (!strcmp (root->name, father_type)){
 347     getVariableType(new_typename, color, root);
 348   }
 349   xbt_dict_cursor_t cursor = NULL;
 350   type_t child_type;
 351   char *name;
 352   xbt_dict_foreach(root->children, cursor, name, child_type) {
 353     recursiveNewUserVariableType (father_type, new_typename, color, child_type);
 354   }
 355 }
 356
 357 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 358 {
 359   recursiveNewUserVariableType (father_type, new_typename, color, getRootType());
 360 }
 361
 362
 363
 364 int instr_platform_traced ()
 365 {
 366   return platform_created;
 367 }
 368
 369 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 370
 371
 372 static xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes)
 373 {
 374   xbt_node_t ret = xbt_dict_get_or_null (nodes, name);
 375   if (ret) return ret;
 376
 377   ret = xbt_graph_new_node (graph, xbt_strdup(name));
 378   xbt_dict_set (nodes, name, ret, NULL);
 379   return ret;
 380 }
 381
 382 static xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges)
 383 {
 384   xbt_edge_t ret;
 385   char *name;
 386
 387   const char *sn = TRACE_node_name (s);
 388   const char *dn = TRACE_node_name (d);
 389
 390   name = bprintf ("%s%s", sn, dn);
 391   ret = xbt_dict_get_or_null (edges, name);
 392   if (ret) return ret;
 393   free (name);
 394   name = bprintf ("%s%s", dn, sn);
 395   ret = xbt_dict_get_or_null (edges, name);
 396   if (ret) return ret;
 397
 398   ret = xbt_graph_new_edge(graph, s, d, NULL);
 399   xbt_dict_set (edges, name, ret, NULL);
 400   return ret;
 401 }
 402
 403 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
 404     routing_component_t rc, container_t container)
 405 {
 406   if (xbt_dict_length (rc->routing_sons)){
 407     xbt_dict_cursor_t cursor = NULL;
 408     routing_component_t rc_son;
 409     char *child_name;
 410     //bottom-up recursion
 411     xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
 412       container_t child_container = xbt_dict_get (container->children, rc_son->name);
 413       recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
 414     }
 415   }
 416
 417   //let's get routes
 418   xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
 419   container_t child1, child2;
 420   const char *child1_name, *child2_name;
 421   xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
 422     if (child1->kind == INSTR_LINK) continue;
 423     xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
 424       if (child2->kind == INSTR_LINK) continue;
 425
 426       if ((child1->kind == INSTR_HOST || child1->kind == INSTR_ROUTER) &&
 427           (child2->kind == INSTR_HOST  || child2->kind == INSTR_ROUTER) &&
 428           strcmp (child1_name, child2_name) != 0){
 429
 430         xbt_dynar_t route = global_routing->get_route (child1_name, child2_name);
 431         if (TRACE_onelink_only()){
 432           if (xbt_dynar_length (route) > 1) continue;
 433         }
 434         unsigned int cpt;
 435         void *link;
 436         xbt_node_t current, previous = new_xbt_graph_node(graph, child1_name, nodes);
 437         xbt_dynar_foreach (route, cpt, link) {
 438           char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 439           current = new_xbt_graph_node(graph, link_name, nodes);
 440           new_xbt_graph_edge (graph, previous, current, edges);
 441           //previous -> current
 442           previous = current;
 443         }
 444         current = new_xbt_graph_node(graph, child2_name, nodes);
 445         new_xbt_graph_edge (graph, previous, current, edges);
 446
 447       }else if (child1->kind == INSTR_AS &&
 448                 child2->kind == INSTR_AS &&
 449                 strcmp(child1_name, child2_name) != 0){
 450
 451         route_extended_t route = rc->get_route (rc, child1_name, child2_name);
 452         unsigned int cpt;
 453         void *link;
 454         xbt_node_t current, previous = new_xbt_graph_node(graph, route->src_gateway, nodes);
 455         xbt_dynar_foreach (route->generic_route.link_list, cpt, link) {
 456           char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
 457           current = new_xbt_graph_node(graph, link_name, nodes);
 458           //previous -> current
 459           previous = current;
 460         }
 461         current = new_xbt_graph_node(graph, route->dst_gateway, nodes);
 462         new_xbt_graph_edge (graph, previous, current, edges);
 463       }
 464     }
 465   }
 466
 467 }
 468
 469 xbt_graph_t instr_routing_platform_graph (void)
 470 {
 471   xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
 472   xbt_dict_t nodes = xbt_dict_new ();
 473   xbt_dict_t edges = xbt_dict_new ();
 474   recursiveXBTGraphExtraction (ret, nodes, edges, global_routing->root, getRootContainer());
 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", TRACE_node_name(node));
 501   }
 502   xbt_dynar_foreach(g->edges, cursor, edge) {
 503     const char *src_s = TRACE_node_name (edge->src);
 504     const char *dst_s = TRACE_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 }
 514
 515 #endif /* HAVE_TRACING */
 516