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