X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e30d391831c58e590aa83dce5f30f218cc3f53ce..0771f85280226b17c5326e36e6e8bc1b3d0f3e09:/src/instr/instr_config.cpp diff --git a/src/instr/instr_config.cpp b/src/instr/instr_config.cpp index 5726f1fbea..b165ff12de 100644 --- a/src/instr/instr_config.cpp +++ b/src/instr/instr_config.cpp @@ -4,14 +4,19 @@ * under the terms of the license (GNU LGPL) which comes with this package. */ #include "include/xbt/config.hpp" +#include "simgrid/s4u/Engine.hpp" #include "src/instr/instr_private.hpp" #include "surf/surf.hpp" +#include "xbt/virtu.h" /* sg_cmdline */ +#include #include #include XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)"); XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration"); +std::ofstream tracing_file; + #define OPT_TRACING_BASIC "tracing/basic" #define OPT_TRACING_BUFFER "tracing/buffer" #define OPT_TRACING_CATEGORIZED "tracing/categorized" @@ -21,137 +26,139 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration"); #define OPT_TRACING_DISABLE_LINK "tracing/disable-link" #define OPT_TRACING_DISABLE_POWER "tracing/disable-power" #define OPT_TRACING_DISPLAY_SIZES "tracing/smpi/display-sizes" -#define OPT_TRACING_FILENAME "tracing/filename" #define OPT_TRACING_FORMAT_TI_ONEFILE "tracing/smpi/format/ti-one-file" -#define OPT_TRACING_FORMAT "tracing/smpi/format" -#define OPT_TRACING_ACTOR "tracing/msg/process" -#define OPT_TRACING_VM "tracing/vm" #define OPT_TRACING_PLATFORM "tracing/platform" -#define OPT_TRACING_PRECISION "tracing/precision" #define OPT_TRACING_SMPI_COMPUTING "tracing/smpi/computing" #define OPT_TRACING_SMPI_GROUP "tracing/smpi/group" #define OPT_TRACING_SMPI_INTERNALS "tracing/smpi/internals" #define OPT_TRACING_SMPI_SLEEPING "tracing/smpi/sleeping" #define OPT_TRACING_SMPI "tracing/smpi" #define OPT_TRACING_TOPOLOGY "tracing/platform/topology" -#define OPT_TRACING "tracing" #define OPT_TRACING_UNCATEGORIZED "tracing/uncategorized" -static bool trace_enabled = false; -static bool trace_platform; -static bool trace_platform_topology; -static bool trace_smpi_enabled; -static bool trace_smpi_grouped; -static bool trace_smpi_computing; -static bool trace_smpi_sleeping; -static bool trace_view_internals; -static bool trace_categorized; -static bool trace_uncategorized; -static bool trace_actor_enabled; -static bool trace_vm_enabled; -static bool trace_buffer; -static bool trace_disable_destroy; -static bool trace_basic; -static bool trace_display_sizes = false; -static bool trace_disable_link; -static bool trace_disable_power; - -static bool trace_configured = false; +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 + "Trace the behavior of all categorized actors, grouping them by host.\n" + "Can be used to track actor location if the simulator does actor migration.", + false}; + +static simgrid::config::Flag trace_vm_enabled{"tracing/vm", "Trace the behavior of all virtual machines.", false}; + +static simgrid::config::Flag trace_platform{OPT_TRACING_PLATFORM, + "Register the platform in the trace as a hierarchy.", false}; +static simgrid::config::Flag trace_platform_topology{ + OPT_TRACING_TOPOLOGY, "Register the platform topology in the trace as a graph.", true}; +static simgrid::config::Flag trace_smpi_enabled{OPT_TRACING_SMPI, "Tracing of the SMPI interface.", false}; +static simgrid::config::Flag trace_smpi_grouped{OPT_TRACING_SMPI_GROUP, "Group MPI processes by host.", false}; +static simgrid::config::Flag trace_smpi_computing{ + OPT_TRACING_SMPI_COMPUTING, "Generate states for timing out of SMPI parts of the application", false}; +static simgrid::config::Flag trace_smpi_sleeping{ + OPT_TRACING_SMPI_SLEEPING, "Generate states for timing out of SMPI parts of the application", false}; +static simgrid::config::Flag trace_view_internals{ + OPT_TRACING_SMPI_INTERNALS, "View internal messages sent by Collective communications in SMPI", false}; +static simgrid::config::Flag trace_categorized{ + OPT_TRACING_CATEGORIZED, "Tracing categorized resource utilization of hosts and links.", false}; +static simgrid::config::Flag trace_uncategorized{ + OPT_TRACING_UNCATEGORIZED, "Tracing uncategorized resource utilization of hosts and links.", false}; +static simgrid::config::Flag trace_buffer{OPT_TRACING_BUFFER, + "Buffer trace events to put them in temporal order.", true}; +static simgrid::config::Flag trace_disable_destroy{ + OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false}; +static simgrid::config::Flag trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).", + false}; +static simgrid::config::Flag trace_display_sizes{OPT_TRACING_DISPLAY_SIZES, + {"tracing/smpi/display_sizes"}, + "(smpi only) Extended events with message size information", + false}; +static simgrid::config::Flag trace_disable_link{ + OPT_TRACING_DISABLE_LINK, {"tracing/disable_link"}, "Do not trace link bandwidth and latency.", false}; +static simgrid::config::Flag trace_disable_power{ + OPT_TRACING_DISABLE_POWER, {"tracing/disable_power"}, "Do not trace host power.", false}; + static bool trace_active = false; simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje; -static void TRACE_getopts() -{ - trace_enabled = xbt_cfg_get_boolean(OPT_TRACING); - trace_platform = xbt_cfg_get_boolean(OPT_TRACING_PLATFORM); - trace_platform_topology = xbt_cfg_get_boolean(OPT_TRACING_TOPOLOGY); - trace_smpi_enabled = xbt_cfg_get_boolean(OPT_TRACING_SMPI); - trace_smpi_grouped = xbt_cfg_get_boolean(OPT_TRACING_SMPI_GROUP); - trace_smpi_computing = xbt_cfg_get_boolean(OPT_TRACING_SMPI_COMPUTING); - trace_smpi_sleeping = xbt_cfg_get_boolean(OPT_TRACING_SMPI_SLEEPING); - trace_view_internals = xbt_cfg_get_boolean(OPT_TRACING_SMPI_INTERNALS); - trace_categorized = xbt_cfg_get_boolean(OPT_TRACING_CATEGORIZED); - trace_uncategorized = xbt_cfg_get_boolean(OPT_TRACING_UNCATEGORIZED); - trace_actor_enabled = trace_enabled && xbt_cfg_get_boolean(OPT_TRACING_ACTOR); - trace_vm_enabled = xbt_cfg_get_boolean(OPT_TRACING_VM); - trace_buffer = xbt_cfg_get_boolean(OPT_TRACING_BUFFER); - trace_disable_destroy = xbt_cfg_get_boolean(OPT_TRACING_DISABLE_DESTROY); - trace_basic = xbt_cfg_get_boolean(OPT_TRACING_BASIC); - trace_display_sizes = xbt_cfg_get_boolean(OPT_TRACING_DISPLAY_SIZES); - trace_disable_link = xbt_cfg_get_boolean(OPT_TRACING_DISABLE_LINK); - trace_disable_power = xbt_cfg_get_boolean(OPT_TRACING_DISABLE_POWER); -} - -int TRACE_start() +static void TRACE_start() { - if (TRACE_is_configured()) - TRACE_getopts(); + if (trace_active) + return; // tracing system must be: // - enabled (with --cfg=tracing:yes) // - already configured (TRACE_global_init already called) if (TRACE_is_enabled()) { + instr_define_callbacks(); XBT_DEBUG("Tracing starts"); /* init the tracing module to generate the right output */ + std::string format = simgrid::config::get_value("tracing/smpi/format"); + XBT_DEBUG("Tracing format %s", format.c_str()); /* open the trace file(s) */ - std::string format = xbt_cfg_get_string(OPT_TRACING_FORMAT); - XBT_DEBUG("Tracing format %s\n", format.c_str()); - if (format == "Paje") { - TRACE_paje_start(); - } else if (format == "TI") { - simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti; - TRACE_TI_start(); - }else{ - xbt_die("Unknown trace format :%s ", format.c_str()); + std::string filename = TRACE_get_filename(); + tracing_file.open(filename.c_str(), std::ofstream::out); + if (tracing_file.fail()) { + THROWF(system_error, 1, "Tracefile %s could not be opened for writing.", filename.c_str()); } - /* activate trace */ - if (trace_active) { - THROWF(tracing_error, 0, "Tracing is already active"); + 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 << "#["; + unsigned int cpt; + char* str; + xbt_dynar_foreach (xbt_cmdline, cpt, str) { + tracing_file << str << " "; + } + tracing_file << "]" << std::endl; } + + /* output one line comment */ + dump_comment(simgrid::config::get_value(OPT_TRACING_COMMENT)); + + /* output comment file */ + dump_comment_file(simgrid::config::get_value(OPT_TRACING_COMMENT_FILE)); + + if (format == "Paje") { + /* output Pajé header */ + TRACE_header(TRACE_basic(), TRACE_display_sizes()); + } else + simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti; + trace_active = true; XBT_DEBUG("Tracing is on"); } - return 0; } -int TRACE_end() +static void TRACE_end() { - int retval; - if (not trace_active) { - retval = 1; - } else { - retval = 0; - - /* dump trace buffer */ - TRACE_last_timestamp_to_dump = surf_get_clock(); - TRACE_paje_dump_buffer(true); - - simgrid::instr::Type* root_type = simgrid::instr::Container::getRoot()->type_; - /* destroy all data structures of tracing (and free) */ - delete simgrid::instr::Container::getRoot(); - delete root_type; - - /* close the trace files */ - std::string format = xbt_cfg_get_string(OPT_TRACING_FORMAT); - XBT_DEBUG("Tracing format %s\n", format.c_str()); - if (format == "Paje") { - TRACE_paje_end(); - } else if (format == "TI") { - TRACE_TI_end(); - }else{ - xbt_die("Unknown trace format :%s ", format.c_str()); - } + if (not trace_active) + return; - /* de-activate trace */ - trace_active = false; - XBT_DEBUG("Tracing is off"); - XBT_DEBUG("Tracing system is shutdown"); - } - return retval; + /* dump trace buffer */ + TRACE_last_timestamp_to_dump = surf_get_clock(); + TRACE_paje_dump_buffer(true); + + simgrid::instr::Type* root_type = simgrid::instr::Container::get_root()->type_; + /* destroy all data structures of tracing (and free) */ + delete simgrid::instr::Container::get_root(); + delete root_type; + + /* close the trace files */ + tracing_file.close(); + XBT_DEBUG("Filename %s is closed", TRACE_get_filename().c_str()); + + /* de-activate trace */ + trace_active = false; + XBT_DEBUG("Tracing is off"); + XBT_DEBUG("Tracing system is shutdown"); } bool TRACE_needs_platform () @@ -175,11 +182,6 @@ bool TRACE_platform_topology() return trace_platform_topology; } -bool TRACE_is_configured() -{ - return trace_configured; -} - bool TRACE_smpi_is_enabled() { return (trace_smpi_enabled || TRACE_smpi_is_grouped()) && TRACE_is_enabled(); @@ -217,62 +219,52 @@ bool TRACE_uncategorized () bool TRACE_actor_is_enabled() { - return trace_actor_enabled; + return trace_actor_enabled && trace_enabled; } bool TRACE_vm_is_enabled() { - return trace_vm_enabled && TRACE_is_enabled(); + return trace_vm_enabled && trace_enabled; } bool TRACE_disable_link() { - return trace_disable_link && TRACE_is_enabled(); + return trace_disable_link && trace_enabled; } bool TRACE_disable_speed() { - return trace_disable_power && TRACE_is_enabled(); + return trace_disable_power && trace_enabled; } bool TRACE_buffer () { - return trace_buffer && TRACE_is_enabled(); + return trace_buffer && trace_enabled; } bool TRACE_disable_destroy () { - return trace_disable_destroy && TRACE_is_enabled(); + return trace_disable_destroy && trace_enabled; } bool TRACE_basic () { - return trace_basic && TRACE_is_enabled(); + return trace_basic && trace_enabled; } bool TRACE_display_sizes () { - return trace_display_sizes && trace_smpi_enabled && TRACE_is_enabled(); -} - -std::string TRACE_get_comment() -{ - return xbt_cfg_get_string(OPT_TRACING_COMMENT); -} - -std::string TRACE_get_comment_file() -{ - return xbt_cfg_get_string(OPT_TRACING_COMMENT_FILE); + return trace_display_sizes && trace_smpi_enabled && trace_enabled; } int TRACE_precision () { - return xbt_cfg_get_int(OPT_TRACING_PRECISION); + return simgrid::config::get_value("tracing/precision"); } std::string TRACE_get_filename() { - return xbt_cfg_get_string(OPT_TRACING_FILENAME); + return simgrid::config::get_value("tracing/filename"); } void TRACE_global_init() @@ -282,45 +274,31 @@ void TRACE_global_init() return; is_initialised = true; + /* name of the tracefile */ - xbt_cfg_register_string (OPT_TRACING_FILENAME, "simgrid.trace", nullptr, "Trace file created by the instrumented SimGrid."); - xbt_cfg_register_boolean(OPT_TRACING, "no", nullptr, "Enable Tracing."); - xbt_cfg_register_boolean(OPT_TRACING_PLATFORM, "no", nullptr, "Register the platform in the trace as a hierarchy."); - xbt_cfg_register_boolean(OPT_TRACING_TOPOLOGY, "yes", nullptr, "Register the platform topology in the trace as a graph."); - xbt_cfg_register_boolean(OPT_TRACING_SMPI, "no", nullptr, "Tracing of the SMPI interface."); - xbt_cfg_register_boolean(OPT_TRACING_SMPI_GROUP,"no", nullptr, "Group MPI processes by host."); - xbt_cfg_register_boolean(OPT_TRACING_SMPI_COMPUTING, "no", nullptr, "Generate states for timing out of SMPI parts of the application"); - xbt_cfg_register_boolean(OPT_TRACING_SMPI_SLEEPING, "no", nullptr, "Generate states for timing out of SMPI parts of the application"); - xbt_cfg_register_boolean(OPT_TRACING_SMPI_INTERNALS, "no", nullptr, "View internal messages sent by Collective communications in SMPI"); - xbt_cfg_register_boolean(OPT_TRACING_CATEGORIZED, "no", nullptr, "Tracing categorized resource utilization of hosts and links."); - xbt_cfg_register_boolean(OPT_TRACING_UNCATEGORIZED, "no", nullptr, "Tracing uncategorized resource utilization of hosts and links."); - - xbt_cfg_register_boolean(OPT_TRACING_ACTOR, "no", nullptr, "Tracing of actor behavior."); - xbt_cfg_register_boolean(OPT_TRACING_VM, "no", nullptr, "Tracing of virtual machine behavior."); - xbt_cfg_register_boolean(OPT_TRACING_DISABLE_LINK, "no", nullptr, "Do not trace link bandwidth and latency."); - xbt_cfg_register_boolean(OPT_TRACING_DISABLE_POWER, "no", nullptr, "Do not trace host power."); - xbt_cfg_register_boolean(OPT_TRACING_BUFFER, "yes", nullptr, "Buffer trace events to put them in temporal order."); - - xbt_cfg_register_boolean(OPT_TRACING_DISABLE_DESTROY, "no", nullptr, "Disable platform containers destruction."); - xbt_cfg_register_boolean(OPT_TRACING_BASIC, "no", nullptr, "Avoid extended events (impoverished trace file)."); - xbt_cfg_register_boolean(OPT_TRACING_DISPLAY_SIZES, "no", nullptr, "(smpi only) Extended events with message size information"); - xbt_cfg_register_string(OPT_TRACING_FORMAT, "Paje", nullptr, "(smpi only) Switch the output format of Tracing"); - xbt_cfg_register_boolean(OPT_TRACING_FORMAT_TI_ONEFILE, "no", nullptr, "(smpi only) For replay format only : output to one file only"); - xbt_cfg_register_string(OPT_TRACING_COMMENT, "", nullptr, "Comment to be added on the top of the trace file."); - xbt_cfg_register_string(OPT_TRACING_COMMENT_FILE, "", nullptr, - "The contents of the file are added to the top of the trace file as comment."); - xbt_cfg_register_int(OPT_TRACING_PRECISION, 6, nullptr, "Numerical precision used when timestamping events " - "(expressed in number of digits after decimal point)"); - - xbt_cfg_register_alias(OPT_TRACING_COMMENT_FILE,"tracing/comment_file"); - xbt_cfg_register_alias(OPT_TRACING_DISABLE_DESTROY, "tracing/disable_destroy"); - xbt_cfg_register_alias(OPT_TRACING_DISABLE_LINK, "tracing/disable_link"); - xbt_cfg_register_alias(OPT_TRACING_DISABLE_POWER, "tracing/disable_power"); - xbt_cfg_register_alias(OPT_TRACING_DISPLAY_SIZES, "tracing/smpi/display_sizes"); - xbt_cfg_register_alias(OPT_TRACING_FORMAT_TI_ONEFILE, "tracing/smpi/format/ti_one_file"); - - /* instrumentation can be considered configured now */ - trace_configured = true; + simgrid::config::declare_flag("tracing/filename", "Trace file created by the instrumented SimGrid.", + "simgrid.trace"); + simgrid::config::declare_flag( + "tracing/smpi/format", "Select trace output format used by SMPI. The default is the 'Paje' format.\n" + "The 'TI' (Time-Independent) format allows for trace replay.", + "Paje"); + + simgrid::config::declare_flag(OPT_TRACING_FORMAT_TI_ONEFILE, + "(smpi only) For replay format only : output to one file only", false); + simgrid::config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"}); + simgrid::config::declare_flag(OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.", + ""); + simgrid::config::declare_flag( + OPT_TRACING_COMMENT_FILE, "The contents of the file are added to the top of the trace file as comment.", ""); + simgrid::config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"}); + simgrid::config::declare_flag("tracing/precision", "Numerical precision used when timestamping events " + "(expressed in number of digits after decimal point)", + 6); + + /* Connect callbacks */ + simgrid::s4u::on_platform_creation.connect(TRACE_start); + simgrid::s4u::on_deadlock.connect(TRACE_end); + simgrid::s4u::on_simulation_end.connect(TRACE_end); } static void print_line (const char *option, const char *desc, const char *longdesc, int detailed) @@ -337,9 +315,6 @@ static void print_line (const char *option, const char *desc, const char *longde void TRACE_help (int detailed) { printf("Description of the tracing options accepted by this simulator:\n\n"); - print_line (OPT_TRACING, "Enable the tracing system", - " It activates the tracing system and register the simulation platform\n" - " in the trace file. You have to enable this option to others take effect.", detailed); print_line (OPT_TRACING_CATEGORIZED, "Trace categorized resource utilization", " It activates the categorized resource utilization tracing. It should\n" " be enabled if tracing categories are used by this simulator.", detailed); @@ -347,13 +322,6 @@ void TRACE_help (int detailed) " It activates the uncategorized resource utilization tracing. Use it if\n" " this simulator do not use tracing categories and resource use have to be\n" " traced.", detailed); - print_line(OPT_TRACING_FILENAME, "Filename to register traces", - " A file with this name will be created to register the simulation. The file\n" - " is in the Paje format and can be analyzed using Paje, and PajeNG visualization\n" - " tools. More information can be found in these webpages:\n" - " http://github.com/schnorr/pajeng/\n" - " http://paje.sourceforge.net/", - detailed); print_line (OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)", " This option only has effect if this simulator is SMPI-based. Traces the MPI\n" " interface and generates a trace that can be analyzed using Gantt-like\n" @@ -370,11 +338,6 @@ void TRACE_help (int detailed) " to allow further study of simulated or real sleep time", detailed); print_line (OPT_TRACING_SMPI_INTERNALS, "Generates tracing events corresponding", " to point-to-point messages sent by collective communications", detailed); - print_line(OPT_TRACING_ACTOR, "Trace actor behavior", - " This option traces the behavior of all categorized actors, grouping them\n" - " by hosts. This option can be used to track actor location if the simulator\n" - " does actor migration.", - detailed); print_line (OPT_TRACING_BUFFER, "Buffer events to put them in temporal order", " This option put some events in a time-ordered buffer using the insertion\n" " sort algorithm. The process of acquiring and releasing locks to access this\n" @@ -394,9 +357,6 @@ void TRACE_help (int detailed) " Message size (in bytes) is added to links, and to states. For collectives,\n" " the displayed value is the more relevant to the collective (total sent by\n" " the process, usually)", detailed); - print_line (OPT_TRACING_FORMAT, "Only works for SMPI now. Switch output format", - " Default format is Paje. Time independent traces are also supported,\n" - " to output traces that can later be used by the trace replay tool", detailed); print_line (OPT_TRACING_FORMAT_TI_ONEFILE, "Only works for SMPI now, and TI output format", " By default, each process outputs to a separate file, inside a filename_files folder\n" " By setting this option to yes, all processes will output to only one file\n"