src/instr/instr_config.cpp

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