src/instr/instr_config.cpp

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