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