src/instr/instr_config.cpp

   1 /* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "include/xbt/config.hpp"
   7 #include "src/instr/instr_private.hpp"
   8 #include "surf/surf.hpp"
   9 #include <string>
  10 #include <vector>
  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_BASIC                "tracing/basic"
  16 #define OPT_TRACING_BUFFER               "tracing/buffer"
  17 #define OPT_TRACING_CATEGORIZED          "tracing/categorized"
  18 #define OPT_TRACING_COMMENT_FILE         "tracing/comment-file"
  19 #define OPT_TRACING_COMMENT              "tracing/comment"
  20 #define OPT_TRACING_DISABLE_DESTROY      "tracing/disable-destroy"
  21 #define OPT_TRACING_DISABLE_LINK         "tracing/disable-link"
  22 #define OPT_TRACING_DISABLE_POWER        "tracing/disable-power"
  23 #define OPT_TRACING_DISPLAY_SIZES        "tracing/smpi/display-sizes"
  24 #define OPT_TRACING_FILENAME             "tracing/filename"
  25 #define OPT_TRACING_FORMAT_TI_ONEFILE    "tracing/smpi/format/ti-one-file"
  26 #define OPT_TRACING_FORMAT               "tracing/smpi/format"
  27 #define OPT_TRACING_ACTOR "tracing/msg/process"
  28 #define OPT_TRACING_VM "tracing/vm"
  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
  40 static simgrid::config::Flag<bool> trace_enabled{OPT_TRACING, "Enable Tracing.", false};
  41 static simgrid::config::Flag<bool> trace_platform{OPT_TRACING_PLATFORM,
  42                                                   "Register the platform in the trace as a hierarchy.", false};
  43 static simgrid::config::Flag<bool> trace_platform_topology{
  44     OPT_TRACING_TOPOLOGY, "Register the platform topology in the trace as a graph.", true};
  45 static simgrid::config::Flag<bool> trace_smpi_enabled{OPT_TRACING_SMPI, "Tracing of the SMPI interface.", false};
  46 static simgrid::config::Flag<bool> trace_smpi_grouped{OPT_TRACING_SMPI_GROUP, "Group MPI processes by host.", false};
  47 static simgrid::config::Flag<bool> trace_smpi_computing{
  48     OPT_TRACING_SMPI_COMPUTING, "Generate states for timing out of SMPI parts of the application", false};
  49 static simgrid::config::Flag<bool> trace_smpi_sleeping{
  50     OPT_TRACING_SMPI_SLEEPING, "Generate states for timing out of SMPI parts of the application", false};
  51 static simgrid::config::Flag<bool> trace_view_internals{
  52     OPT_TRACING_SMPI_INTERNALS, "View internal messages sent by Collective communications in SMPI", false};
  53 static simgrid::config::Flag<bool> trace_categorized{
  54     OPT_TRACING_CATEGORIZED, "Tracing categorized resource utilization of hosts and links.", false};
  55 static simgrid::config::Flag<bool> trace_uncategorized{
  56     OPT_TRACING_UNCATEGORIZED, "Tracing uncategorized resource utilization of hosts and links.", false};
  57 static simgrid::config::Flag<bool> trace_actor_enabled{OPT_TRACING_ACTOR, "Tracing of actor behavior.", false};
  58 static simgrid::config::Flag<bool> trace_vm_enabled{OPT_TRACING_VM, "Tracing of virtual machine behavior.", false};
  59 static simgrid::config::Flag<bool> trace_buffer{OPT_TRACING_BUFFER,
  60                                                 "Buffer trace events to put them in temporal order.", true};
  61 static simgrid::config::Flag<bool> trace_disable_destroy{
  62     OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false};
  63 static simgrid::config::Flag<bool> trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
  64                                                false};
  65 static simgrid::config::Flag<bool> trace_display_sizes{OPT_TRACING_DISPLAY_SIZES,
  66                                                        {"tracing/smpi/display_sizes"},
  67                                                        "(smpi only) Extended events with message size information",
  68                                                        false};
  69 static simgrid::config::Flag<bool> trace_disable_link{
  70     OPT_TRACING_DISABLE_LINK, {"tracing/disable_link"}, "Do not trace link bandwidth and latency.", false};
  71 static simgrid::config::Flag<bool> trace_disable_power{
  72     OPT_TRACING_DISABLE_POWER, {"tracing/disable_power"}, "Do not trace host power.", false};
  73
  74 static bool trace_active     = false;
  75
  76 simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje;
  77
  78 int TRACE_start()
  79 {
  80   // tracing system must be:
  81   //    - enabled (with --cfg=tracing:yes)
  82   //    - already configured (TRACE_global_init already called)
  83   if (TRACE_is_enabled()) {
  84
  85     XBT_DEBUG("Tracing starts");
  86     /* init the tracing module to generate the right output */
  87
  88     /* open the trace file(s) */
  89     std::string format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
  90     XBT_DEBUG("Tracing format %s\n", format.c_str());
  91     if (format == "Paje") {
  92       TRACE_paje_start();
  93     } else if (format == "TI") {
  94       simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti;
  95       TRACE_TI_start();
  96     }else{
  97       xbt_die("Unknown trace format :%s ", format.c_str());
  98     }
  99
 100     /* activate trace */
 101     if (trace_active) {
 102       THROWF(tracing_error, 0, "Tracing is already active");
 103     }
 104     trace_active = true;
 105     XBT_DEBUG("Tracing is on");
 106   }
 107   return 0;
 108 }
 109
 110 int TRACE_end()
 111 {
 112   int retval;
 113   if (not trace_active) {
 114     retval = 1;
 115   } else {
 116     retval = 0;
 117
 118     /* dump trace buffer */
 119     TRACE_last_timestamp_to_dump = surf_get_clock();
 120     TRACE_paje_dump_buffer(true);
 121
 122     simgrid::instr::Type* root_type = simgrid::instr::Container::getRoot()->type_;
 123     /* destroy all data structures of tracing (and free) */
 124     delete simgrid::instr::Container::getRoot();
 125     delete root_type;
 126
 127     /* close the trace files */
 128     std::string format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
 129     XBT_DEBUG("Tracing format %s\n", format.c_str());
 130     if (format == "Paje") {
 131       TRACE_paje_end();
 132     } else if (format == "TI") {
 133       TRACE_TI_end();
 134     }else{
 135       xbt_die("Unknown trace format :%s ", format.c_str());
 136     }
 137
 138     /* de-activate trace */
 139     trace_active = false;
 140     XBT_DEBUG("Tracing is off");
 141     XBT_DEBUG("Tracing system is shutdown");
 142   }
 143   return retval;
 144 }
 145
 146 bool TRACE_needs_platform ()
 147 {
 148   return TRACE_actor_is_enabled() || TRACE_vm_is_enabled() || TRACE_categorized() || TRACE_uncategorized() ||
 149          TRACE_platform() || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
 150 }
 151
 152 bool TRACE_is_enabled()
 153 {
 154   return trace_enabled;
 155 }
 156
 157 bool TRACE_platform()
 158 {
 159   return trace_platform;
 160 }
 161
 162 bool TRACE_platform_topology()
 163 {
 164   return trace_platform_topology;
 165 }
 166
 167 bool TRACE_smpi_is_enabled()
 168 {
 169   return (trace_smpi_enabled || TRACE_smpi_is_grouped()) && TRACE_is_enabled();
 170 }
 171
 172 bool TRACE_smpi_is_grouped()
 173 {
 174   return trace_smpi_grouped;
 175 }
 176
 177 bool TRACE_smpi_is_computing()
 178 {
 179   return trace_smpi_computing;
 180 }
 181
 182 bool TRACE_smpi_is_sleeping()
 183 {
 184   return trace_smpi_sleeping;
 185 }
 186
 187 bool TRACE_smpi_view_internals()
 188 {
 189   return trace_view_internals;
 190 }
 191
 192 bool TRACE_categorized ()
 193 {
 194   return trace_categorized;
 195 }
 196
 197 bool TRACE_uncategorized ()
 198 {
 199   return trace_uncategorized;
 200 }
 201
 202 bool TRACE_actor_is_enabled()
 203 {
 204   return trace_actor_enabled && TRACE_is_enabled();
 205 }
 206
 207 bool TRACE_vm_is_enabled()
 208 {
 209   return trace_vm_enabled && TRACE_is_enabled();
 210 }
 211
 212 bool TRACE_disable_link()
 213 {
 214   return trace_disable_link && TRACE_is_enabled();
 215 }
 216
 217 bool TRACE_disable_speed()
 218 {
 219   return trace_disable_power && TRACE_is_enabled();
 220 }
 221
 222 bool TRACE_buffer ()
 223 {
 224   return trace_buffer && TRACE_is_enabled();
 225 }
 226
 227 bool TRACE_disable_destroy ()
 228 {
 229   return trace_disable_destroy && TRACE_is_enabled();
 230 }
 231
 232 bool TRACE_basic ()
 233 {
 234   return trace_basic && TRACE_is_enabled();
 235 }
 236
 237 bool TRACE_display_sizes ()
 238 {
 239    return trace_display_sizes && trace_smpi_enabled && TRACE_is_enabled();
 240 }
 241
 242 std::string TRACE_get_comment()
 243 {
 244   return xbt_cfg_get_string(OPT_TRACING_COMMENT);
 245 }
 246
 247 std::string TRACE_get_comment_file()
 248 {
 249   return xbt_cfg_get_string(OPT_TRACING_COMMENT_FILE);
 250 }
 251
 252 int TRACE_precision ()
 253 {
 254   return xbt_cfg_get_int(OPT_TRACING_PRECISION);
 255 }
 256
 257 std::string TRACE_get_filename()
 258 {
 259   return xbt_cfg_get_string(OPT_TRACING_FILENAME);
 260 }
 261
 262 void TRACE_global_init()
 263 {
 264   static bool is_initialised = false;
 265   if (is_initialised)
 266     return;
 267
 268   is_initialised = true;
 269   /* name of the tracefile */
 270   simgrid::config::declare_flag<std::string>(OPT_TRACING_FILENAME, "Trace file created by the instrumented SimGrid.",
 271                                              "simgrid.trace");
 272   simgrid::config::declare_flag<std::string>(OPT_TRACING_FORMAT, "(smpi only) Switch the output format of Tracing",
 273                                              "Paje");
 274   simgrid::config::declare_flag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
 275                                       "(smpi only) For replay format only : output to one file only", false);
 276   simgrid::config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"});
 277   simgrid::config::declare_flag<std::string>(OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
 278                                              "");
 279   simgrid::config::declare_flag<std::string>(
 280       OPT_TRACING_COMMENT_FILE, "The contents of the file are added to the top of the trace file as comment.", "");
 281   simgrid::config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"});
 282   simgrid::config::declare_flag<int>(OPT_TRACING_PRECISION, "Numerical precision used when timestamping events "
 283                                                             "(expressed in number of digits after decimal point)",
 284                                      6);
 285 }
 286
 287 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
 288 {
 289   std::string str = std::string("--cfg=") + option + " ";
 290
 291   int len = str.size();
 292   printf("%s%*.*s %s\n", str.c_str(), 30 - len, 30 - len, "", desc);
 293   if (longdesc != nullptr && detailed){
 294     printf ("%s\n\n", longdesc);
 295   }
 296 }
 297
 298 void TRACE_help (int detailed)
 299 {
 300   printf("Description of the tracing options accepted by this simulator:\n\n");
 301   print_line (OPT_TRACING, "Enable the tracing system",
 302       "  It activates the tracing system and register the simulation platform\n"
 303       "  in the trace file. You have to enable this option to others take effect.", detailed);
 304   print_line (OPT_TRACING_CATEGORIZED, "Trace categorized resource utilization",
 305       "  It activates the categorized resource utilization tracing. It should\n"
 306       "  be enabled if tracing categories are used by this simulator.", detailed);
 307   print_line (OPT_TRACING_UNCATEGORIZED, "Trace uncategorized resource utilization",
 308       "  It activates the uncategorized resource utilization tracing. Use it if\n"
 309       "  this simulator do not use tracing categories and resource use have to be\n"
 310       "  traced.", detailed);
 311   print_line(OPT_TRACING_FILENAME, "Filename to register traces",
 312              "  A file with this name will be created to register the simulation. The file\n"
 313              "  is in the Paje format and can be analyzed using Paje, and PajeNG visualization\n"
 314              "  tools. More information can be found in these webpages:\n"
 315              "     http://github.com/schnorr/pajeng/\n"
 316              "     http://paje.sourceforge.net/",
 317              detailed);
 318   print_line (OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
 319       "  This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
 320       "  interface and generates a trace that can be analyzed using Gantt-like\n"
 321       "  visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
 322       "  state, and point-to-point communications can be analyzed with arrows.", detailed);
 323   print_line (OPT_TRACING_SMPI_GROUP, "Group MPI processes by host (SMPI)",
 324       "  This option only has effect if this simulator is SMPI-based. The processes\n"
 325       "  are grouped by the hosts where they were executed.", detailed);
 326   print_line (OPT_TRACING_SMPI_COMPUTING, "Generates a \" Computing \" State",
 327       "  This option aims at tracing computations in the application, outside SMPI\n"
 328       "  to allow further study of simulated or real computation time", detailed);
 329    print_line (OPT_TRACING_SMPI_SLEEPING, "Generates a \" Sleeping \" State",
 330       "  This option aims at tracing sleeps in the application, outside SMPI\n"
 331       "  to allow further study of simulated or real sleep time", detailed);
 332   print_line (OPT_TRACING_SMPI_INTERNALS, "Generates tracing events corresponding",
 333       "  to point-to-point messages sent by collective communications", detailed);
 334   print_line(OPT_TRACING_ACTOR, "Trace actor behavior",
 335              "  This option traces the behavior of all categorized actors, grouping them\n"
 336              "  by hosts. This option can be used to track actor location if the simulator\n"
 337              "  does actor migration.",
 338              detailed);
 339   print_line (OPT_TRACING_BUFFER, "Buffer events to put them in temporal order",
 340       "  This option put some events in a time-ordered buffer using the insertion\n"
 341       "  sort algorithm. The process of acquiring and releasing locks to access this\n"
 342       "  buffer and the cost of the sorting algorithm make this process slow. The\n"
 343       "  simulator performance can be severely impacted if this option is activated,\n"
 344       "  but you are sure to get a trace file with events sorted.", detailed);
 345   print_line (OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
 346       "  Disable the destruction of containers at the end of simulation. This can be\n"
 347       "  used with simulators that have a different notion of time (different from\n"
 348       "  the simulated time).", detailed);
 349   print_line (OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
 350       "  Some visualization tools are not able to parse correctly the Paje file format.\n"
 351       "  Use this option if you are using one of these tools to visualize the simulation\n"
 352       "  trace. Keep in mind that the trace might be incomplete, without all the\n"
 353       "  information that would be registered otherwise.", detailed);
 354   print_line (OPT_TRACING_DISPLAY_SIZES, "Only works for SMPI now. Add message size information",
 355       "  Message size (in bytes) is added to links, and to states. For collectives,\n"
 356       "  the displayed value is the more relevant to the collective (total sent by\n"
 357       "  the process, usually)", detailed);
 358   print_line (OPT_TRACING_FORMAT, "Only works for SMPI now. Switch output format",
 359       "  Default format is Paje. Time independent traces are also supported,\n"
 360       "  to output traces that can later be used by the trace replay tool", detailed);
 361   print_line (OPT_TRACING_FORMAT_TI_ONEFILE, "Only works for SMPI now, and TI output format",
 362       "  By default, each process outputs to a separate file, inside a filename_files folder\n"
 363       "  By setting this option to yes, all processes will output to only one file\n"
 364       "  This is meant to avoid opening thousands of files with large simulations", detailed);
 365   print_line (OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
 366       "  Use this to add a comment line to the top of the trace file.", detailed);
 367   print_line (OPT_TRACING_COMMENT_FILE, "File contents added to trace file as comment.",
 368       "  Use this to add the contents of a file to the top of the trace file as comment.", detailed);
 369   print_line (OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
 370         "  This option (enabled by default) can be used to disable the tracing of\n"
 371         "  the platform topology in the trace file. Sometimes, such task is really\n"
 372         "  time consuming, since it must get the route from each host to other hosts\n"
 373         "  within the same Autonomous System (AS).", detailed);
 374 }