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 #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 int graph_extraction_filter_out (container_t c1, container_t c2)
 132 {
 133   if (c1->kind == INSTR_LINK ||
 134       c1->kind == INSTR_SMPI ||
 135       c1->kind == INSTR_MSG_PROCESS ||
 136       c1->kind == INSTR_MSG_TASK ||
 137       (c2 && strcmp (c1->name, c2->name) == 0))
 138     return 1;
 139   else
 140     return 0;
 141 }
 142
 143 static void recursiveGraphExtraction (AS_t rc, container_t container, xbt_dict_t filter)
 144 {
 145   if (!TRACE_platform_topology()){
 146     XBT_DEBUG("Graph extraction disabled by user.");
 147     return;
 148   }
 149   XBT_DEBUG ("Graph extraction for routing_component = %s", rc->name);
 150   if (!xbt_dict_is_empty(rc->routing_sons)){
 151     xbt_dict_cursor_t cursor = NULL;
 152     AS_t rc_son;
 153     char *child_name;
 154     //bottom-up recursion
 155     xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
 156       container_t child_container = xbt_dict_get (container->children, rc_son->name);
 157       recursiveGraphExtraction (rc_son, child_container, filter);
 158     }
 159   }
 160
 161   {
 162     xbt_graph_t graph = xbt_graph_new_graph (0, NULL);
 163     xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
 164     xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
 165     xbt_edge_t edge = NULL;
 166
 167     xbt_dict_cursor_t cursor = NULL;
 168     char *edge_name;
 169
 170     rc->get_graph(graph,nodes,edges,rc);
 171     xbt_dict_foreach(edges,cursor,edge_name,edge) {
 172         linkContainers(PJ_container_get(edge->src->data), PJ_container_get(edge->dst->data), filter);
 173     }
 174     xbt_dict_free (&nodes);
 175     xbt_dict_free (&edges);
 176     xbt_graph_free_graph(graph,xbt_free, xbt_free, NULL);
 177   }
 178 }
 179
 180 /*
 181  * Callbacks
 182  */
 183 static void instr_routing_parse_start_AS (sg_platf_AS_cbarg_t AS)
 184 {
 185   const char*id = AS->id;
 186
 187   if (PJ_container_get_root() == NULL){
 188     PJ_container_alloc ();
 189     PJ_type_alloc();
 190     container_t root = PJ_container_new (id, INSTR_AS, NULL);
 191     PJ_container_set_root (root);
 192
 193     if (TRACE_smpi_is_enabled()) {
 194       if (!TRACE_smpi_is_grouped()){
 195         type_t mpi = PJ_type_get_or_null ("MPI", root->type);
 196         if (mpi == NULL){
 197           mpi = PJ_type_container_new("MPI", root->type);
 198           PJ_type_state_new ("MPI_STATE", mpi);
 199           PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 200         }
 201       }
 202     }
 203
 204     if (TRACE_needs_platform()){
 205       currentContainer = xbt_dynar_new (sizeof(container_t), NULL);
 206       xbt_dynar_push (currentContainer, &root);
 207     }
 208     return;
 209   }
 210
 211   if (TRACE_needs_platform()){
 212     container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 213     container_t new = PJ_container_new (id, INSTR_AS, father);
 214     xbt_dynar_push (currentContainer, &new);
 215   }
 216 }
 217
 218 static void instr_routing_parse_end_AS ()
 219 {
 220   if (TRACE_needs_platform()){
 221     xbt_dynar_pop_ptr (currentContainer);
 222   }
 223 }
 224
 225 static void instr_routing_parse_start_link (sg_platf_link_cbarg_t link)
 226 {
 227   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 228
 229   double bandwidth_value = link->bandwidth;
 230   double latency_value = link->latency;
 231   xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
 232
 233   if (link->policy == SURF_LINK_FULLDUPLEX){
 234     char *up = bprintf("%s_UP", link->id);
 235     char *down = bprintf("%s_DOWN", link->id);
 236     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
 237     xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
 238     free (up);
 239     free (down);
 240   }else{
 241     xbt_dynar_push_as (links_to_create, char*, strdup(link->id));
 242   }
 243
 244   char *link_name = NULL;
 245   unsigned int i;
 246   xbt_dynar_foreach (links_to_create, i, link_name){
 247
 248     container_t new = PJ_container_new (link_name, INSTR_LINK, father);
 249
 250     if (TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()){
 251       type_t bandwidth = PJ_type_get_or_null ("bandwidth", new->type);
 252       if (bandwidth == NULL){
 253         bandwidth = PJ_type_variable_new ("bandwidth", NULL, new->type);
 254       }
 255       type_t latency = PJ_type_get_or_null ("latency", new->type);
 256       if (latency == NULL){
 257         latency = PJ_type_variable_new ("latency", NULL, new->type);
 258       }
 259       new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
 260       new_pajeSetVariable (0, new, latency, latency_value);
 261     }
 262     if (TRACE_uncategorized()){
 263       type_t bandwidth_used = PJ_type_get_or_null ("bandwidth_used", new->type);
 264       if (bandwidth_used == NULL){
 265         bandwidth_used = PJ_type_variable_new ("bandwidth_used", "0.5 0.5 0.5", new->type);
 266       }
 267     }
 268   }
 269
 270   xbt_dynar_free (&links_to_create);
 271 }
 272
 273 static void instr_routing_parse_start_host (sg_platf_host_cbarg_t host)
 274 {
 275   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 276   container_t new = PJ_container_new (host->id, INSTR_HOST, father);
 277
 278   if (TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) {
 279     type_t power = PJ_type_get_or_null ("power", new->type);
 280     if (power == NULL){
 281       power = PJ_type_variable_new ("power", NULL, new->type);
 282     }
 283     new_pajeSetVariable (0, new, power, host->power_peak);
 284   }
 285   if (TRACE_uncategorized()){
 286     type_t power_used = PJ_type_get_or_null ("power_used", new->type);
 287     if (power_used == NULL){
 288       power_used = PJ_type_variable_new ("power_used", "0.5 0.5 0.5", new->type);
 289     }
 290   }
 291
 292   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 293     type_t mpi = PJ_type_get_or_null ("MPI", new->type);
 294     if (mpi == NULL){
 295       mpi = PJ_type_container_new("MPI", new->type);
 296       PJ_type_state_new ("MPI_STATE", mpi);
 297       PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 298     }
 299   }
 300
 301   if (TRACE_msg_process_is_enabled()) {
 302     type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", new->type);
 303     if (msg_process == NULL){
 304       msg_process = PJ_type_container_new("MSG_PROCESS", new->type);
 305       type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
 306       PJ_value_new ("suspend", "1 0 1", state);
 307       PJ_value_new ("sleep", "1 1 0", state);
 308       PJ_value_new ("receive", "1 0 0", state);
 309       PJ_value_new ("send", "0 0 1", state);
 310       PJ_value_new ("task_execute", "0 1 1", state);
 311       PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
 312       PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
 313     }
 314   }
 315
 316   if (TRACE_msg_vm_is_enabled()) {
 317     type_t msg_vm = PJ_type_get_or_null ("MSG_VM", new->type);
 318     if (msg_vm == NULL){
 319       msg_vm = PJ_type_container_new("MSG_VM", new->type);
 320       type_t state = PJ_type_state_new ("MSG_VM_STATE", msg_vm);
 321       PJ_value_new ("suspend", "1 0 1", state);
 322       PJ_value_new ("sleep", "1 1 0", state);
 323       PJ_value_new ("receive", "1 0 0", state);
 324       PJ_value_new ("send", "0 0 1", state);
 325       PJ_value_new ("task_execute", "0 1 1", state);
 326       PJ_type_link_new ("MSG_VM_LINK", PJ_type_get_root(), msg_vm, msg_vm);
 327       PJ_type_link_new ("MSG_VM_PROCESS_LINK", PJ_type_get_root(), msg_vm, msg_vm);
 328     }
 329   }
 330
 331 }
 332
 333 static void instr_routing_parse_start_router (sg_platf_router_cbarg_t router)
 334 {
 335   container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
 336   PJ_container_new (router->id, INSTR_ROUTER, father);
 337 }
 338
 339 static void instr_routing_parse_end_platform ()
 340 {
 341   xbt_dynar_free(&currentContainer);
 342   currentContainer = NULL;
 343   xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free);
 344   XBT_DEBUG ("Starting graph extraction.");
 345   recursiveGraphExtraction (routing_platf->root, PJ_container_get_root(), filter);
 346   XBT_DEBUG ("Graph extraction finished.");
 347   xbt_dict_free(&filter);
 348   platform_created = 1;
 349   TRACE_paje_dump_buffer(1);
 350 }
 351
 352 void instr_routing_define_callbacks ()
 353 {
 354   if (!TRACE_is_enabled()) return;
 355   //always need the call backs to ASes (we need only the root AS),
 356   //to create the rootContainer and the rootType properly
 357   sg_platf_AS_begin_add_cb(instr_routing_parse_start_AS);
 358   sg_platf_AS_end_add_cb(instr_routing_parse_end_AS);
 359   if (!TRACE_needs_platform()) return;
 360   sg_platf_link_add_cb(instr_routing_parse_start_link);
 361   sg_platf_host_add_cb(instr_routing_parse_start_host);
 362   sg_platf_router_add_cb(instr_routing_parse_start_router);
 363
 364   sg_platf_postparse_add_cb(instr_routing_parse_end_platform);
 365 }
 366
 367 /*
 368  * user categories support
 369  */
 370 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
 371 {
 372   if (!strcmp (root->name, "HOST")){
 373     char tnstr[INSTR_DEFAULT_STR_SIZE];
 374     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 375     PJ_type_variable_new (tnstr, color, root);
 376   }
 377   if (!strcmp (root->name, "MSG_VM")){
 378     char tnstr[INSTR_DEFAULT_STR_SIZE];
 379     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 380     PJ_type_variable_new (tnstr, color, root);
 381   }
 382  if (!strcmp (root->name, "LINK")){
 383     char tnstr[INSTR_DEFAULT_STR_SIZE];
 384     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
 385     PJ_type_variable_new (tnstr, color, root);
 386   }
 387   xbt_dict_cursor_t cursor = NULL;
 388   type_t child_type;
 389   char *name;
 390   xbt_dict_foreach(root->children, cursor, name, child_type) {
 391     recursiveNewVariableType (new_typename, color, child_type);
 392   }
 393 }
 394
 395 void instr_new_variable_type (const char *new_typename, const char *color)
 396 {
 397   recursiveNewVariableType (new_typename, color, PJ_type_get_root());
 398 }
 399
 400 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
 401 {
 402   if (!strcmp (root->name, father_type)){
 403     PJ_type_variable_new (new_typename, color, root);
 404   }
 405   xbt_dict_cursor_t cursor = NULL;
 406   type_t child_type;
 407   char *name;
 408   xbt_dict_foreach(root->children, cursor, name, child_type) {
 409     recursiveNewUserVariableType (father_type, new_typename, color, child_type);
 410   }
 411 }
 412
 413 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 414 {
 415   recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
 416 }
 417
 418 static void recursiveNewUserStateType (const char *father_type, const char *new_typename, type_t root)
 419 {
 420   if (!strcmp (root->name, father_type)){
 421     PJ_type_state_new (new_typename, root);
 422   }
 423   xbt_dict_cursor_t cursor = NULL;
 424   type_t child_type;
 425   char *name;
 426   xbt_dict_foreach(root->children, cursor, name, child_type) {
 427     recursiveNewUserStateType (father_type, new_typename, child_type);
 428   }
 429 }
 430
 431 void instr_new_user_state_type (const char *father_type, const char *new_typename)
 432 {
 433   recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
 434 }
 435
 436 static void recursiveNewValueForUserStateType (const char *typename, const char *value, const char *color, type_t root)
 437 {
 438   if (!strcmp (root->name, typename)){
 439     PJ_value_new (value, color, root);
 440   }
 441   xbt_dict_cursor_t cursor = NULL;
 442   type_t child_type;
 443   char *name;
 444   xbt_dict_foreach(root->children, cursor, name, child_type) {
 445     recursiveNewValueForUserStateType (typename, value, color, child_type);
 446   }
 447 }
 448
 449 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color)
 450 {
 451   recursiveNewValueForUserStateType (typename, value, color, PJ_type_get_root());
 452 }
 453
 454 int instr_platform_traced ()
 455 {
 456   return platform_created;
 457 }
 458
 459 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 460
 461
 462 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
 463     AS_t rc, container_t container)
 464 {
 465   if (!xbt_dict_is_empty(rc->routing_sons)){
 466     xbt_dict_cursor_t cursor = NULL;
 467     AS_t rc_son;
 468     char *child_name;
 469     //bottom-up recursion
 470     xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
 471       container_t child_container = xbt_dict_get (container->children, rc_son->name);
 472       recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
 473     }
 474   }
 475
 476   rc->get_graph(graph,nodes,edges,rc);
 477 }
 478
 479 xbt_graph_t instr_routing_platform_graph (void)
 480 {
 481   xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
 482   xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
 483   xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
 484   recursiveXBTGraphExtraction (ret, nodes, edges, routing_platf->root, PJ_container_get_root());
 485   xbt_dict_free (&nodes);
 486   xbt_dict_free (&edges);
 487   return ret;
 488 }
 489
 490 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 491 {
 492   unsigned int cursor = 0;
 493   xbt_node_t node = NULL;
 494   xbt_edge_t edge = NULL;
 495   FILE *file = NULL;
 496
 497   file = fopen(filename, "w");
 498   xbt_assert(file, "Failed to open %s \n", filename);
 499
 500   if (g->directed)
 501     fprintf(file, "digraph test {\n");
 502   else
 503     fprintf(file, "graph test {\n");
 504
 505   fprintf(file, "  graph [overlap=scale]\n");
 506
 507   fprintf(file, "  node [shape=box, style=filled]\n");
 508   fprintf(file,
 509           "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 510
 511   xbt_dynar_foreach(g->nodes, cursor, node) {
 512     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 513   }
 514   xbt_dynar_foreach(g->edges, cursor, edge) {
 515     const char *src_s = instr_node_name (edge->src);
 516     const char *dst_s = instr_node_name (edge->dst);
 517     if (g->directed)
 518       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 519     else
 520       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 521   }
 522   fprintf(file, "}\n");
 523   fclose(file);
 524
 525 }
 526
 527 #endif /* HAVE_TRACING */
 528