src/instr/instr_config.c

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