src/surf/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 #include "mc/mc.h"
   9
  10 #ifdef HAVE_TRACING
  11 #include "surf/surf_private.h"
  12 //FIXME:#include "surf/network_private.h"
  13 #include "xbt/graph.h"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
  16
  17 static int platform_created = 0;            /* indicate whether the platform file has been traced */
  18 static xbt_dynar_t currentContainer = NULL; /* push and pop, used only in creation */
  19
  20 static const char *instr_node_name (xbt_node_t node)
  21 {
  22   void *data = xbt_graph_node_get_data(node);
  23   char *str = (char*)data;
  24   return str;
  25 }
  26
  27
  28 static container_t lowestCommonAncestor (container_t a1, container_t a2)
  29 {
  30   //this is only an optimization (since most of a1 and a2 share the same parent)
  31   if (a1->father == a2->father) return a1->father;
  32
  33   //create an array with all ancestors of a1
  34   xbt_dynar_t ancestors_a1 = xbt_dynar_new(sizeof(container_t), NULL);
  35   container_t p;
  36   p = a1->father;
  37   while (p){
  38     xbt_dynar_push_as (ancestors_a1, container_t, p);
  39     p = p->father;
  40   }
  41
  42   //create an array with all ancestors of a2
  43   xbt_dynar_t ancestors_a2 = xbt_dynar_new(sizeof(container_t), NULL);
  44   p = a2->father;
  45   while (p){
  46     xbt_dynar_push_as (ancestors_a2, container_t, p);
  47     p = p->father;
  48   }
  49
  50   //find the lowest ancestor
  51   p = NULL;
  52   int i = xbt_dynar_length (ancestors_a1) - 1;
  53   int j = xbt_dynar_length (ancestors_a2) - 1;
  54   while (i >= 0 && j >= 0){
  55     container_t a1p = *(container_t*)xbt_dynar_get_ptr (ancestors_a1, i);
  56     container_t a2p = *(container_t*)xbt_dynar_get_ptr (ancestors_a2, j);
  57     if (a1p == a2p){
  58       p = a1p;
  59     }else{
  60       break;
  61     }
  62     i--;
  63     j--;
  64   }
  65   xbt_dynar_free (&ancestors_a1);
  66   xbt_dynar_free (&ancestors_a2);
  67   return p;
  68 }
  69
  70 static void linkContainers (container_t src, container_t dst, xbt_dict_t filter)
  71 {
  72   //ignore loopback
  73   if (strcmp (src->name, "__loopback__") == 0 || strcmp (dst->name, "__loopback__") == 0){
  74     XBT_DEBUG ("  linkContainers: ignoring loopback link");
  75     return;
  76   }
  77
  78   //find common father
  79   container_t father = lowestCommonAncestor (src, dst);
  80   if (!father){
  81     xbt_die ("common father unknown, this is a tracing problem");
  82   }
  83
  84   if (filter != NULL){
  85     //check if we already register this pair (we only need one direction)
  86     char aux1[INSTR_DEFAULT_STR_SIZE], aux2[INSTR_DEFAULT_STR_SIZE];
  87     snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", src->name, dst->name);
  88     snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", dst->name, src->name);
  89     if (xbt_dict_get_or_null (filter, aux1)){
  90       XBT_DEBUG ("  linkContainers: already registered %s <-> %s (1)", src->name, dst->name);
  91       return;
  92     }
  93     if (xbt_dict_get_or_null (filter, aux2)){
  94       XBT_DEBUG ("  linkContainers: already registered %s <-> %s (2)", dst->name, src->name);
  95       return;
  96     }
  97
  98     //ok, not found, register it
  99     xbt_dict_set (filter, aux1, xbt_strdup ("1"), NULL);
 100     xbt_dict_set (filter, aux2, xbt_strdup ("1"), NULL);
 101   }
 102
 103   //declare type
 104   char link_typename[INSTR_DEFAULT_STR_SIZE];
 105   snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s",
 106             father->type->name,
 107             src->type->name, src->type->id,
 108             dst->type->name, dst->type->id);
 109   type_t link_type = PJ_type_get_or_null (link_typename, father->type);
 110   if (link_type == NULL){
 111     link_type = PJ_type_link_new (link_typename, father->type, src->type, dst->type);
 112   }
 113
 114   //register EDGE types for triva configuration
 115   xbt_dict_set (trivaEdgeTypes, link_type->name, xbt_strdup("1"), NULL);
 116
 117   //create the link
 118   static long long counter = 0;
 119
 120   if(MC_is_active())
 121     MC_ignore_data_bss(&counter, sizeof(counter));
 122
 123   char key[INSTR_DEFAULT_STR_SIZE];
 124   snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
 125   new_pajeStartLink(SIMIX_get_clock(), father, link_type, src, "topology", key);
 126   new_pajeEndLink(SIMIX_get_clock(), father, link_type, dst, "topology", key);
 127
 128   XBT_DEBUG ("  linkContainers %s <-> %s", src->name, dst->name);
 129 }
 130
 131 static void recursiveGraphExtraction (AS_t rc, container_t container, xbt_dict_t filter)
 132 {
 133   if (!TRACE_platform_topology()){
 134     XBT_DEBUG("Graph extraction disabled by user.");
 135     return;
 136   }
 137   XBT_DEBUG ("Graph extraction for routing_component = %s", surf_AS_get_name(rc));
 138   if (!xbt_dict_is_empty(surf_AS_get_routing_sons(rc))){
 139     xbt_dict_cursor_t cursor = NULL;
 140     AS_t rc_son;
 141     char *child_name;
 142     //bottom-up recursion
 143     xbt_dict_foreach(surf_AS_get_routing_sons(rc), cursor, child_name, rc_son) {
 144       container_t child_container = xbt_dict_get (container->children, surf_AS_get_name(rc_son));
 145       recursiveGraphExtraction (rc_son, child_container, filter);
 146     }
 147   }
 148
 149   {
 150     xbt_graph_t graph = xbt_graph_new_graph (0, NULL);
 151     xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
 152     xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
 153     xbt_edge_t edge = NULL;
 154
 155     xbt_dict_cursor_t cursor = NULL;
 156     char *edge_name;
 157
 158     surf_AS_get_graph(rc, graph, nodes, edges);
 159     xbt_dict_foreach(edges,cursor,edge_name,edge) {
 160         linkContainers(PJ_container_get(edge->src->data), PJ_container_get(edge->dst->data), filter);
 161     }
 162     xbt_dict_free (&nodes);
 163     xbt_dict_free (&edges);
 164     xbt_graph_free_graph(graph,xbt_free, xbt_free, NULL);
 165   }
 166 }
 167
 168 /*
 169  * Callbacks
 170  */
 171 static void instr_routing_parse_start_AS (sg_platf_AS_cbarg_t AS)
 172 {
 173   const char*id = AS->id;
 174
 175   if (PJ_container_get_root() == NULL){
 176     PJ_container_alloc ();
 177     PJ_type_alloc();
 178     container_t root = PJ_container_new (id, INSTR_AS, NULL);
 179     PJ_container_set_root (root);
 180
 181     if (TRACE_smpi_is_enabled()) {
 182       if (!TRACE_smpi_is_grouped()){
 183         type_t mpi = PJ_type_get_or_null ("MPI", root->type);
 184         if (mpi == NULL){
 185           mpi = PJ_type_container_new("MPI", root->type);
 186           PJ_type_state_new ("MPI_STATE", mpi);
 187           PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 188         }
 189       }
 190     }
 191
 192     if (TRACE_needs_platform()){
 193       currentContainer = xbt_dynar_new (sizeof(container_t), NULL);
 194       xbt_dynar_push (currentContainer, &root);
 195     }
 196     return;
 197   }
 198
 199   if (TRACE_needs_platform()){
 200     container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 201     container_t new = PJ_container_new (id, INSTR_AS, father);
 202     xbt_dynar_push (currentContainer, &new);
 203   }
 204 }
 205
 206 static void instr_routing_parse_end_AS ()
 207 {
 208   if (TRACE_needs_platform()){
 209     xbt_dynar_pop_ptr (currentContainer);
 210   }
 211 }
 212
 213 static void instr_routing_parse_start_link (sg_platf_link_cbarg_t link)
 214 {
 215   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 216
 217   double bandwidth_value = link->bandwidth;
 218   double latency_value = link->latency;
 219   xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
 220
 221   if (link->policy == SURF_LINK_FULLDUPLEX){
 222     char *up = bprintf("%s_UP", link->id);
 223     char *down = bprintf("%s_DOWN", link->id);
 224     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
 225     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
 226     free (up);
 227     free (down);
 228   }else{
 229     xbt_dynar_push_as (links_to_create, char*, strdup(link->id));
 230   }
 231
 232   char *link_name = NULL;
 233   unsigned int i;
 234   xbt_dynar_foreach (links_to_create, i, link_name){
 235
 236     container_t new = PJ_container_new (link_name, INSTR_LINK, father);
 237
 238     if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (! TRACE_disable_link())) {
 239       type_t bandwidth = PJ_type_get_or_null ("bandwidth", new->type);
 240       if (bandwidth == NULL){
 241         bandwidth = PJ_type_variable_new ("bandwidth", NULL, new->type);
 242       }
 243       type_t latency = PJ_type_get_or_null ("latency", new->type);
 244       if (latency == NULL){
 245         latency = PJ_type_variable_new ("latency", NULL, new->type);
 246       }
 247       new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
 248       new_pajeSetVariable (0, new, latency, latency_value);
 249     }
 250     if (TRACE_uncategorized()){
 251       type_t bandwidth_used = PJ_type_get_or_null ("bandwidth_used", new->type);
 252       if (bandwidth_used == NULL){
 253         bandwidth_used = PJ_type_variable_new ("bandwidth_used", "0.5 0.5 0.5", new->type);
 254       }
 255     }
 256   }
 257
 258   xbt_dynar_free (&links_to_create);
 259 }
 260
 261 static void instr_routing_parse_start_host (sg_platf_host_cbarg_t host)
 262 {
 263   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 264   container_t new = PJ_container_new (host->id, INSTR_HOST, father);
 265
 266   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (! TRACE_disable_power())) {
 267     type_t power = PJ_type_get_or_null ("power", new->type);
 268     if (power == NULL){
 269       power = PJ_type_variable_new ("power", NULL, new->type);
 270     }
 271     new_pajeSetVariable (0, new, power, host->power_peak);
 272   }
 273   if (TRACE_uncategorized()){
 274     type_t power_used = PJ_type_get_or_null ("power_used", new->type);
 275     if (power_used == NULL){
 276       power_used = PJ_type_variable_new ("power_used", "0.5 0.5 0.5", new->type);
 277     }
 278   }
 279
 280   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 281     type_t mpi = PJ_type_get_or_null ("MPI", new->type);
 282     if (mpi == NULL){
 283       mpi = PJ_type_container_new("MPI", new->type);
 284       PJ_type_state_new ("MPI_STATE", mpi);
 285       PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 286     }
 287   }
 288
 289   if (TRACE_msg_process_is_enabled()) {
 290     type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", new->type);
 291     if (msg_process == NULL){
 292       msg_process = PJ_type_container_new("MSG_PROCESS", new->type);
 293       type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
 294       PJ_value_new ("suspend", "1 0 1", state);
 295       PJ_value_new ("sleep", "1 1 0", state);
 296       PJ_value_new ("receive", "1 0 0", state);
 297       PJ_value_new ("send", "0 0 1", state);
 298       PJ_value_new ("task_execute", "0 1 1", state);
 299       PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
 300       PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
 301     }
 302   }
 303
 304   if (TRACE_msg_vm_is_enabled()) {
 305     type_t msg_vm = PJ_type_get_or_null ("MSG_VM", new->type);
 306     if (msg_vm == NULL){
 307       msg_vm = PJ_type_container_new("MSG_VM", new->type);
 308       type_t state = PJ_type_state_new ("MSG_VM_STATE", msg_vm);
 309       PJ_value_new ("suspend", "1 0 1", state);
 310       PJ_value_new ("sleep", "1 1 0", state);
 311       PJ_value_new ("receive", "1 0 0", state);
 312       PJ_value_new ("send", "0 0 1", state);
 313       PJ_value_new ("task_execute", "0 1 1", state);
 314       PJ_type_link_new ("MSG_VM_LINK", PJ_type_get_root(), msg_vm, msg_vm);
 315       PJ_type_link_new ("MSG_VM_PROCESS_LINK", PJ_type_get_root(), msg_vm, msg_vm);
 316     }
 317   }
 318
 319 }
 320
 321 static void instr_routing_parse_start_router (sg_platf_router_cbarg_t router)
 322 {
 323   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 324   PJ_container_new (router->id, INSTR_ROUTER, father);
 325 }
 326
 327 static void instr_routing_parse_end_platform ()
 328 {
 329   xbt_dynar_free(&currentContainer);
 330   currentContainer = NULL;
 331   xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free);
 332   XBT_DEBUG ("Starting graph extraction.");
 333   recursiveGraphExtraction (surf_platf_get_root(routing_platf), PJ_container_get_root(), filter);
 334   XBT_DEBUG ("Graph extraction finished.");
 335   xbt_dict_free(&filter);
 336   platform_created = 1;
 337   TRACE_paje_dump_buffer(1);
 338 }
 339
 340 void instr_routing_define_callbacks ()
 341 {
 342   if (!TRACE_is_enabled()) return;
 343   //always need the call backs to ASes (we need only the root AS),
 344   //to create the rootContainer and the rootType properly
 345   sg_platf_AS_begin_add_cb(instr_routing_parse_start_AS);
 346   sg_platf_AS_end_add_cb(instr_routing_parse_end_AS);
 347   if (!TRACE_needs_platform()) return;
 348   sg_platf_link_add_cb(instr_routing_parse_start_link);
 349   sg_platf_host_add_cb(instr_routing_parse_start_host);
 350   sg_platf_router_add_cb(instr_routing_parse_start_router);
 351
 352   sg_platf_postparse_add_cb(instr_routing_parse_end_platform);
 353 }
 354
 355 /*
 356  * user categories support
 357  */
 358 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
 359 {
 360   if (!strcmp (root->name, "HOST")){
 361     char tnstr[INSTR_DEFAULT_STR_SIZE];
 362     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 363     PJ_type_variable_new (tnstr, color, root);
 364   }
 365   if (!strcmp (root->name, "MSG_VM")){
 366     char tnstr[INSTR_DEFAULT_STR_SIZE];
 367     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 368     PJ_type_variable_new (tnstr, color, root);
 369   }
 370  if (!strcmp (root->name, "LINK")){
 371     char tnstr[INSTR_DEFAULT_STR_SIZE];
 372     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
 373     PJ_type_variable_new (tnstr, color, root);
 374   }
 375   xbt_dict_cursor_t cursor = NULL;
 376   type_t child_type;
 377   char *name;
 378   xbt_dict_foreach(root->children, cursor, name, child_type) {
 379     recursiveNewVariableType (new_typename, color, child_type);
 380   }
 381 }
 382
 383 void instr_new_variable_type (const char *new_typename, const char *color)
 384 {
 385   recursiveNewVariableType (new_typename, color, PJ_type_get_root());
 386 }
 387
 388 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
 389 {
 390   if (!strcmp (root->name, father_type)){
 391     PJ_type_variable_new (new_typename, color, root);
 392   }
 393   xbt_dict_cursor_t cursor = NULL;
 394   type_t child_type;
 395   char *name;
 396   xbt_dict_foreach(root->children, cursor, name, child_type) {
 397     recursiveNewUserVariableType (father_type, new_typename, color, child_type);
 398   }
 399 }
 400
 401 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 402 {
 403   recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
 404 }
 405
 406 static void recursiveNewUserStateType (const char *father_type, const char *new_typename, type_t root)
 407 {
 408   if (!strcmp (root->name, father_type)){
 409     PJ_type_state_new (new_typename, root);
 410   }
 411   xbt_dict_cursor_t cursor = NULL;
 412   type_t child_type;
 413   char *name;
 414   xbt_dict_foreach(root->children, cursor, name, child_type) {
 415     recursiveNewUserStateType (father_type, new_typename, child_type);
 416   }
 417 }
 418
 419 void instr_new_user_state_type (const char *father_type, const char *new_typename)
 420 {
 421   recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
 422 }
 423
 424 static void recursiveNewValueForUserStateType (const char *typename, const char *value, const char *color, type_t root)
 425 {
 426   if (!strcmp (root->name, typename)){
 427     PJ_value_new (value, color, root);
 428   }
 429   xbt_dict_cursor_t cursor = NULL;
 430   type_t child_type;
 431   char *name;
 432   xbt_dict_foreach(root->children, cursor, name, child_type) {
 433     recursiveNewValueForUserStateType (typename, value, color, child_type);
 434   }
 435 }
 436
 437 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color)
 438 {
 439   recursiveNewValueForUserStateType (typename, value, color, PJ_type_get_root());
 440 }
 441
 442 int instr_platform_traced ()
 443 {
 444   return platform_created;
 445 }
 446
 447 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 448
 449
 450 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
 451     AS_t rc, container_t container)
 452 {
 453   if (!xbt_dict_is_empty(surf_AS_get_routing_sons(rc))){
 454     xbt_dict_cursor_t cursor = NULL;
 455     AS_t rc_son;
 456     char *child_name;
 457     //bottom-up recursion
 458     xbt_dict_foreach(surf_AS_get_routing_sons(rc), cursor, child_name, rc_son) {
 459       container_t child_container = xbt_dict_get (container->children, surf_AS_get_name(rc_son));
 460       recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
 461     }
 462   }
 463
 464   surf_AS_get_graph(rc, graph, nodes, edges);
 465 }
 466
 467 xbt_graph_t instr_routing_platform_graph (void)
 468 {
 469   xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
 470   xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
 471   xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
 472   recursiveXBTGraphExtraction (ret, nodes, edges, surf_platf_get_root(routing_platf), PJ_container_get_root());
 473   xbt_dict_free (&nodes);
 474   xbt_dict_free (&edges);
 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", instr_node_name(node));
 501   }
 502   xbt_dynar_foreach(g->edges, cursor, edge) {
 503     const char *src_s = instr_node_name (edge->src);
 504     const char *dst_s = instr_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