src/instr/instr_config.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 "simgrid/sg_config.h"
   9 #include "surf/surf.h"
  10
  11 #ifdef HAVE_TRACING
  12
  13 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
  15
  16 #define OPT_TRACING               "tracing"
  17 #define OPT_TRACING_PLATFORM      "tracing/platform"
  18 #define OPT_TRACING_TOPOLOGY      "tracing/platform/topology"
  19 #define OPT_TRACING_SMPI          "tracing/smpi"
  20 #define OPT_TRACING_SMPI_GROUP    "tracing/smpi/group"
  21 #define OPT_TRACING_SMPI_COMPUTING "tracing/smpi/computing"
  22 #define OPT_TRACING_CATEGORIZED   "tracing/categorized"
  23 #define OPT_TRACING_UNCATEGORIZED "tracing/uncategorized"
  24 #define OPT_TRACING_MSG_PROCESS   "tracing/msg/process"
  25 #define OPT_TRACING_MSG_VM        "tracing/msg/vm"
  26 #define OPT_TRACING_FILENAME      "tracing/filename"
  27 #define OPT_TRACING_BUFFER        "tracing/buffer"
  28 #define OPT_TRACING_ONELINK_ONLY  "tracing/onelink_only"
  29 #define OPT_TRACING_DISABLE_DESTROY "tracing/disable_destroy"
  30 #define OPT_TRACING_BASIC         "tracing/basic"
  31 #define OPT_TRACING_COMMENT       "tracing/comment"
  32 #define OPT_TRACING_COMMENT_FILE  "tracing/comment_file"
  33 #define OPT_VIVA_UNCAT_CONF      "viva/uncategorized"
  34 #define OPT_VIVA_CAT_CONF        "viva/categorized"
  35
  36 static int trace_enabled;
  37 static int trace_platform;
  38 static int trace_platform_topology;
  39 static int trace_smpi_enabled;
  40 static int trace_smpi_grouped;
  41 static int trace_smpi_computing;
  42 static int trace_categorized;
  43 static int trace_uncategorized;
  44 static int trace_msg_process_enabled;
  45 static int trace_msg_vm_enabled;
  46 static int trace_buffer;
  47 static int trace_onelink_only;
  48 static int trace_disable_destroy;
  49 static int trace_basic;
  50
  51 static int trace_configured = 0;
  52 static int trace_active = 0;
  53
  54
  55
  56 static void TRACE_getopts(void)
  57 {
  58   trace_enabled = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING);
  59   trace_platform = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_PLATFORM);
  60   trace_platform_topology = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_TOPOLOGY);
  61   trace_smpi_enabled = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_SMPI);
  62   trace_smpi_grouped = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_SMPI_GROUP);
  63   trace_smpi_computing = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_SMPI_COMPUTING);
  64   trace_categorized = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_CATEGORIZED);
  65   trace_uncategorized = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_UNCATEGORIZED);
  66   trace_msg_process_enabled = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_MSG_PROCESS);
  67   trace_msg_vm_enabled = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_MSG_VM);
  68   trace_buffer = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_BUFFER);
  69   trace_onelink_only = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_ONELINK_ONLY);
  70   trace_disable_destroy = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_DISABLE_DESTROY);
  71   trace_basic = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_BASIC);
  72 }
  73
  74 xbt_dynar_t TRACE_start_functions = NULL;
  75 void TRACE_add_start_function(void (*func) ())
  76 {
  77   if (TRACE_start_functions == NULL)
  78     TRACE_start_functions = xbt_dynar_new(sizeof(void (*)()), NULL);
  79   xbt_dynar_push(TRACE_start_functions, &func);
  80 }
  81
  82 int TRACE_start()
  83 {
  84   TRACE_getopts();
  85
  86   // tracing system must be:
  87   //    - enabled (with --cfg=tracing:1)
  88   //    - already configured (TRACE_global_init already called)
  89   if (TRACE_is_enabled() && TRACE_is_configured()) {
  90     XBT_DEBUG("Tracing starts");
  91
  92     /* open the trace file */
  93     TRACE_paje_start();
  94
  95     /* activate trace */
  96     if (trace_active == 1) {
  97       THROWF(tracing_error, 0, "Tracing is already active");
  98     }
  99     trace_active = 1;
 100     XBT_DEBUG("Tracing is on");
 101
 102     /* other trace initialization */
 103     created_categories = xbt_dict_new_homogeneous(xbt_free);
 104     declared_marks = xbt_dict_new_homogeneous(xbt_free);
 105     user_host_variables = xbt_dict_new_homogeneous(xbt_free);
 106     user_vm_variables = xbt_dict_new_homogeneous (xbt_free);
 107     user_link_variables = xbt_dict_new_homogeneous(xbt_free);
 108
 109     if (TRACE_start_functions != NULL) {
 110       void (*func) ();
 111       unsigned int iter = xbt_dynar_length(TRACE_start_functions);
 112       xbt_dynar_foreach(TRACE_start_functions, iter, func) {
 113         func();
 114       }
 115     }
 116   }
 117   xbt_dynar_free(&TRACE_start_functions);
 118   return 0;
 119 }
 120
 121 xbt_dynar_t TRACE_end_functions = NULL;
 122 void TRACE_add_end_function(void (*func) (void))
 123 {
 124   if (TRACE_end_functions == NULL)
 125     TRACE_end_functions = xbt_dynar_new(sizeof(void (*)(void)), NULL);
 126   xbt_dynar_push(TRACE_end_functions, &func);
 127 }
 128
 129 int TRACE_end()
 130 {
 131   int retval;
 132   if (!trace_active) {
 133     retval = 1;
 134   } else {
 135     retval = 0;
 136
 137     TRACE_generate_viva_uncat_conf();
 138     TRACE_generate_viva_cat_conf();
 139
 140     /* dump trace buffer */
 141     TRACE_last_timestamp_to_dump = surf_get_clock();
 142     TRACE_paje_dump_buffer(1);
 143
 144     /* destroy all data structures of tracing (and free) */
 145     PJ_container_free_all();
 146     PJ_type_free_all();
 147     PJ_container_release();
 148     PJ_type_release();
 149
 150     if (TRACE_end_functions != NULL) {
 151       void (*func) (void);
 152       unsigned int iter;
 153       xbt_dynar_foreach(TRACE_end_functions, iter, func) {
 154         func();
 155       }
 156     }
 157
 158     xbt_dict_free(&user_link_variables);
 159     xbt_dict_free(&user_host_variables);
 160     xbt_dict_free(&user_vm_variables);
 161     xbt_dict_free(&declared_marks);
 162     xbt_dict_free(&created_categories);
 163
 164     /* close the trace file */
 165     TRACE_paje_end();
 166
 167     /* de-activate trace */
 168     trace_active = 0;
 169     XBT_DEBUG("Tracing is off");
 170     XBT_DEBUG("Tracing system is shutdown");
 171   }
 172   xbt_dynar_free(&TRACE_end_functions);
 173   return retval;
 174 }
 175
 176 int TRACE_needs_platform (void)
 177 {
 178   return TRACE_msg_process_is_enabled() ||
 179          TRACE_msg_vm_is_enabled() ||
 180          TRACE_categorized() ||
 181          TRACE_uncategorized() ||
 182          TRACE_platform () ||
 183          (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
 184 }
 185
 186 int TRACE_is_enabled(void)
 187 {
 188   return trace_enabled;
 189 }
 190
 191 int TRACE_platform(void)
 192 {
 193   return trace_platform;
 194 }
 195
 196 int TRACE_platform_topology(void)
 197 {
 198   return trace_platform_topology;
 199 }
 200
 201 int TRACE_is_configured(void)
 202 {
 203   return trace_configured;
 204 }
 205
 206 int TRACE_smpi_is_enabled(void)
 207 {
 208   return (trace_smpi_enabled || TRACE_smpi_is_grouped())
 209     && TRACE_is_enabled();
 210 }
 211
 212 int TRACE_smpi_is_grouped(void)
 213 {
 214   return trace_smpi_grouped;
 215 }
 216
 217 int TRACE_smpi_is_computing(void)
 218 {
 219   return trace_smpi_computing;
 220 }
 221
 222
 223 int TRACE_categorized (void)
 224 {
 225   return trace_categorized;
 226 }
 227
 228 int TRACE_uncategorized (void)
 229 {
 230   return trace_uncategorized;
 231 }
 232
 233 int TRACE_msg_process_is_enabled(void)
 234 {
 235   return trace_msg_process_enabled && TRACE_is_enabled();
 236 }
 237
 238 int TRACE_msg_vm_is_enabled(void)
 239 {
 240   return trace_msg_vm_enabled && TRACE_is_enabled();
 241 }
 242
 243
 244 int TRACE_buffer (void)
 245 {
 246   return trace_buffer && TRACE_is_enabled();
 247 }
 248
 249 int TRACE_onelink_only (void)
 250 {
 251   return trace_onelink_only && TRACE_is_enabled();
 252 }
 253
 254 int TRACE_disable_destroy (void)
 255 {
 256   return trace_disable_destroy && TRACE_is_enabled();
 257 }
 258
 259 int TRACE_basic (void)
 260 {
 261   return trace_basic && TRACE_is_enabled();
 262 }
 263
 264 char *TRACE_get_comment (void)
 265 {
 266   return xbt_cfg_get_string(_sg_cfg_set, OPT_TRACING_COMMENT);
 267 }
 268
 269 char *TRACE_get_comment_file (void)
 270 {
 271   return xbt_cfg_get_string(_sg_cfg_set, OPT_TRACING_COMMENT_FILE);
 272 }
 273
 274 char *TRACE_get_filename(void)
 275 {
 276   return xbt_cfg_get_string(_sg_cfg_set, OPT_TRACING_FILENAME);
 277 }
 278
 279 char *TRACE_get_viva_uncat_conf (void)
 280 {
 281   return xbt_cfg_get_string(_sg_cfg_set, OPT_VIVA_UNCAT_CONF);
 282 }
 283
 284 char *TRACE_get_viva_cat_conf (void)
 285 {
 286   return xbt_cfg_get_string(_sg_cfg_set, OPT_VIVA_CAT_CONF);
 287 }
 288
 289 void TRACE_global_init(int *argc, char **argv)
 290 {
 291   /* name of the tracefile */
 292   char *default_tracing_filename = xbt_strdup("simgrid.trace");
 293   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_FILENAME,
 294                    "Trace file created by the instrumented SimGrid.",
 295                    xbt_cfgelm_string, &default_tracing_filename, 1, 1,
 296                    NULL, NULL);
 297
 298   /* tracing */
 299   int default_tracing = 0;
 300   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING,
 301                    "Enable Tracing.",
 302                    xbt_cfgelm_int, &default_tracing, 0, 1,
 303                    NULL, NULL);
 304
 305   /* register platform in the trace */
 306   int default_tracing_platform = 0;
 307   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_PLATFORM,
 308                    "Register the platform in the trace as a hierarchy.",
 309                    xbt_cfgelm_int, &default_tracing_platform, 0, 1,
 310                    NULL, NULL);
 311
 312   /* register platform in the trace */
 313   int default_tracing_platform_topology = 1;
 314   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_TOPOLOGY,
 315                    "Register the platform topology in the trace as a graph.",
 316                    xbt_cfgelm_int, &default_tracing_platform_topology, 0, 1,
 317                    NULL, NULL);
 318
 319   /* smpi */
 320   int default_tracing_smpi = 0;
 321   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_SMPI,
 322                    "Tracing of the SMPI interface.",
 323                    xbt_cfgelm_int, &default_tracing_smpi, 0, 1,
 324                    NULL, NULL);
 325
 326   /* smpi grouped */
 327   int default_tracing_smpi_grouped = 0;
 328   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_SMPI_GROUP,
 329                    "Group MPI processes by host.",
 330                    xbt_cfgelm_int, &default_tracing_smpi_grouped, 0, 1,
 331                    NULL, NULL);
 332
 333   /* smpi computing */
 334   int default_tracing_smpi_computing = 0;
 335   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_SMPI_COMPUTING,
 336                    "Generate states for timing out of SMPI parts of the application",
 337                    xbt_cfgelm_int, &default_tracing_smpi_computing, 0, 1,
 338                    NULL, NULL);
 339
 340   /* tracing categorized resource utilization traces */
 341   int default_tracing_categorized = 0;
 342   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_CATEGORIZED,
 343                    "Tracing categorized resource utilization of hosts and links.",
 344                    xbt_cfgelm_int, &default_tracing_categorized, 0, 1,
 345                    NULL, NULL);
 346
 347   /* tracing uncategorized resource utilization */
 348   int default_tracing_uncategorized = 0;
 349   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_UNCATEGORIZED,
 350                    "Tracing uncategorized resource utilization of hosts and links.",
 351                    xbt_cfgelm_int, &default_tracing_uncategorized, 0, 1,
 352                    NULL, NULL);
 353
 354   /* msg process */
 355   int default_tracing_msg_process = 0;
 356   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_MSG_PROCESS,
 357                    "Tracing of MSG process behavior.",
 358                    xbt_cfgelm_int, &default_tracing_msg_process, 0, 1,
 359                    NULL, NULL);
 360
 361   /* msg process */
 362   int default_tracing_msg_vm = 0;
 363   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_MSG_VM,
 364                    "Tracing of MSG process behavior.",
 365                    xbt_cfgelm_int, &default_tracing_msg_vm, 0, 1,
 366                    NULL, NULL);
 367
 368   /* tracing buffer */
 369   int default_buffer = 1;
 370   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_BUFFER,
 371                    "Buffer trace events to put them in temporal order.",
 372                    xbt_cfgelm_int, &default_buffer, 0, 1,
 373                    NULL, NULL);
 374
 375   /* tracing one link only */
 376   int default_onelink_only = 0;
 377   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_ONELINK_ONLY,
 378                    "Use only routes with one link to trace platform.",
 379                    xbt_cfgelm_int, &default_onelink_only, 0, 1,
 380                    NULL, NULL);
 381
 382   /* disable destroy */
 383   int default_disable_destroy = 0;
 384   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_DISABLE_DESTROY,
 385                    "Disable platform containers destruction.",
 386                    xbt_cfgelm_int, &default_disable_destroy, 0, 1,
 387                    NULL, NULL);
 388
 389   /* basic -- Avoid extended events (impoverished trace file) */
 390   int default_basic = 0;
 391   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_BASIC,
 392                    "Avoid extended events (impoverished trace file).",
 393                    xbt_cfgelm_int, &default_basic, 0, 1,
 394                    NULL, NULL);
 395
 396   /* comment */
 397   char *default_tracing_comment = xbt_strdup ("");
 398   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_COMMENT,
 399                    "Comment to be added on the top of the trace file.",
 400                    xbt_cfgelm_string, &default_tracing_comment, 1, 1,
 401                    NULL, NULL);
 402
 403   /* comment_file */
 404   char *default_tracing_comment_file = xbt_strdup ("");
 405   xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_COMMENT_FILE,
 406                    "The contents of the file are added to the top of the trace file as comment.",
 407                    xbt_cfgelm_string, &default_tracing_comment_file, 1, 1,
 408                    NULL, NULL);
 409
 410   /* Viva graph configuration for uncategorized tracing */
 411   char *default_viva_uncat_conf_file = xbt_strdup ("");
 412   xbt_cfg_register(&_sg_cfg_set, OPT_VIVA_UNCAT_CONF,
 413                    "Viva Graph configuration file for uncategorized resource utilization traces.",
 414                    xbt_cfgelm_string, &default_viva_uncat_conf_file, 1, 1,
 415                    NULL, NULL);
 416
 417   /* Viva graph configuration for uncategorized tracing */
 418   char *default_viva_cat_conf_file = xbt_strdup ("");
 419   xbt_cfg_register(&_sg_cfg_set, OPT_VIVA_CAT_CONF,
 420                    "Viva Graph configuration file for categorized resource utilization traces.",
 421                    xbt_cfgelm_string, &default_viva_cat_conf_file, 1, 1,
 422                    NULL, NULL);
 423
 424   /* instrumentation can be considered configured now */
 425   trace_configured = 1;
 426 }
 427
 428 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
 429 {
 430   char str[INSTR_DEFAULT_STR_SIZE];
 431   snprintf (str, INSTR_DEFAULT_STR_SIZE, "--cfg=%s ", option);
 432
 433   int len = strlen (str);
 434   printf ("%s%*.*s %s\n", str, 30-len, 30-len, "", desc);
 435   if (!!longdesc && detailed){
 436     printf ("%s\n\n", longdesc);
 437   }
 438 }
 439
 440 void TRACE_help (int detailed)
 441 {
 442   printf(
 443       "Description of the tracing options accepted by this simulator:\n\n");
 444   print_line (OPT_TRACING, "Enable the tracing system",
 445       "  It activates the tracing system and register the simulation platform\n"
 446       "  in the trace file. You have to enable this option to others take effect.",
 447       detailed);
 448   print_line (OPT_TRACING_CATEGORIZED, "Trace categorized resource utilization",
 449       "  It activates the categorized resource utilization tracing. It should\n"
 450       "  be enabled if tracing categories are used by this simulator.",
 451       detailed);
 452   print_line (OPT_TRACING_UNCATEGORIZED, "Trace uncategorized resource utilization",
 453       "  It activates the uncategorized resource utilization tracing. Use it if\n"
 454       "  this simulator do not use tracing categories and resource use have to be\n"
 455       "  traced.",
 456       detailed);
 457   print_line (OPT_TRACING_FILENAME, "Filename to register traces",
 458       "  A file with this name will be created to register the simulation. The file\n"
 459       "  is in the Paje format and can be analyzed using Viva, Paje, and PajeNG visualization\n"
 460       "  tools. More information can be found in these webpages:\n"
 461       "     http://github.com/schnorr/viva/\n"
 462       "     http://github.com/schnorr/pajeng/\n"
 463       "     http://paje.sourceforge.net/",
 464       detailed);
 465   print_line (OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
 466       "  This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
 467       "  interface and generates a trace that can be analyzed using Gantt-like\n"
 468       "  visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
 469       "  state, and point-to-point communications can be analyzed with arrows.",
 470       detailed);
 471   print_line (OPT_TRACING_SMPI_GROUP, "Group MPI processes by host (SMPI)",
 472       "  This option only has effect if this simulator is SMPI-based. The processes\n"
 473       "  are grouped by the hosts where they were executed.",
 474       detailed);
 475   print_line (OPT_TRACING_SMPI_COMPUTING, "Generates a \" Computing \" State",
 476       "  This option aims at tracing computations in the application, outside SMPI\n"
 477       "  to allow further study of simulated or real computation time",
 478       detailed);
 479   print_line (OPT_TRACING_MSG_PROCESS, "Trace processes behavior (MSG)",
 480       "  This option only has effect if this simulator is MSG-based. It traces the\n"
 481       "  behavior of all categorized MSG processes, grouping them by hosts. This option\n"
 482       "  can be used to track process location if this simulator has process migration.",
 483       detailed);
 484   print_line (OPT_TRACING_BUFFER, "Buffer events to put them in temporal order",
 485       "  This option put some events in a time-ordered buffer using the insertion\n"
 486       "  sort algorithm. The process of acquiring and releasing locks to access this\n"
 487       "  buffer and the cost of the sorting algorithm make this process slow. The\n"
 488       "  simulator performance can be severely impacted if this option is activated,\n"
 489       "  but you are sure to get a trace file with events sorted.",
 490       detailed);
 491   print_line (OPT_TRACING_ONELINK_ONLY, "Consider only one link routes to trace platform",
 492       "  This option changes the way SimGrid register its platform on the trace file.\n"
 493       "  Normally, the tracing considers all routes (no matter their size) on the\n"
 494       "  platform file to re-create the resource topology. If this option is activated,\n"
 495       "  only the routes with one link are used to register the topology within an AS.\n"
 496       "  Routes among AS continue to be traced as usual.",
 497       detailed);
 498   print_line (OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
 499       "  Disable the destruction of containers at the end of simulation. This can be\n"
 500       "  used with simulators that have a different notion of time (different from\n"
 501       "  the simulated time).",
 502       detailed);
 503   print_line (OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
 504       "  Some visualization tools are not able to parse correctly the Paje file format.\n"
 505       "  Use this option if you are using one of these tools to visualize the simulation\n"
 506       "  trace. Keep in mind that the trace might be incomplete, without all the\n"
 507       "  information that would be registered otherwise.",
 508       detailed);
 509   print_line (OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
 510       "  Use this to add a comment line to the top of the trace file.",
 511       detailed);
 512   print_line (OPT_TRACING_COMMENT_FILE, "File contents added to trace file as comment.",
 513       "  Use this to add the contents of a file to the top of the trace file as comment.",
 514       detailed);
 515   print_line (OPT_VIVA_UNCAT_CONF, "Generate a graph configuration for Viva",
 516       "  This option can be used in all types of simulators build with SimGrid\n"
 517       "  to generate a uncategorized resource utilization graph to be used as\n"
 518       "  configuration for the Viva visualization tool. This option\n"
 519       "  can be used with tracing/categorized:1 and tracing:1 options to\n"
 520       "  analyze an unmodified simulator before changing it to contain\n"
 521       "  categories.",
 522       detailed);
 523   print_line (OPT_VIVA_CAT_CONF, "Generate an uncategorized graph configuration for Viva",
 524       "  This option can be used if this simulator uses tracing categories\n"
 525       "  in its code. The file specified by this option holds a graph configuration\n"
 526       "  file for the Viva visualization tool that can be used to analyze a categorized\n"
 527       "  resource utilization.",
 528       detailed);
 529   print_line (OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
 530         "  This option (enabled by default) can be used to disable the tracing of\n"
 531         "  the platform topology in the trace file. Sometimes, such task is really\n"
 532         "  time consuming, since it must get the route from each host ot other hosts\n"
 533         "  within the same Autonomous System (AS).",
 534         detailed);
 535 }
 536
 537 static void output_types (const char *name, xbt_dynar_t types, FILE *file)
 538 {
 539   unsigned int i;
 540   fprintf (file, "  %s = (", name);
 541   for (i = xbt_dynar_length(types); i > 0; i--) {
 542     char *type = *(char**)xbt_dynar_get_ptr(types, i - 1);
 543     fprintf (file, "\"%s\"", type);
 544     if (i - 1 > 0){
 545       fprintf (file, ",");
 546     }else{
 547       fprintf (file, ");\n");
 548     }
 549   }
 550   xbt_dynar_free (&types);
 551 }
 552
 553 static void output_categories (const char *name, xbt_dynar_t cats, FILE *file)
 554 {
 555   unsigned int i;
 556   fprintf (file, "    values = (");
 557   for (i = xbt_dynar_length(cats); i > 0; i--) {
 558     char *cat = *(char**)xbt_dynar_get_ptr(cats, i - 1);
 559     fprintf (file, "\"%s%s\"", name, cat);
 560     if (i - 1 > 0){
 561       fprintf (file, ",");
 562     }else{
 563       fprintf (file, ");\n");
 564     }
 565   }
 566   xbt_dynar_free (&cats);
 567 }
 568
 569 static void uncat_configuration (FILE *file)
 570 {
 571   //register NODE and EDGE types
 572   output_types ("node", TRACE_get_node_types(), file);
 573   output_types ("edge", TRACE_get_edge_types(), file);
 574   fprintf (file, "\n");
 575
 576   //configuration for all nodes
 577   fprintf (file,
 578       "  host = {\n"
 579       "    type = \"square\";\n"
 580       "    size = \"power\";\n"
 581       "    values = (\"power_used\");\n"
 582       "  };\n"
 583       "  link = {\n"
 584       "    type = \"rhombus\";\n"
 585       "    size = \"bandwidth\";\n"
 586       "    values = (\"bandwidth_used\");\n"
 587       "  };\n");
 588   //close
 589 }
 590
 591 static void cat_configuration (FILE *file)
 592 {
 593   //register NODE and EDGE types
 594   output_types ("node", TRACE_get_node_types(), file);
 595   output_types ("edge", TRACE_get_edge_types(), file);
 596   fprintf (file, "\n");
 597
 598   //configuration for all nodes
 599   fprintf (file,
 600            "  host = {\n"
 601            "    type = \"square\";\n"
 602            "    size = \"power\";\n");
 603   output_categories ("p", TRACE_get_categories(), file);
 604   fprintf (file,
 605            "  };\n"
 606            "  link = {\n"
 607            "    type = \"rhombus\";\n"
 608            "    size = \"bandwidth\";\n");
 609   output_categories ("b", TRACE_get_categories(), file);
 610   fprintf (file, "  };\n");
 611   //close
 612 }
 613
 614 static void generate_uncat_configuration (const char *output, const char *name, int brackets)
 615 {
 616   if (output && strlen(output) > 0){
 617     FILE *file = fopen (output, "w");
 618     if (file == NULL){
 619       THROWF (system_error, 1, "Unable to open file (%s) for writing %s graph "
 620           "configuration (uncategorized).", output, name);
 621     }
 622
 623     if (brackets) fprintf (file, "{\n");
 624     uncat_configuration (file);
 625     if (brackets) fprintf (file, "}\n");
 626     fclose (file);
 627   }
 628 }
 629
 630 static void generate_cat_configuration (const char *output, const char *name, int brackets)
 631 {
 632   if (output && strlen(output) > 0){
 633     //check if we do have categories declared
 634     if (xbt_dict_is_empty(created_categories)){
 635       XBT_INFO("No categories declared, ignoring generation of %s graph configuration", name);
 636       return;
 637     }
 638
 639     FILE *file = fopen (output, "w");
 640     if (file == NULL){
 641       THROWF (system_error, 1, "Unable to open file (%s) for writing %s graph "
 642           "configuration (categorized).", output, name);
 643     }
 644
 645     if (brackets) fprintf (file, "{\n");
 646     cat_configuration (file);
 647     if (brackets) fprintf (file, "}\n");
 648     fclose (file);
 649   }
 650 }
 651
 652 void TRACE_generate_viva_uncat_conf (void)
 653 {
 654   generate_uncat_configuration (TRACE_get_viva_uncat_conf (), "viva", 0);
 655 }
 656
 657 void TRACE_generate_viva_cat_conf (void)
 658 {
 659   generate_cat_configuration (TRACE_get_viva_cat_conf(), "viva", 0);
 660 }
 661
 662 static int previous_trace_state = -1;
 663
 664 void instr_pause_tracing (void)
 665 {
 666   previous_trace_state = trace_enabled;
 667   if (!TRACE_is_enabled()){
 668     XBT_DEBUG ("Tracing is already paused, therefore do nothing.");
 669   }else{
 670     XBT_DEBUG ("Tracing is being paused.");
 671   }
 672   trace_enabled = 0;
 673   XBT_DEBUG ("Tracing is paused.");
 674 }
 675
 676 void instr_resume_tracing (void)
 677 {
 678   if (TRACE_is_enabled()){
 679     XBT_DEBUG ("Tracing is already running while trying to resume, therefore do nothing.");
 680   }else{
 681     XBT_DEBUG ("Tracing is being resumed.");
 682   }
 683
 684   if (previous_trace_state != -1){
 685     trace_enabled = previous_trace_state;
 686   }else{
 687     trace_enabled = 1;
 688   }
 689   XBT_DEBUG ("Tracing is resumed.");
 690   previous_trace_state = -1;
 691 }
 692
 693 #undef OPT_TRACING
 694 #undef OPT_TRACING_PLATFORM
 695 #undef OPT_TRACING_TOPOLOGY
 696 #undef OPT_TRACING_SMPI
 697 #undef OPT_TRACING_SMPI_GROUP
 698 #undef OPT_TRACING_CATEGORIZED
 699 #undef OPT_TRACING_UNCATEGORIZED
 700 #undef OPT_TRACING_MSG_PROCESS
 701 #undef OPT_TRACING_FILENAME
 702 #undef OPT_TRACING_BUFFER
 703 #undef OPT_TRACING_ONELINK_ONLY
 704 #undef OPT_TRACING_DISABLE_DESTROY
 705 #undef OPT_TRACING_BASIC
 706 #undef OPT_TRACING_COMMENT
 707 #undef OPT_TRACING_COMMENT_FILE
 708 #undef OPT_VIVA_UNCAT_CONF
 709 #undef OPT_VIVA_CAT_CONF
 710
 711 #endif /* HAVE_TRACING */