src/instr/instr_config.cpp

   1 /* Copyright (c) 2010-2020. 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 "simgrid/Exception.hpp"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "simgrid/version.h"
  10 #include "src/instr/instr_private.hpp"
  11 #include "surf/surf.hpp"
  12 #include "xbt/virtu.h" /* xbt::cmdline */
  13
  14 #include <sys/stat.h>
  15 #ifdef WIN32
  16 #include <direct.h> // _mkdir
  17 #endif
  18
  19 #include <fstream>
  20 #include <string>
  21 #include <vector>
  22
  23 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
  25
  26 std::ofstream tracing_file;
  27 std::map<container_t, std::ofstream*> tracing_files; // TI specific
  28 double prefix = 0.0;                                 // TI specific
  29
  30 constexpr char OPT_TRACING_BASIC[]             = "tracing/basic";
  31 constexpr char OPT_TRACING_COMMENT_FILE[]      = "tracing/comment-file";
  32 constexpr char OPT_TRACING_DISABLE_DESTROY[]   = "tracing/disable-destroy";
  33 constexpr char OPT_TRACING_FORMAT_TI_ONEFILE[] = "tracing/smpi/format/ti-one-file";
  34 constexpr char OPT_TRACING_SMPI[]              = "tracing/smpi";
  35 constexpr char OPT_TRACING_TOPOLOGY[]          = "tracing/platform/topology";
  36
  37 static simgrid::config::Flag<bool> trace_enabled{
  38     "tracing", "Enable the tracing system. You have to enable this option to use other tracing options.", false};
  39
  40 static simgrid::config::Flag<bool> trace_actor_enabled{
  41     "tracing/msg/process", // FIXME rename this flag
  42     "Trace the behavior of all categorized actors, grouping them by host. "
  43     "Can be used to track actor location if the simulator does actor migration.",
  44     false};
  45
  46 static simgrid::config::Flag<bool> trace_vm_enabled{"tracing/vm", "Trace the behavior of all virtual machines.", false};
  47
  48 static simgrid::config::Flag<bool> trace_platform{"tracing/platform",
  49                                                   "Register the platform in the trace as a hierarchy.", false};
  50
  51 static simgrid::config::Flag<bool> trace_platform_topology{
  52     OPT_TRACING_TOPOLOGY, "Register the platform topology in the trace as a graph.", true};
  53 static simgrid::config::Flag<bool> trace_smpi_enabled{OPT_TRACING_SMPI, "Tracing of the SMPI interface.", false};
  54 static simgrid::config::Flag<bool> trace_smpi_grouped{"tracing/smpi/group", "Group MPI processes by host.", false};
  55
  56 static simgrid::config::Flag<bool> trace_smpi_computing{
  57     "tracing/smpi/computing", "Generate 'Computing' states to trace the out-of-SMPI parts of the application", false};
  58
  59 static simgrid::config::Flag<bool> trace_smpi_sleeping{
  60     "tracing/smpi/sleeping", "Generate 'Sleeping' states for the sleeps in the application that do not pertain to SMPI",
  61     false};
  62
  63 static simgrid::config::Flag<bool> trace_view_internals{
  64     "tracing/smpi/internals",
  65     "Generate tracing events corresponding to point-to-point messages sent by SMPI collective communications", false};
  66
  67 static simgrid::config::Flag<bool> trace_categorized{
  68     "tracing/categorized", "Trace categorized resource utilization of hosts and links.", false};
  69
  70 static simgrid::config::Flag<bool> trace_uncategorized{
  71     "tracing/uncategorized",
  72     "Trace uncategorized resource utilization of hosts and links. "
  73     "To use if the simulator does not use tracing categories but resource utilization have to be traced.",
  74     false};
  75
  76 static simgrid::config::Flag<bool> trace_disable_destroy{
  77     OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false};
  78 static simgrid::config::Flag<bool> trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
  79                                                false};
  80
  81 static simgrid::config::Flag<bool> trace_display_sizes{
  82     "tracing/smpi/display-sizes",
  83     "Add message size information (in bytes) to the to links and states (SMPI only). "
  84     "For collectives, it usually corresponds to the total number of bytes sent by a process.",
  85     false};
  86
  87 static simgrid::config::Flag<bool> trace_disable_link{"tracing/disable_link",
  88                                                       "Do not trace link bandwidth and latency.", false};
  89 static simgrid::config::Flag<bool> trace_disable_power{"tracing/disable_power", "Do not trace host power.", false};
  90
  91 simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje;
  92
  93 bool TRACE_needs_platform ()
  94 {
  95   return TRACE_actor_is_enabled() || TRACE_vm_is_enabled() || TRACE_categorized() || TRACE_uncategorized() ||
  96          TRACE_platform() || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
  97 }
  98
  99 bool TRACE_is_enabled()
 100 {
 101   return trace_enabled;
 102 }
 103
 104 bool TRACE_platform()
 105 {
 106   return trace_platform;
 107 }
 108
 109 bool TRACE_platform_topology()
 110 {
 111   return trace_platform_topology;
 112 }
 113
 114 bool TRACE_smpi_is_enabled()
 115 {
 116   return (trace_smpi_enabled || TRACE_smpi_is_grouped()) && TRACE_is_enabled();
 117 }
 118
 119 bool TRACE_smpi_is_grouped()
 120 {
 121   return trace_smpi_grouped;
 122 }
 123
 124 bool TRACE_smpi_is_computing()
 125 {
 126   return trace_smpi_computing;
 127 }
 128
 129 bool TRACE_smpi_is_sleeping()
 130 {
 131   return trace_smpi_sleeping;
 132 }
 133
 134 bool TRACE_smpi_view_internals()
 135 {
 136   return trace_view_internals;
 137 }
 138
 139 bool TRACE_categorized ()
 140 {
 141   return trace_categorized;
 142 }
 143
 144 bool TRACE_uncategorized ()
 145 {
 146   return trace_uncategorized;
 147 }
 148
 149 bool TRACE_actor_is_enabled()
 150 {
 151   return trace_actor_enabled && trace_enabled;
 152 }
 153
 154 bool TRACE_vm_is_enabled()
 155 {
 156   return trace_vm_enabled && trace_enabled;
 157 }
 158
 159 bool TRACE_disable_link()
 160 {
 161   return trace_disable_link && trace_enabled;
 162 }
 163
 164 bool TRACE_disable_speed()
 165 {
 166   return trace_disable_power && trace_enabled;
 167 }
 168
 169 bool TRACE_disable_destroy ()
 170 {
 171   return trace_disable_destroy && trace_enabled;
 172 }
 173
 174 bool TRACE_basic ()
 175 {
 176   return trace_basic && trace_enabled;
 177 }
 178
 179 bool TRACE_display_sizes ()
 180 {
 181   return trace_display_sizes && trace_smpi_enabled && trace_enabled;
 182 }
 183
 184 int TRACE_precision ()
 185 {
 186   return simgrid::config::get_value<int>("tracing/precision");
 187 }
 188
 189 std::string TRACE_get_filename()
 190 {
 191   return simgrid::config::get_value<std::string>("tracing/filename");
 192 }
 193
 194 static void print_line(const char* option, const char* desc, const char* longdesc)
 195 {
 196   std::string str = std::string("--cfg=") + option + " ";
 197
 198   int len = str.size();
 199   XBT_HELP("%s%*.*s %s", str.c_str(), 30 - len, 30 - len, "", desc);
 200   if (longdesc != nullptr) {
 201     XBT_HELP("%s\n", longdesc);
 202   }
 203 }
 204
 205 void TRACE_help()
 206 {
 207   XBT_HELP("Description of the tracing options accepted by this simulator:\n");
 208   print_line(OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
 209              "  This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
 210              "  interface and generates a trace that can be analyzed using Gantt-like\n"
 211              "  visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
 212              "  state, and point-to-point communications can be analyzed with arrows.");
 213   print_line(OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
 214              "  Disable the destruction of containers at the end of simulation. This can be\n"
 215              "  used with simulators that have a different notion of time (different from\n"
 216              "  the simulated time).");
 217   print_line(OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
 218              "  Some visualization tools are not able to parse correctly the Paje file format.\n"
 219              "  Use this option if you are using one of these tools to visualize the simulation\n"
 220              "  trace. Keep in mind that the trace might be incomplete, without all the\n"
 221              "  information that would be registered otherwise.");
 222   print_line(OPT_TRACING_FORMAT_TI_ONEFILE, "Only works for SMPI now, and TI output format",
 223              "  By default, each process outputs to a separate file, inside a filename_files folder\n"
 224              "  By setting this option to yes, all processes will output to only one file\n"
 225              "  This is meant to avoid opening thousands of files with large simulations");
 226   print_line(OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
 227              "  This option (enabled by default) can be used to disable the tracing of\n"
 228              "  the platform topology in the trace file. Sometimes, such task is really\n"
 229              "  time consuming, since it must get the route from each host to other hosts\n"
 230              "  within the same Autonomous System (AS).");
 231 }
 232
 233 namespace simgrid {
 234 namespace instr {
 235
 236 static bool trace_active = false;
 237 /*************
 238  * Callbacks *
 239  *************/
 240 xbt::signal<void(Container&)> Container::on_creation;
 241 xbt::signal<void(Container&)> Container::on_destruction;
 242 xbt::signal<void(EntityValue&)> EntityValue::on_creation;
 243
 244 static void on_container_creation_paje(Container& c)
 245 {
 246   double timestamp = SIMIX_get_clock();
 247   std::stringstream stream;
 248
 249   XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_CreateContainer, timestamp);
 250
 251   stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_CreateContainer << " ";
 252   stream << timestamp << " " << c.get_id() << " " << c.type_->get_id() << " " << c.father_->get_id() << " \"";
 253   if (c.get_name().find("rank-") != 0)
 254     stream << c.get_name() << "\"";
 255   else
 256     /* Subtract -1 because this is the process id and we transform it to the rank id */
 257     stream << "rank-" << stoi(c.get_name().substr(5)) - 1 << "\"";
 258
 259   XBT_DEBUG("Dump %s", stream.str().c_str());
 260   tracing_file << stream.str() << std::endl;
 261 }
 262
 263 static void on_container_destruction_paje(Container& c)
 264 {
 265   // obligation to dump previous events because they might reference the container that is about to be destroyed
 266   TRACE_last_timestamp_to_dump = SIMIX_get_clock();
 267   TRACE_paje_dump_buffer(true);
 268
 269   // trace my destruction, but not if user requests so or if the container is root
 270   if (not TRACE_disable_destroy() && &c != Container::get_root()) {
 271     std::stringstream stream;
 272     double timestamp = SIMIX_get_clock();
 273
 274     XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_DestroyContainer, timestamp);
 275
 276     stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_DestroyContainer << " ";
 277     stream << timestamp << " " << c.type_->get_id() << " " << c.get_id();
 278     XBT_DEBUG("Dump %s", stream.str().c_str());
 279     tracing_file << stream.str() << std::endl;
 280   }
 281 }
 282
 283 static void on_container_creation_ti(Container& c)
 284 {
 285   XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_CreateContainer, SIMIX_get_clock());
 286   // if we are in the mode with only one file
 287   static std::ofstream* ti_unique_file = nullptr;
 288
 289   if (tracing_files.empty()) {
 290     // generate unique run id with time
 291     prefix = xbt_os_time();
 292   }
 293
 294   if (not simgrid::config::get_value<bool>("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
 295     std::string folder_name = simgrid::config::get_value<std::string>("tracing/filename") + "_files";
 296     std::string filename    = folder_name + "/" + std::to_string(prefix) + "_" + c.get_name() + ".txt";
 297 #ifdef WIN32
 298     _mkdir(folder_name.c_str());
 299 #else
 300     mkdir(folder_name.c_str(), S_IRWXU | S_IRWXG | S_IRWXO);
 301 #endif
 302     ti_unique_file = new std::ofstream(filename.c_str(), std::ofstream::out);
 303     xbt_assert(not ti_unique_file->fail(), "Tracefile %s could not be opened for writing", filename.c_str());
 304     tracing_file << filename << std::endl;
 305   }
 306   tracing_files.insert({&c, ti_unique_file});
 307 }
 308
 309 static void on_container_destruction_ti(Container& c)
 310 {
 311   // obligation to dump previous events because they might reference the container that is about to be destroyed
 312   TRACE_last_timestamp_to_dump = SIMIX_get_clock();
 313   TRACE_paje_dump_buffer(true);
 314
 315   if (not TRACE_disable_destroy() && &c != Container::get_root()) {
 316     XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_DestroyContainer, SIMIX_get_clock());
 317     if (not simgrid::config::get_value<bool>("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
 318       tracing_files.at(&c)->close();
 319       delete tracing_files.at(&c);
 320     }
 321     tracing_files.erase(&c);
 322   }
 323 }
 324
 325 static void on_entity_value_creation(EntityValue& value)
 326 {
 327   std::stringstream stream;
 328   XBT_DEBUG("%s: event_type=%u", __func__, PAJE_DefineEntityValue);
 329   stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_DefineEntityValue;
 330   stream << " " << value.get_id() << " " << value.get_father()->get_id() << " " << value.get_name();
 331   if (not value.get_color().empty())
 332     stream << " \"" << value.get_color() << "\"";
 333   XBT_DEBUG("Dump %s", stream.str().c_str());
 334   tracing_file << stream.str() << std::endl;
 335 }
 336
 337 static void on_simulation_start()
 338 {
 339   if (trace_active)
 340     return;
 341
 342   // tracing system must be:
 343   //    - enabled (with --cfg=tracing:yes)
 344   //    - already configured (simgrid::instr::init already called)
 345   if (TRACE_is_enabled()) {
 346     define_callbacks();
 347
 348     XBT_DEBUG("Tracing starts");
 349
 350     /* init the tracing module to generate the right output */
 351     std::string format = config::get_value<std::string>("tracing/smpi/format");
 352     XBT_DEBUG("Tracing format %s", format.c_str());
 353
 354     /* Connect the callbacks associated to the creation/destruction of containers*/
 355     if (format == "Paje") {
 356       Container::on_creation.connect(on_container_creation_paje);
 357       Container::on_destruction.connect(on_container_destruction_paje);
 358       EntityValue::on_creation.connect(on_entity_value_creation);
 359     } else {
 360       Container::on_creation.connect(on_container_creation_ti);
 361       Container::on_destruction.connect(on_container_destruction_ti);
 362     }
 363
 364     /* open the trace file(s) */
 365     std::string filename = TRACE_get_filename();
 366     tracing_file.open(filename.c_str(), std::ofstream::out);
 367     if (tracing_file.fail()) {
 368       throw TracingError(XBT_THROW_POINT,
 369                          xbt::string_printf("Tracefile %s could not be opened for writing.", filename.c_str()));
 370     }
 371
 372     XBT_DEBUG("Filename %s is open for writing", filename.c_str());
 373
 374     if (format == "Paje") {
 375       /* output generator version */
 376       tracing_file << "#This file was generated using SimGrid-" << SIMGRID_VERSION_MAJOR << "." << SIMGRID_VERSION_MINOR
 377                    << "." << SIMGRID_VERSION_PATCH << std::endl;
 378       tracing_file << "#[";
 379       for (auto str : simgrid::xbt::cmdline) {
 380         tracing_file << str << " ";
 381       }
 382       tracing_file << "]" << std::endl;
 383     }
 384
 385     /* output one line comment */
 386     std::string comment = simgrid::config::get_value<std::string>("tracing/comment");
 387     if (not comment.empty())
 388       tracing_file << "# " << comment << std::endl;
 389
 390     /* output comment file */
 391     dump_comment_file(simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT_FILE));
 392
 393     if (format == "Paje") {
 394       /* output Pajé header */
 395       TRACE_header(TRACE_basic(), TRACE_display_sizes());
 396     } else
 397       trace_format = TraceFormat::Ti;
 398
 399     trace_active = true;
 400     XBT_DEBUG("Tracing is on");
 401   }
 402 }
 403
 404 static void on_simulation_end()
 405 {
 406   if (not trace_active)
 407     return;
 408
 409   /* dump trace buffer */
 410   TRACE_last_timestamp_to_dump = surf_get_clock();
 411   TRACE_paje_dump_buffer(true);
 412
 413   const Type* root_type = Container::get_root()->type_;
 414   /* destroy all data structures of tracing (and free) */
 415   delete Container::get_root();
 416   delete root_type;
 417
 418   /* close the trace files */
 419   tracing_file.close();
 420   XBT_DEBUG("Filename %s is closed", TRACE_get_filename().c_str());
 421
 422   /* de-activate trace */
 423   trace_active = false;
 424   XBT_DEBUG("Tracing is off");
 425   XBT_DEBUG("Tracing system is shutdown");
 426 }
 427
 428 void init()
 429 {
 430   static bool is_initialized = false;
 431   if (is_initialized)
 432     return;
 433
 434   is_initialized = true;
 435
 436   /* name of the tracefile */
 437   config::declare_flag<std::string>("tracing/filename", "Trace file created by the instrumented SimGrid.",
 438                                     "simgrid.trace");
 439   config::declare_flag<std::string>("tracing/smpi/format",
 440                                     "Select trace output format used by SMPI. The default is the 'Paje' format. "
 441                                     "The 'TI' (Time-Independent) format allows for trace replay.",
 442                                     "Paje");
 443
 444   config::declare_flag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
 445                              "(smpi only) For replay format only : output to one file only", false);
 446   config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"});
 447   config::declare_flag<std::string>("tracing/comment", "Add a comment line to the top of the trace file.", "");
 448   config::declare_flag<std::string>(OPT_TRACING_COMMENT_FILE,
 449                                     "Add the contents of a file as comments to the top of the trace.", "");
 450   config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"});
 451   config::declare_flag<int>("tracing/precision",
 452                             "Numerical precision used when timestamping events "
 453                             "(expressed in number of digits after decimal point)",
 454                             6);
 455
 456   /* Connect callbacks */
 457   s4u::Engine::on_platform_creation.connect(on_simulation_start);
 458   s4u::Engine::on_deadlock.connect(on_simulation_end);
 459   s4u::Engine::on_simulation_end.connect(on_simulation_end);
 460 }
 461 } // namespace instr
 462 } // namespace simgrid