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
   8 #include "instr/instr_private.h"
   9
  10 #ifdef HAVE_TRACING
  11
  12 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
  14
  15 #define OPT_TRACING               "tracing"
  16 #define OPT_TRACING_PLATFORM      "tracing/platform"
  17 #define OPT_TRACING_SMPI          "tracing/smpi"
  18 #define OPT_TRACING_SMPI_GROUP    "tracing/smpi/group"
  19 #define OPT_TRACING_CATEGORIZED   "tracing/categorized"
  20 #define OPT_TRACING_UNCATEGORIZED "tracing/uncategorized"
  21 #define OPT_TRACING_MSG_PROCESS   "tracing/msg/process"
  22 #define OPT_TRACING_FILENAME      "tracing/filename"
  23 #define OPT_TRACING_BUFFER        "tracing/buffer"
  24 #define OPT_TRACING_ONELINK_ONLY  "tracing/onelink_only"
  25 #define OPT_TRACING_DISABLE_DESTROY "tracing/disable_destroy"
  26 #define OPT_TRIVA_UNCAT_CONF      "triva/uncategorized"
  27 #define OPT_TRIVA_CAT_CONF        "triva/categorized"
  28
  29 static int trace_enabled;
  30 static int trace_platform;
  31 static int trace_smpi_enabled;
  32 static int trace_smpi_grouped;
  33 static int trace_categorized;
  34 static int trace_uncategorized;
  35 static int trace_msg_process_enabled;
  36 static int trace_buffer;
  37 static int trace_onelink_only;
  38 static int trace_disable_destroy;
  39
  40 static int trace_configured = 0;
  41 static int trace_active = 0;
  42
  43 static void TRACE_getopts(void)
  44 {
  45   trace_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING);
  46   trace_platform = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_PLATFORM);
  47   trace_smpi_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI);
  48   trace_smpi_grouped = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI_GROUP);
  49   trace_categorized = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_CATEGORIZED);
  50   trace_uncategorized = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_UNCATEGORIZED);
  51   trace_msg_process_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_PROCESS);
  52   trace_buffer = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_BUFFER);
  53   trace_onelink_only = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_ONELINK_ONLY);
  54   trace_disable_destroy = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_DISABLE_DESTROY);
  55 }
  56
  57 int TRACE_start()
  58 {
  59   TRACE_getopts();
  60
  61   // tracing system must be:
  62   //    - enabled (with --cfg=tracing:1)
  63   //    - already configured (TRACE_global_init already called)
  64   if (!(TRACE_is_enabled() && TRACE_is_configured())){
  65     return 0;
  66   }
  67
  68   XBT_DEBUG("Tracing starts");
  69
  70   /* open the trace file */
  71   TRACE_paje_start();
  72
  73   /* activate trace */
  74   if (trace_active == 1){
  75     THROWF (tracing_error, 0, "Tracing is already active");
  76   }
  77   trace_active = 1;
  78   XBT_DEBUG ("Tracing is on");
  79
  80   /* other trace initialization */
  81   created_categories = xbt_dict_new_homogeneous(xbt_free);
  82   declared_marks = xbt_dict_new_homogeneous (xbt_free);
  83   TRACE_surf_alloc();
  84   TRACE_smpi_alloc();
  85   return 0;
  86 }
  87
  88 int TRACE_end()
  89 {
  90   if (!trace_active)
  91     return 1;
  92
  93   /* generate uncategorized graph configuration for triva */
  94   if (TRACE_get_triva_uncat_conf()){
  95     TRACE_generate_triva_uncat_conf();
  96   }
  97
  98   /* generate categorized graph configuration for triva */
  99   if (TRACE_get_triva_cat_conf()){
 100     TRACE_generate_triva_cat_conf();
 101   }
 102
 103   /* dump trace buffer */
 104   TRACE_last_timestamp_to_dump = surf_get_clock();
 105   TRACE_paje_dump_buffer(1);
 106
 107   /* destroy all data structures of tracing (and free) */
 108   PJ_container_free_all();
 109   PJ_type_free_all();
 110   PJ_container_release();
 111   PJ_type_release();
 112   TRACE_surf_release();
 113   TRACE_smpi_release();
 114   xbt_dict_free(&created_categories);
 115
 116   /* close the trace file */
 117   TRACE_paje_end();
 118
 119   /* de-activate trace */
 120   trace_active = 0;
 121   XBT_DEBUG ("Tracing is off");
 122   XBT_DEBUG("Tracing system is shutdown");
 123   return 0;
 124 }
 125
 126 int TRACE_needs_platform (void)
 127 {
 128   return TRACE_msg_process_is_enabled() ||
 129          TRACE_categorized() ||
 130          TRACE_uncategorized() ||
 131          TRACE_platform () ||
 132          (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
 133 }
 134
 135 int TRACE_is_enabled(void)
 136 {
 137   return trace_enabled;
 138 }
 139
 140 int TRACE_platform(void)
 141 {
 142   return trace_platform;
 143 }
 144
 145 int TRACE_is_configured(void)
 146 {
 147   return trace_configured;
 148 }
 149
 150 int TRACE_smpi_is_enabled(void)
 151 {
 152   return (trace_smpi_enabled || TRACE_smpi_is_grouped())
 153     && TRACE_is_enabled();
 154 }
 155
 156 int TRACE_smpi_is_grouped(void)
 157 {
 158   return trace_smpi_grouped;
 159 }
 160
 161 int TRACE_categorized (void)
 162 {
 163   return trace_categorized;
 164 }
 165
 166 int TRACE_uncategorized (void)
 167 {
 168   return trace_uncategorized;
 169 }
 170
 171 int TRACE_msg_process_is_enabled(void)
 172 {
 173   return trace_msg_process_enabled && TRACE_is_enabled();
 174 }
 175
 176 int TRACE_buffer (void)
 177 {
 178   return trace_buffer && TRACE_is_enabled();
 179 }
 180
 181 int TRACE_onelink_only (void)
 182 {
 183   return trace_onelink_only && TRACE_is_enabled();
 184 }
 185
 186 int TRACE_disable_destroy (void)
 187 {
 188   return trace_disable_destroy && TRACE_is_enabled();
 189 }
 190
 191 char *TRACE_get_filename(void)
 192 {
 193   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_FILENAME);
 194 }
 195
 196 char *TRACE_get_triva_uncat_conf (void)
 197 {
 198   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRIVA_UNCAT_CONF);
 199 }
 200
 201 char *TRACE_get_triva_cat_conf (void)
 202 {
 203   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRIVA_CAT_CONF);
 204 }
 205
 206 void TRACE_global_init(int *argc, char **argv)
 207 {
 208   /* name of the tracefile */
 209   char *default_tracing_filename = xbt_strdup("simgrid.trace");
 210   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_FILENAME,
 211                    "Trace file created by the instrumented SimGrid.",
 212                    xbt_cfgelm_string, &default_tracing_filename, 1, 1,
 213                    NULL, NULL);
 214
 215   /* tracing */
 216   int default_tracing = 0;
 217   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING,
 218                    "Enable Tracing.",
 219                    xbt_cfgelm_int, &default_tracing, 0, 1,
 220                    NULL, NULL);
 221
 222   /* register platform in the trace */
 223   int default_tracing_platform = 0;
 224   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_PLATFORM,
 225                    "Register the platform in the trace as a graph.",
 226                    xbt_cfgelm_int, &default_tracing_platform, 0, 1,
 227                    NULL, NULL);
 228
 229   /* smpi */
 230   int default_tracing_smpi = 0;
 231   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_SMPI,
 232                    "Tracing of the SMPI interface.",
 233                    xbt_cfgelm_int, &default_tracing_smpi, 0, 1,
 234                    NULL, NULL);
 235
 236   /* smpi grouped */
 237   int default_tracing_smpi_grouped = 0;
 238   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_SMPI_GROUP,
 239                    "Group MPI processes by host.",
 240                    xbt_cfgelm_int, &default_tracing_smpi_grouped, 0, 1,
 241                    NULL, NULL);
 242
 243
 244   /* tracing categorized resource utilization traces */
 245   int default_tracing_categorized = 0;
 246   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_CATEGORIZED,
 247                    "Tracing categorized resource utilization of hosts and links.",
 248                    xbt_cfgelm_int, &default_tracing_categorized, 0, 1,
 249                    NULL, NULL);
 250
 251   /* tracing uncategorized resource utilization */
 252   int default_tracing_uncategorized = 0;
 253   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_UNCATEGORIZED,
 254                    "Tracing uncategorized resource utilization of hosts and links.",
 255                    xbt_cfgelm_int, &default_tracing_uncategorized, 0, 1,
 256                    NULL, NULL);
 257
 258   /* msg process */
 259   int default_tracing_msg_process = 0;
 260   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_PROCESS,
 261                    "Tracing of MSG process behavior.",
 262                    xbt_cfgelm_int, &default_tracing_msg_process, 0, 1,
 263                    NULL, NULL);
 264
 265   /* tracing buffer */
 266   int default_buffer = 1;
 267   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_BUFFER,
 268                    "Buffer trace events to put them in temporal order.",
 269                    xbt_cfgelm_int, &default_buffer, 0, 1,
 270                    NULL, NULL);
 271
 272   /* tracing one link only */
 273   int default_onelink_only = 0;
 274   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_ONELINK_ONLY,
 275                    "Use only routes with one link to trace platform.",
 276                    xbt_cfgelm_int, &default_onelink_only, 0, 1,
 277                    NULL, NULL);
 278
 279   /* disable destroy */
 280   int default_disable_destroy = 0;
 281   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_DISABLE_DESTROY,
 282                    "Disable platform containers destruction.",
 283                    xbt_cfgelm_int, &default_disable_destroy, 0, 1,
 284                    NULL, NULL);
 285
 286   /* Triva graph configuration for uncategorized tracing */
 287   char *default_triva_uncat_conf_file = xbt_strdup ("");
 288   xbt_cfg_register(&_surf_cfg_set, OPT_TRIVA_UNCAT_CONF,
 289                    "Triva Graph configuration file for uncategorized resource utilization traces.",
 290                    xbt_cfgelm_string, &default_triva_uncat_conf_file, 1, 1,
 291                    NULL, NULL);
 292
 293   /* Triva graph configuration for uncategorized tracing */
 294   char *default_triva_cat_conf_file = xbt_strdup ("");
 295   xbt_cfg_register(&_surf_cfg_set, OPT_TRIVA_CAT_CONF,
 296                    "Triva Graph configuration file for categorized resource utilization traces.",
 297                    xbt_cfgelm_string, &default_triva_cat_conf_file, 1, 1,
 298                    NULL, NULL);
 299
 300   /* instrumentation can be considered configured now */
 301   trace_configured = 1;
 302 }
 303
 304 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
 305 {
 306   char str[INSTR_DEFAULT_STR_SIZE];
 307   snprintf (str, INSTR_DEFAULT_STR_SIZE, "--cfg=%s ", option);
 308
 309   int len = strlen (str);
 310   printf ("%s%*.*s %s\n", str, 30-len, 30-len, "", desc);
 311   if (!!longdesc && detailed){
 312     printf ("%s\n\n", longdesc);
 313   }
 314 }
 315
 316 void TRACE_help (int detailed)
 317 {
 318   printf(
 319       "Description of the tracing options accepted by this simulator:\n\n");
 320   print_line (OPT_TRACING, "Enable the tracing system",
 321       "  It activates the tracing system and register the simulation platform\n"
 322       "  in the trace file. You have to enable this option to others take effect.",
 323       detailed);
 324   print_line (OPT_TRACING_CATEGORIZED, "Trace categorized resource utilization",
 325       "  It activates the categorized resource utilization tracing. It should\n"
 326       "  be enabled if tracing categories are used by this simulator.",
 327       detailed);
 328   print_line (OPT_TRACING_UNCATEGORIZED, "Trace uncategorized resource utilization",
 329       "  It activates the uncategorized resource utilization tracing. Use it if\n"
 330       "  this simulator do not use tracing categories and resource use have to be\n"
 331       "  traced.",
 332       detailed);
 333   print_line (OPT_TRACING_FILENAME, "Filename to register traces",
 334       "  A file with this name will be created to register the simulation. The file\n"
 335       "  is in the Paje format and can be analyzed using Triva or Paje visualization\n"
 336       "  tools. More information can be found in these webpages:\n"
 337       "     http://triva.gforge.inria.fr/\n"
 338       "     http://paje.sourceforge.net/",
 339       detailed);
 340   print_line (OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
 341       "  This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
 342       "  interface and generates a trace that can be analyzed using Gantt-like\n"
 343       "  visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
 344       "  state, and point-to-point communications can be analyzed with arrows.",
 345       detailed);
 346   print_line (OPT_TRACING_SMPI_GROUP, "Group MPI processes by host (SMPI)",
 347       "  This option only has effect if this simulator is SMPI-based. The processes\n"
 348       "  are grouped by the hosts where they were executed.",
 349       detailed);
 350   print_line (OPT_TRACING_MSG_PROCESS, "Trace processes behavior (MSG)",
 351       "  This option only has effect if this simulator is MSG-based. It traces the\n"
 352       "  behavior of all categorized MSG processes, grouping them by hosts. This option\n"
 353       "  can be used to track process location if this simulator has process migration.",
 354       detailed);
 355   print_line (OPT_TRACING_BUFFER, "Buffer events to put them in temporal order",
 356       "  This option put some events in a time-ordered buffer using the insertion\n"
 357       "  sort algorithm. The process of acquiring and releasing locks to access this\n"
 358       "  buffer and the cost of the sorting algorithm make this process slow. The\n"
 359       "  simulator performance can be severely impacted if this option is activated,\n"
 360       "  but you are sure to get a trace file with events sorted.",
 361       detailed);
 362   print_line (OPT_TRACING_ONELINK_ONLY, "Consider only one link routes to trace platform",
 363       "  This option changes the way SimGrid register its platform on the trace file.\n"
 364       "  Normally, the tracing considers all routes (no matter their size) on the\n"
 365       "  platform file to re-create the resource topology. If this option is activated,\n"
 366       "  only the routes with one link are used to register the topology within an AS.\n"
 367       "  Routes among AS continue to be traced as usual.",
 368       detailed);
 369   print_line (OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
 370       "  Disable the destruction of containers at the end of simulation. This can be\n"
 371       "  used with simulators that have a different notion of time (different from\n"
 372       "  the simulated time).",
 373       detailed);
 374   print_line (OPT_TRIVA_UNCAT_CONF, "Generate graph configuration for Triva",
 375       "  This option can be used in all types of simulators build with SimGrid\n"
 376       "  to generate a uncategorized resource utilization graph to be used as\n"
 377       "  configuration for the Triva visualization analysis. This option\n"
 378       "  can be used with tracing/categorized:1 and tracing:1 options to\n"
 379       "  analyze an unmodified simulator before changing it to contain\n"
 380       "  categories.",
 381       detailed);
 382   print_line (OPT_TRIVA_CAT_CONF, "generate uncategorized graph configuration for Triva",
 383       "  This option can be used if this simulator uses tracing categories\n"
 384       "  in its code. The file specified by this option holds a graph configuration\n"
 385       "  file for the Triva visualization tool that can be used to analyze a categorized\n"
 386       "  resource utilization.",
 387       detailed);
 388 }
 389
 390 void TRACE_generate_triva_uncat_conf (void)
 391 {
 392   char *output = TRACE_get_triva_uncat_conf ();
 393   if (output && strlen(output) > 0){
 394     xbt_dict_cursor_t cursor=NULL;
 395     char *name, *value;
 396
 397     FILE *file = fopen (output, "w");
 398     if (file == NULL){
 399       THROWF (system_error, 1, "Unable to open file (%s) for writing triva graph "
 400           "configuration (uncategorized).", output);
 401     }
 402
 403     //open
 404     fprintf (file, "{\n");
 405
 406     //register NODE types
 407     fprintf (file, "  node = (");
 408     xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
 409       fprintf (file, "%s, ", name);
 410     }
 411
 412     //register EDGE types
 413     fprintf (file,
 414         ");\n"
 415         "  edge = (");
 416     xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
 417       fprintf (file, "%s, ", name);
 418     }
 419     fprintf (file,
 420         ");\n"
 421         "\n");
 422
 423     //configuration for all nodes
 424     fprintf (file,
 425         "  host = {\n"
 426         "    type = square;\n"
 427         "    size = power;\n"
 428         "    values = (power_used);\n"
 429         "  };\n"
 430         "  link = {\n"
 431         "    type = rhombus;\n"
 432         "    size = bandwidth;\n"
 433         "    values = (bandwidth_used);\n"
 434         "  };\n");
 435     //close
 436     fprintf (file, "}\n");
 437     fclose (file);
 438   }
 439 }
 440
 441 void TRACE_generate_triva_cat_conf (void)
 442 {
 443   char *output = TRACE_get_triva_cat_conf();
 444   if (output && strlen(output) > 0){
 445     xbt_dict_cursor_t cursor=NULL, cursor2=NULL;
 446     char *name, *name2, *value, *value2;
 447
 448     //check if we do have categories declared
 449     if (xbt_dict_is_empty(created_categories)){
 450       XBT_INFO("No categories declared, ignoring generation of triva graph configuration");
 451       return;
 452     }
 453
 454     FILE *file = fopen (output, "w");
 455     if (file == NULL){
 456       THROWF (system_error, 1, "Unable to open file (%s) for writing triva graph "
 457           "configuration (categorized).", output);
 458     }
 459
 460     //open
 461     fprintf (file, "{\n");
 462
 463     //register NODE types
 464     fprintf (file, "  node = (");
 465     xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
 466       fprintf (file, "%s, ", name);
 467     }
 468
 469     //register EDGE types
 470     fprintf (file,
 471         ");\n"
 472         "  edge = (");
 473     xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
 474       fprintf (file, "%s, ", name);
 475     }
 476     fprintf (file,
 477         ");\n"
 478         "\n");
 479
 480     //configuration for all nodes
 481     fprintf (file,
 482         "  host = {\n"
 483         "    type = square;\n"
 484         "    size = power;\n"
 485         "    values = (");
 486     xbt_dict_foreach(created_categories,cursor2,name2,value2) {
 487       fprintf (file, "p%s, ", name2);
 488     }
 489     fprintf (file,
 490         ");\n"
 491         "  };\n"
 492         "  link = {\n"
 493         "    type = rhombus;\n"
 494         "    size = bandwidth;\n"
 495         "    values = (");
 496     xbt_dict_foreach(created_categories,cursor2,name2,value2) {
 497       fprintf (file, "b%s, ", name2);
 498     }
 499     fprintf (file,
 500         ");\n"
 501         "  };\n");
 502     //close
 503     fprintf (file, "}\n");
 504     fclose (file);
 505   }
 506 }
 507
 508 #undef OPT_TRACING
 509 #undef OPT_TRACING_PLATFORM
 510 #undef OPT_TRACING_SMPI
 511 #undef OPT_TRACING_SMPI_GROUP
 512 #undef OPT_TRACING_CATEGORIZED
 513 #undef OPT_TRACING_UNCATEGORIZED
 514 #undef OPT_TRACING_MSG_PROCESS
 515 #undef OPT_TRACING_FILENAME
 516 #undef OPT_TRACING_BUFFER
 517 #undef OPT_TRACING_ONELINK_ONLY
 518 #undef OPT_TRACING_DISABLE_DESTROY
 519 #undef OPT_TRIVA_UNCAT_CONF
 520 #undef OPT_TRIVA_CAT_CONF
 521
 522 #endif /* HAVE_TRACING */