-/* Copyright (c) 2010-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2010-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
-#include "include/xbt/config.hpp"
-#include "simgrid/Exception.hpp"
-#include "simgrid/s4u/Engine.hpp"
-#include "simgrid/version.h"
+#include <simgrid/Exception.hpp>
+#include <simgrid/s4u/Engine.hpp>
+
#include "src/instr/instr_private.hpp"
-#include "surf/surf.hpp"
+#include "xbt/config.hpp"
+#include "xbt/xbt_os_time.h"
#include <sys/stat.h>
-#ifdef WIN32
-#include <direct.h> // _mkdir
-#endif
#include <fstream>
#include <string>
XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
std::ofstream tracing_file;
-std::map<container_t, std::ofstream*> tracing_files; // TI specific
-double prefix = 0.0; // TI specific
+static std::map<const simgrid::instr::Container*, std::ofstream*> tracing_files; // TI specific
constexpr char OPT_TRACING_BASIC[] = "tracing/basic";
constexpr char OPT_TRACING_COMMENT_FILE[] = "tracing/comment-file";
"tracing", "Enable the tracing system. You have to enable this option to use other tracing options.", false};
static simgrid::config::Flag<bool> trace_actor_enabled{
- "tracing/msg/process", // FIXME rename this flag
+ "tracing/actor",
"Trace the behavior of all categorized actors, grouping them by host. "
"Can be used to track actor location if the simulator does actor migration.",
false};
"To use if the simulator does not use tracing categories but resource utilization have to be traced.",
false};
-static simgrid::config::Flag<bool> trace_disable_destroy{
- OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false};
+static simgrid::config::Flag<bool> trace_disable_destroy{OPT_TRACING_DISABLE_DESTROY,
+ "Disable platform containers destruction.", false};
static simgrid::config::Flag<bool> trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
false};
{
std::string str = std::string("--cfg=") + option + " ";
- int len = str.size();
+ int len = static_cast<int>(str.size());
XBT_HELP("%s%*.*s %s", str.c_str(), 30 - len, 30 - len, "", desc);
if (longdesc != nullptr) {
XBT_HELP("%s\n", longdesc);
" within the same Autonomous System (AS).");
}
-namespace simgrid {
-namespace instr {
+namespace simgrid::instr {
static bool trace_active = false;
TraceFormat trace_format = TraceFormat::Paje;
-int trace_precision;
+static int trace_precision;
/*************
* Callbacks *
*************/
-xbt::signal<void(Container&)> Container::on_creation;
-xbt::signal<void(Container&)> Container::on_destruction;
-xbt::signal<void(EntityValue&)> EntityValue::on_creation;
-xbt::signal<void(Type&, e_event_type)> Type::on_creation;
-xbt::signal<void(LinkType&, Type&, Type&)> LinkType::on_creation;
-
-static void on_container_creation_paje(Container& c)
+xbt::signal<void(Container const&)> Container::on_creation;
+xbt::signal<void(Container const&)> Container::on_destruction;
+xbt::signal<void(Type const&, PajeEventType)> Type::on_creation;
+xbt::signal<void(LinkType const&, Type const&, Type const&)> LinkType::on_creation;
+xbt::signal<void(PajeEvent&)> PajeEvent::on_creation;
+xbt::signal<void(PajeEvent const&)> PajeEvent::on_destruction;
+xbt::signal<void(StateEvent const&)> StateEvent::on_destruction;
+xbt::signal<void(EntityValue const&)> EntityValue::on_creation;
+
+static void on_container_creation_paje(const Container& c)
{
- double timestamp = SIMIX_get_clock();
+ double timestamp = simgrid_get_clock();
std::stringstream stream;
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_CreateContainer, timestamp);
+ XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, static_cast<unsigned>(PajeEventType::CreateContainer),
+ timestamp);
- stream << std::fixed << std::setprecision(trace_precision) << PAJE_CreateContainer << " ";
- stream << timestamp << " " << c.get_id() << " " << c.type_->get_id() << " " << c.father_->get_id() << " \"";
+ stream << std::fixed << std::setprecision(trace_precision) << PajeEventType::CreateContainer << " ";
+ stream << timestamp << " " << c.get_id() << " " << c.get_type()->get_id() << " " << c.get_parent()->get_id() << " \"";
if (c.get_name().find("rank-") != 0)
stream << c.get_name() << "\"";
else
stream << "rank-" << stoi(c.get_name().substr(5)) - 1 << "\"";
XBT_DEBUG("Dump %s", stream.str().c_str());
- tracing_file << stream.str() << std::endl;
+ tracing_file << stream.str() << '\n';
}
-static void on_container_destruction_paje(Container& c)
+static void on_container_destruction_paje(const Container& c)
{
- // obligation to dump previous events because they might reference the container that is about to be destroyed
- last_timestamp_to_dump = SIMIX_get_clock();
- dump_buffer(true);
-
// trace my destruction, but not if user requests so or if the container is root
if (not trace_disable_destroy && &c != Container::get_root()) {
std::stringstream stream;
- double timestamp = SIMIX_get_clock();
+ double timestamp = simgrid_get_clock();
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_DestroyContainer, timestamp);
+ XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, static_cast<unsigned>(PajeEventType::DestroyContainer),
+ timestamp);
- stream << std::fixed << std::setprecision(trace_precision) << PAJE_DestroyContainer << " ";
- stream << timestamp << " " << c.type_->get_id() << " " << c.get_id();
+ stream << std::fixed << std::setprecision(trace_precision) << PajeEventType::DestroyContainer << " ";
+ stream << timestamp << " " << c.get_type()->get_id() << " " << c.get_id();
XBT_DEBUG("Dump %s", stream.str().c_str());
- tracing_file << stream.str() << std::endl;
+ tracing_file << stream.str() << '\n';
}
}
-static void on_container_creation_ti(Container& c)
+static void on_container_creation_ti(const Container& c)
{
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_CreateContainer, SIMIX_get_clock());
+ XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, static_cast<unsigned>(PajeEventType::CreateContainer),
+ simgrid_get_clock());
// if we are in the mode with only one file
static std::ofstream* ti_unique_file = nullptr;
+ static double prefix = 0.0;
if (tracing_files.empty()) {
// generate unique run id with time
if (not simgrid::config::get_value<bool>("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
std::string folder_name = simgrid::config::get_value<std::string>("tracing/filename") + "_files";
std::string filename = folder_name + "/" + std::to_string(prefix) + "_" + c.get_name() + ".txt";
-#ifdef WIN32
- _mkdir(folder_name.c_str());
-#else
- mkdir(folder_name.c_str(), S_IRWXU | S_IRWXG | S_IRWXO);
-#endif
+ mkdir(folder_name.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
ti_unique_file = new std::ofstream(filename.c_str(), std::ofstream::out);
xbt_assert(not ti_unique_file->fail(), "Tracefile %s could not be opened for writing", filename.c_str());
- tracing_file << filename << std::endl;
+ tracing_file << filename << '\n';
}
tracing_files.insert({&c, ti_unique_file});
}
-static void on_container_destruction_ti(Container& c)
+static void on_container_destruction_ti(const Container& c)
{
- // obligation to dump previous events because they might reference the container that is about to be destroyed
- last_timestamp_to_dump = SIMIX_get_clock();
- dump_buffer(true);
-
if (not trace_disable_destroy && &c != Container::get_root()) {
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_DestroyContainer, SIMIX_get_clock());
if (not simgrid::config::get_value<bool>("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
tracing_files.at(&c)->close();
delete tracing_files.at(&c);
}
}
-static void on_entity_value_creation(EntityValue& value)
+static void on_entity_value_creation(const EntityValue& value)
{
std::stringstream stream;
- XBT_DEBUG("%s: event_type=%u", __func__, PAJE_DefineEntityValue);
- stream << std::fixed << std::setprecision(trace_precision) << PAJE_DefineEntityValue;
- stream << " " << value.get_id() << " " << value.get_father()->get_id() << " " << value.get_name();
+ XBT_DEBUG("%s: event_type=%u", __func__, static_cast<unsigned>(PajeEventType::DefineEntityValue));
+ stream << std::fixed << std::setprecision(trace_precision) << PajeEventType::DefineEntityValue;
+ stream << " " << value.get_id() << " " << value.get_parent()->get_id() << " " << value.get_name();
if (not value.get_color().empty())
stream << " \"" << value.get_color() << "\"";
XBT_DEBUG("Dump %s", stream.str().c_str());
- tracing_file << stream.str() << std::endl;
+ tracing_file << stream.str() << '\n';
+}
+
+static void on_event_creation(PajeEvent& event)
+{
+ XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, static_cast<unsigned>(event.eventType_), trace_precision,
+ event.timestamp_);
+ event.stream_ << std::fixed << std::setprecision(trace_precision);
+ event.stream_ << event.eventType_ << " " << event.timestamp_ << " ";
+ event.stream_ << event.get_type()->get_id() << " " << event.get_container()->get_id();
+}
+
+static void on_event_destruction(const PajeEvent& event)
+{
+ XBT_DEBUG("Dump %s", event.stream_.str().c_str());
+ tracing_file << event.stream_.str() << '\n';
+}
+
+static void on_state_event_destruction(const StateEvent& event)
+{
+ if (event.has_extra())
+ *tracing_files.at(event.get_container()) << event.stream_.str() << '\n';
}
-static void on_type_creation(Type& type, e_event_type event_type)
+static void on_type_creation(const Type& type, PajeEventType event_type)
{
- if (event_type == PAJE_DefineLinkType)
+ if (event_type == PajeEventType::DefineLinkType)
return; // this kind of type has to be handled differently
std::stringstream stream;
stream << std::fixed << std::setprecision(trace_precision);
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, event_type, trace_precision, 0.);
- stream << event_type << " " << type.get_id() << " " << type.get_father()->get_id() << " " << type.get_name();
+ XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, static_cast<unsigned>(event_type), trace_precision, 0.);
+ stream << event_type << " " << type.get_id() << " " << type.get_parent()->get_id() << " " << type.get_name();
if (type.is_colored())
stream << " \"" << type.get_color() << "\"";
XBT_DEBUG("Dump %s", stream.str().c_str());
- tracing_file << stream.str() << std::endl;
+ tracing_file << stream.str() << '\n';
}
-static void on_link_type_creation(Type& type, Type& source, Type& dest)
+static void on_link_type_creation(const Type& type, const Type& source, const Type& dest)
{
std::stringstream stream;
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, PAJE_DefineLinkType, trace_precision, 0.);
- stream << PAJE_DefineLinkType << " " << type.get_id() << " " << type.get_father()->get_id();
+ XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, static_cast<unsigned>(PajeEventType::DefineLinkType),
+ trace_precision, 0.);
+ stream << PajeEventType::DefineLinkType << " " << type.get_id() << " " << type.get_parent()->get_id();
stream << " " << source.get_id() << " " << dest.get_id() << " " << type.get_name();
XBT_DEBUG("Dump %s", stream.str().c_str());
- tracing_file << stream.str() << std::endl;
+ tracing_file << stream.str() << '\n';
}
static void on_simulation_start()
XBT_DEBUG("Filename %s is open for writing", filename.c_str());
if (format == "Paje") {
- Container::on_creation.connect(on_container_creation_paje);
- Container::on_destruction.connect(on_container_destruction_paje);
- EntityValue::on_creation.connect(on_entity_value_creation);
- Type::on_creation.connect(on_type_creation);
- LinkType::on_creation.connect(on_link_type_creation);
+ Container::on_creation_cb(on_container_creation_paje);
+ Container::on_destruction_cb(on_container_destruction_paje);
+ EntityValue::on_creation_cb(on_entity_value_creation);
+ Type::on_creation_cb(on_type_creation);
+ LinkType::on_creation_cb(on_link_type_creation);
+ PajeEvent::on_creation_cb(on_event_creation);
+ PajeEvent::on_destruction_cb(on_event_destruction);
paje::dump_generator_version();
/* output one line comment */
- std::string comment = simgrid::config::get_value<std::string>("tracing/comment");
- if (not comment.empty())
- tracing_file << "# " << comment << std::endl;
+ if (auto comment = simgrid::config::get_value<std::string>("tracing/comment"); not comment.empty())
+ tracing_file << "# " << comment << '\n';
/* output comment file */
paje::dump_comment_file(config::get_value<std::string>(OPT_TRACING_COMMENT_FILE));
paje::dump_header(trace_basic, TRACE_display_sizes());
} else {
trace_format = TraceFormat::Ti;
- Container::on_creation.connect(on_container_creation_ti);
- Container::on_destruction.connect(on_container_destruction_ti);
+ Container::on_creation_cb(on_container_creation_ti);
+ Container::on_destruction_cb(on_container_destruction_ti);
+ StateEvent::on_destruction_cb(on_state_event_destruction);
}
trace_active = true;
return;
/* dump trace buffer */
- last_timestamp_to_dump = surf_get_clock();
+ last_timestamp_to_dump = simgrid_get_clock();
dump_buffer(true);
- const Type* root_type = Container::get_root()->type_;
+ const Type* root_type = Container::get_root()->get_type();
/* destroy all data structures of tracing (and free) */
delete Container::get_root();
delete root_type;
config::declare_flag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
"(smpi only) For replay format only : output to one file only", false);
- config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"});
config::declare_flag<std::string>("tracing/comment", "Add a comment line to the top of the trace file.", "");
config::declare_flag<std::string>(OPT_TRACING_COMMENT_FILE,
"Add the contents of a file as comments to the top of the trace.", "");
- config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"});
config::declare_flag<int>("tracing/precision",
"Numerical precision used when timestamping events "
"(expressed in number of digits after decimal point)",
6);
/* Connect Engine callbacks */
- s4u::Engine::on_platform_creation.connect(on_simulation_start);
- s4u::Engine::on_time_advance.connect([](double /*time_delta*/) { dump_buffer(false); });
- s4u::Engine::on_deadlock.connect(on_simulation_end);
- s4u::Engine::on_simulation_end.connect(on_simulation_end);
+ s4u::Engine::on_platform_creation_cb(on_simulation_start);
+ s4u::Engine::on_time_advance_cb([](double /*time_delta*/) { dump_buffer(false); });
+ s4u::Engine::on_deadlock_cb(on_simulation_end);
+ s4u::Engine::on_simulation_end_cb(on_simulation_end);
}
-} // namespace instr
-} // namespace simgrid
+} // namespace simgrid::instr
