-/* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2010-2018. 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/s4u/Engine.hpp"
#include "src/instr/instr_private.hpp"
#include "surf/surf.hpp"
#include <string>
#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_MSG_PROCESS "tracing/msg/process"
-#define OPT_TRACING_MSG_VM "tracing/msg/vm"
-#define OPT_TRACING_ONELINK_ONLY "tracing/onelink-only"
+#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 "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_msg_process_enabled;
-static bool trace_msg_vm_enabled;
-static bool trace_buffer;
-static bool trace_onelink_only;
-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 int trace_precision;
-
-static bool trace_configured = false;
-static bool trace_active = false;
+static simgrid::config::Flag<bool> trace_enabled{OPT_TRACING, "Enable Tracing.", false};
+static simgrid::config::Flag<bool> trace_platform{OPT_TRACING_PLATFORM,
+ "Register the platform in the trace as a hierarchy.", false};
+static simgrid::config::Flag<bool> trace_platform_topology{
+ OPT_TRACING_TOPOLOGY, "Register the platform topology in the trace as a graph.", true};
+static simgrid::config::Flag<bool> trace_smpi_enabled{OPT_TRACING_SMPI, "Tracing of the SMPI interface.", false};
+static simgrid::config::Flag<bool> trace_smpi_grouped{OPT_TRACING_SMPI_GROUP, "Group MPI processes by host.", false};
+static simgrid::config::Flag<bool> trace_smpi_computing{
+ OPT_TRACING_SMPI_COMPUTING, "Generate states for timing out of SMPI parts of the application", false};
+static simgrid::config::Flag<bool> trace_smpi_sleeping{
+ OPT_TRACING_SMPI_SLEEPING, "Generate states for timing out of SMPI parts of the application", false};
+static simgrid::config::Flag<bool> trace_view_internals{
+ OPT_TRACING_SMPI_INTERNALS, "View internal messages sent by Collective communications in SMPI", false};
+static simgrid::config::Flag<bool> trace_categorized{
+ OPT_TRACING_CATEGORIZED, "Tracing categorized resource utilization of hosts and links.", false};
+static simgrid::config::Flag<bool> trace_uncategorized{
+ OPT_TRACING_UNCATEGORIZED, "Tracing uncategorized resource utilization of hosts and links.", false};
+static simgrid::config::Flag<bool> trace_actor_enabled{OPT_TRACING_ACTOR, "Tracing of actor behavior.", false};
+static simgrid::config::Flag<bool> trace_vm_enabled{OPT_TRACING_VM, "Tracing of virtual machine behavior.", false};
+static simgrid::config::Flag<bool> trace_buffer{OPT_TRACING_BUFFER,
+ "Buffer trace events to put them in temporal order.", true};
+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_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
+ false};
+static simgrid::config::Flag<bool> trace_display_sizes{OPT_TRACING_DISPLAY_SIZES,
+ {"tracing/smpi/display_sizes"},
+ "(smpi only) Extended events with message size information",
+ false};
+static simgrid::config::Flag<bool> trace_disable_link{
+ OPT_TRACING_DISABLE_LINK, {"tracing/disable_link"}, "Do not trace link bandwidth and latency.", false};
+static simgrid::config::Flag<bool> trace_disable_power{
+ OPT_TRACING_DISABLE_POWER, {"tracing/disable_power"}, "Do not trace host power.", false};
-instr_fmt_type_t instr_fmt_type = instr_fmt_paje;
+static bool trace_active = false;
-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_msg_process_enabled = xbt_cfg_get_boolean(OPT_TRACING_MSG_PROCESS);
- trace_msg_vm_enabled = xbt_cfg_get_boolean(OPT_TRACING_MSG_VM);
- trace_buffer = xbt_cfg_get_boolean(OPT_TRACING_BUFFER);
- trace_onelink_only = xbt_cfg_get_boolean(OPT_TRACING_ONELINK_ONLY);
- 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);
- trace_precision = xbt_cfg_get_int(OPT_TRACING_PRECISION);
-}
+simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje;
-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 */
/* open the trace file(s) */
- std::string format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
- XBT_DEBUG("Tracing format %s\n", format.c_str());
+ std::string format = simgrid::config::get_value<std::string>(OPT_TRACING_FORMAT);
+ XBT_DEBUG("Tracing format %s", format.c_str());
if (format == "Paje") {
TRACE_paje_start();
} else if (format == "TI") {
- instr_fmt_type = instr_fmt_TI;
+ simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti;
TRACE_TI_start();
}else{
xbt_die("Unknown trace format :%s ", format.c_str());
}
- /* activate trace */
- if (trace_active) {
- THROWF(tracing_error, 0, "Tracing is already active");
- }
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");
+ /* 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 = simgrid::config::get_value<std::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());
}
- return retval;
+
+ /* de-activate trace */
+ trace_active = false;
+ XBT_DEBUG("Tracing is off");
+ XBT_DEBUG("Tracing system is shutdown");
}
bool TRACE_needs_platform ()
{
- return TRACE_msg_process_is_enabled() || TRACE_msg_vm_is_enabled() || TRACE_categorized() ||
- TRACE_uncategorized() || TRACE_platform () || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
+ return TRACE_actor_is_enabled() || TRACE_vm_is_enabled() || TRACE_categorized() || TRACE_uncategorized() ||
+ TRACE_platform() || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
}
bool TRACE_is_enabled()
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();
return trace_uncategorized;
}
-bool TRACE_msg_process_is_enabled()
+bool TRACE_actor_is_enabled()
{
- return trace_msg_process_enabled && TRACE_is_enabled();
+ return trace_actor_enabled && trace_enabled;
}
-bool TRACE_msg_vm_is_enabled()
+bool TRACE_vm_is_enabled()
{
- return trace_msg_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();
-}
-
-bool TRACE_onelink_only ()
-{
- return trace_onelink_only && 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();
+ return trace_display_sizes && trace_smpi_enabled && trace_enabled;
}
std::string TRACE_get_comment()
{
- return xbt_cfg_get_string(OPT_TRACING_COMMENT);
+ return simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT);
}
std::string TRACE_get_comment_file()
{
- return xbt_cfg_get_string(OPT_TRACING_COMMENT_FILE);
+ return simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT_FILE);
}
int TRACE_precision ()
{
- return xbt_cfg_get_int(OPT_TRACING_PRECISION);
+ return simgrid::config::get_value<int>(OPT_TRACING_PRECISION);
}
std::string TRACE_get_filename()
{
- return xbt_cfg_get_string(OPT_TRACING_FILENAME);
+ return simgrid::config::get_value<std::string>(OPT_TRACING_FILENAME);
}
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_MSG_PROCESS, "no", nullptr, "Tracing of MSG process behavior.");
- xbt_cfg_register_boolean(OPT_TRACING_MSG_VM, "no", nullptr, "Tracing of MSG process 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_ONELINK_ONLY, "no", nullptr, "Use only routes with one link to trace platform.");
- 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");
- xbt_cfg_register_alias(OPT_TRACING_ONELINK_ONLY, "tracing/onelink_only");
-
- /* instrumentation can be considered configured now */
- trace_configured = true;
+ simgrid::config::declare_flag<std::string>(OPT_TRACING_FILENAME, "Trace file created by the instrumented SimGrid.",
+ "simgrid.trace");
+ simgrid::config::declare_flag<std::string>(OPT_TRACING_FORMAT, "(smpi only) Switch the output format of Tracing",
+ "Paje");
+ simgrid::config::declare_flag<bool>(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<std::string>(OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
+ "");
+ simgrid::config::declare_flag<std::string>(
+ 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<int>(OPT_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)
" 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_MSG_PROCESS, "Trace processes behavior (MSG)",
- " This option only has effect if this simulator is MSG-based. It traces the\n"
- " behavior of all categorized MSG processes, grouping them by hosts. This option\n"
- " can be used to track process location if this simulator has process migration.", 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"
" buffer and the cost of the sorting algorithm make this process slow. The\n"
" simulator performance can be severely impacted if this option is activated,\n"
" but you are sure to get a trace file with events sorted.", detailed);
- print_line (OPT_TRACING_ONELINK_ONLY, "Consider only one link routes to trace platform",
- " This option changes the way SimGrid register its platform on the trace file.\n"
- " Normally, the tracing considers all routes (no matter their size) on the\n"
- " platform file to re-create the resource topology. If this option is activated,\n"
- " only the routes with one link are used to register the topology within an AS.\n"
- " Routes among AS continue to be traced as usual.", detailed);
print_line (OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
" Disable the destruction of containers at the end of simulation. This can be\n"
" used with simulators that have a different notion of time (different from\n"
" time consuming, since it must get the route from each host to other hosts\n"
" within the same Autonomous System (AS).", detailed);
}
-
-static void output_types (const char *name, xbt_dynar_t types, FILE *file)
-{
- unsigned int i;
- fprintf (file, " %s = (", name);
- for (i = xbt_dynar_length(types); i > 0; i--) {
- char *type = *(static_cast<char**>(xbt_dynar_get_ptr(types, i - 1)));
- fprintf (file, "\"%s\"", type);
- if (i - 1 > 0){
- fprintf (file, ",");
- }else{
- fprintf (file, ");\n");
- }
- }
- xbt_dynar_free (&types);
-}
-
-static int previous_trace_state = -1;
-
-void instr_pause_tracing ()
-{
- previous_trace_state = trace_enabled;
- if (not TRACE_is_enabled()) {
- XBT_DEBUG ("Tracing is already paused, therefore do nothing.");
- }else{
- XBT_DEBUG ("Tracing is being paused.");
- }
- trace_enabled = false;
- XBT_DEBUG ("Tracing is paused.");
-}
-
-void instr_resume_tracing ()
-{
- if (TRACE_is_enabled()){
- XBT_DEBUG ("Tracing is already running while trying to resume, therefore do nothing.");
- }else{
- XBT_DEBUG ("Tracing is being resumed.");
- }
-
- if (previous_trace_state != -1){
- trace_enabled = previous_trace_state;
- }else{
- trace_enabled = true;
- }
- XBT_DEBUG ("Tracing is resumed.");
- previous_trace_state = -1;
-}