X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6570fa4001065f73218c9869364aba76b91de04e..48296e83ce3ba1fa3658a3a74d10a536e33b3849:/src/instr/instr_config.cpp diff --git a/src/instr/instr_config.cpp b/src/instr/instr_config.cpp index 17faca1e30..cec90b8be2 100644 --- a/src/instr/instr_config.cpp +++ b/src/instr/instr_config.cpp @@ -1,15 +1,19 @@ -/* Copyright (c) 2010-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2010-2022. 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 +#include + #include "src/instr/instr_private.hpp" -#include "surf/surf.hpp" -#include "xbt/virtu.h" /* xbt::cmdline */ +#include "xbt/config.hpp" +#include "xbt/xbt_os_time.h" + +#include +#ifdef WIN32 +#include // _mkdir +#endif #include #include @@ -19,6 +23,7 @@ XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used fo XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration"); std::ofstream tracing_file; +std::map tracing_files; // TI specific constexpr char OPT_TRACING_BASIC[] = "tracing/basic"; constexpr char OPT_TRACING_COMMENT_FILE[] = "tracing/comment-file"; @@ -31,7 +36,7 @@ static simgrid::config::Flag trace_enabled{ "tracing", "Enable the tracing system. You have to enable this option to use other tracing options.", false}; static simgrid::config::Flag 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}; @@ -66,8 +71,8 @@ static simgrid::config::Flag trace_uncategorized{ "To use if the simulator does not use tracing categories but resource utilization have to be traced.", false}; -static simgrid::config::Flag trace_disable_destroy{ - OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false}; +static simgrid::config::Flag trace_disable_destroy{OPT_TRACING_DISABLE_DESTROY, + "Disable platform containers destruction.", false}; static simgrid::config::Flag trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).", false}; @@ -81,8 +86,6 @@ static simgrid::config::Flag trace_disable_link{"tracing/disable_link", "Do not trace link bandwidth and latency.", false}; static simgrid::config::Flag trace_disable_power{"tracing/disable_power", "Do not trace host power.", false}; -simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje; - bool TRACE_needs_platform () { return TRACE_actor_is_enabled() || TRACE_vm_is_enabled() || TRACE_categorized() || TRACE_uncategorized() || @@ -159,36 +162,16 @@ bool TRACE_disable_speed() return trace_disable_power && trace_enabled; } -bool TRACE_disable_destroy () -{ - return trace_disable_destroy && trace_enabled; -} - -bool TRACE_basic () -{ - return trace_basic && trace_enabled; -} - bool TRACE_display_sizes () { return trace_display_sizes && trace_smpi_enabled && trace_enabled; } -int TRACE_precision () -{ - return simgrid::config::get_value("tracing/precision"); -} - -std::string TRACE_get_filename() -{ - return simgrid::config::get_value("tracing/filename"); -} - static void print_line(const char* option, const char* desc, const char* longdesc) { std::string str = std::string("--cfg=") + option + " "; - int len = str.size(); + int len = static_cast(str.size()); XBT_HELP("%s%*.*s %s", str.c_str(), 30 - len, 30 - len, "", desc); if (longdesc != nullptr) { XBT_HELP("%s\n", longdesc); @@ -223,66 +206,209 @@ void TRACE_help() " 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; + +/************* + * Callbacks * + *************/ +xbt::signal Container::on_creation; +xbt::signal Container::on_destruction; +xbt::signal Type::on_creation; +xbt::signal LinkType::on_creation; +xbt::signal PajeEvent::on_creation; +xbt::signal PajeEvent::on_destruction; +xbt::signal StateEvent::on_destruction; +xbt::signal EntityValue::on_creation; + +static void on_container_creation_paje(const Container& c) +{ + double timestamp = simgrid_get_clock(); + std::stringstream stream; + + XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, static_cast(PajeEventType::CreateContainer), + timestamp); + + 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 + /* Subtract -1 because this is the process id and we transform it to the rank id */ + stream << "rank-" << stoi(c.get_name().substr(5)) - 1 << "\""; + + XBT_DEBUG("Dump %s", stream.str().c_str()); + tracing_file << stream.str() << '\n'; +} + +static void on_container_destruction_paje(const Container& c) +{ + // 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 = simgrid_get_clock(); + + XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, static_cast(PajeEventType::DestroyContainer), + timestamp); + + 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() << '\n'; + } +} + +static void on_container_creation_ti(const Container& c) +{ + XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, static_cast(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 + prefix = xbt_os_time(); + } + + if (not simgrid::config::get_value("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) { + std::string folder_name = simgrid::config::get_value("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_IROTH | S_IXOTH); +#endif + 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 << '\n'; + } + tracing_files.insert({&c, ti_unique_file}); +} + +static void on_container_destruction_ti(const Container& c) +{ + if (not trace_disable_destroy && &c != Container::get_root()) { + if (not simgrid::config::get_value("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) { + tracing_files.at(&c)->close(); + delete tracing_files.at(&c); + } + tracing_files.erase(&c); + } +} + +static void on_entity_value_creation(const EntityValue& value) +{ + std::stringstream stream; + XBT_DEBUG("%s: event_type=%u", __func__, static_cast(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() << '\n'; +} + +static void on_event_creation(PajeEvent& event) +{ + XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, static_cast(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(const Type& type, PajeEventType event_type) +{ + 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__, static_cast(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() << '\n'; +} + +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__, static_cast(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() << '\n'; +} static void on_simulation_start() { - if (trace_active) + if (trace_active || not TRACE_is_enabled()) return; - // tracing system must be: - // - enabled (with --cfg=tracing:yes) - // - already configured (simgrid::instr::init already called) - if (TRACE_is_enabled()) { - define_callbacks(); + define_callbacks(); - XBT_DEBUG("Tracing starts"); + XBT_DEBUG("Tracing starts"); + trace_precision = config::get_value("tracing/precision"); - /* init the tracing module to generate the right output */ - std::string format = config::get_value("tracing/smpi/format"); - XBT_DEBUG("Tracing format %s", format.c_str()); + /* init the tracing module to generate the right output */ + std::string format = config::get_value("tracing/smpi/format"); + XBT_DEBUG("Tracing format %s", format.c_str()); - /* open the trace file(s) */ - std::string filename = TRACE_get_filename(); - tracing_file.open(filename.c_str(), std::ofstream::out); - if (tracing_file.fail()) { - throw TracingError(XBT_THROW_POINT, - xbt::string_printf("Tracefile %s could not be opened for writing.", filename.c_str())); - } + /* open the trace file(s) */ + std::string filename = simgrid::config::get_value("tracing/filename"); + tracing_file.open(filename.c_str(), std::ofstream::out); + if (tracing_file.fail()) { + throw TracingError(XBT_THROW_POINT, + xbt::string_printf("Tracefile %s could not be opened for writing.", filename.c_str())); + } - XBT_DEBUG("Filename %s is open for writing", filename.c_str()); - - if (format == "Paje") { - /* output generator version */ - tracing_file << "#This file was generated using SimGrid-" << SIMGRID_VERSION_MAJOR << "." << SIMGRID_VERSION_MINOR - << "." << SIMGRID_VERSION_PATCH << std::endl; - tracing_file << "#["; - for (auto str : simgrid::xbt::cmdline) { - tracing_file << str << " "; - } - tracing_file << "]" << std::endl; - } + XBT_DEBUG("Filename %s is open for writing", filename.c_str()); - /* output one line comment */ - std::string comment = simgrid::config::get_value("tracing/comment"); - if (not comment.empty()) - tracing_file << "# " << comment << std::endl; + if (format == "Paje") { + 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); - /* output comment file */ - dump_comment_file(simgrid::config::get_value(OPT_TRACING_COMMENT_FILE)); + paje::dump_generator_version(); - if (format == "Paje") { - /* output Pajé header */ - TRACE_header(TRACE_basic(), TRACE_display_sizes()); - } else - trace_format = TraceFormat::Ti; + /* output one line comment */ + if (auto comment = simgrid::config::get_value("tracing/comment"); not comment.empty()) + tracing_file << "# " << comment << '\n'; - trace_active = true; - XBT_DEBUG("Tracing is on"); + /* output comment file */ + paje::dump_comment_file(config::get_value(OPT_TRACING_COMMENT_FILE)); + paje::dump_header(trace_basic, TRACE_display_sizes()); + } else { + trace_format = TraceFormat::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; + XBT_DEBUG("Tracing is on"); } static void on_simulation_end() @@ -291,17 +417,17 @@ static void on_simulation_end() return; /* dump trace buffer */ - TRACE_last_timestamp_to_dump = surf_get_clock(); - TRACE_paje_dump_buffer(true); + 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; /* close the trace files */ tracing_file.close(); - XBT_DEBUG("Filename %s is closed", TRACE_get_filename().c_str()); + XBT_DEBUG("Filename %s is closed", config::get_value("tracing/filename").c_str()); /* de-activate trace */ trace_active = false; @@ -327,20 +453,18 @@ void init() config::declare_flag(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("tracing/comment", "Add a comment line to the top of the trace file.", ""); config::declare_flag(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("tracing/precision", "Numerical precision used when timestamping events " "(expressed in number of digits after decimal point)", 6); - /* Connect callbacks */ - s4u::Engine::on_platform_creation.connect(on_simulation_start); - s4u::Engine::on_deadlock.connect(on_simulation_end); - s4u::Engine::on_simulation_end.connect(on_simulation_end); + /* Connect Engine callbacks */ + 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