-/* 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 "src/instr/instr_private.h"
-#include "surf/surf.h"
+#include "include/xbt/config.hpp"
+#include "src/instr/instr_private.hpp"
+#include "surf/surf.hpp"
#include <string>
#include <vector>
#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_TOPOLOGY "tracing/platform/topology"
#define OPT_TRACING "tracing"
#define OPT_TRACING_UNCATEGORIZED "tracing/uncategorized"
-#define OPT_VIVA_CAT_CONF "viva/categorized"
-#define OPT_VIVA_UNCAT_CONF "viva/uncategorized"
static bool trace_enabled = false;
static bool trace_platform;
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_actor_enabled;
+static bool trace_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::instr::Type* rootType = nullptr; /* the root type */
-
instr_fmt_type_t instr_fmt_type = instr_fmt_paje;
static void TRACE_getopts()
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_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_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);
}
int TRACE_start()
/* init the tracing module to generate the right output */
/* open the trace file(s) */
- const char* format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
- XBT_DEBUG("Tracing format %s\n", format);
- if (not strcmp(format, "Paje")) {
+ 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 (not strcmp(format, "TI")) {
+ } else if (format == "TI") {
instr_fmt_type = instr_fmt_TI;
TRACE_TI_start();
}else{
- xbt_die("Unknown trace format :%s ", format);
+ xbt_die("Unknown trace format :%s ", format.c_str());
}
/* activate trace */
- if (trace_active == 1) {
+ if (trace_active) {
THROWF(tracing_error, 0, "Tracing is already active");
}
- trace_active = 1;
+ trace_active = true;
XBT_DEBUG("Tracing is on");
}
return 0;
} else {
retval = 0;
- TRACE_generate_viva_uncat_conf();
- TRACE_generate_viva_cat_conf();
-
/* dump trace buffer */
TRACE_last_timestamp_to_dump = surf_get_clock();
- TRACE_paje_dump_buffer(1);
+ TRACE_paje_dump_buffer(true);
+ simgrid::instr::Type* root_type = simgrid::instr::Container::getRoot()->type_;
/* destroy all data structures of tracing (and free) */
- PJ_container_free_all();
- recursiveDestroyType (PJ_type_get_root());
- PJ_container_release();
- rootType = nullptr;
+ delete simgrid::instr::Container::getRoot();
+ delete root_type;
/* close the trace files */
- const char* format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
- XBT_DEBUG("Tracing format %s\n", format);
- if (not strcmp(format, "Paje")) {
+ 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 (not strcmp(format, "TI")) {
+ } else if (format == "TI") {
TRACE_TI_end();
}else{
- xbt_die("Unknown trace format :%s ", format);
+ xbt_die("Unknown trace format :%s ", format.c_str());
}
/* de-activate trace */
- trace_active = 0;
+ 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_uncategorized;
}
-bool TRACE_msg_process_is_enabled()
+bool TRACE_actor_is_enabled()
{
- return trace_msg_process_enabled && TRACE_is_enabled();
+ return trace_actor_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_is_enabled();
}
bool TRACE_disable_link()
return trace_buffer && TRACE_is_enabled();
}
-bool TRACE_onelink_only ()
-{
- return trace_onelink_only && TRACE_is_enabled();
-}
-
bool TRACE_disable_destroy ()
{
return trace_disable_destroy && TRACE_is_enabled();
return trace_display_sizes && trace_smpi_enabled && TRACE_is_enabled();
}
-char *TRACE_get_comment ()
+std::string TRACE_get_comment()
{
return xbt_cfg_get_string(OPT_TRACING_COMMENT);
}
-char *TRACE_get_comment_file ()
+std::string TRACE_get_comment_file()
{
return xbt_cfg_get_string(OPT_TRACING_COMMENT_FILE);
}
return xbt_cfg_get_int(OPT_TRACING_PRECISION);
}
-char *TRACE_get_filename()
+std::string TRACE_get_filename()
{
return xbt_cfg_get_string(OPT_TRACING_FILENAME);
}
-char *TRACE_get_viva_uncat_conf ()
-{
- return xbt_cfg_get_string(OPT_VIVA_UNCAT_CONF);
-}
-
-char *TRACE_get_viva_cat_conf ()
-{
- return xbt_cfg_get_string(OPT_VIVA_CAT_CONF);
-}
-
void TRACE_global_init()
{
- static int is_initialised = 0;
+ static bool is_initialised = false;
if (is_initialised)
return;
- is_initialised = 1;
+ 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_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_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_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");
"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)");
- /* Viva graph configuration for uncategorized tracing */
- xbt_cfg_register_string(OPT_VIVA_UNCAT_CONF, "", nullptr, "Viva Graph configuration file for uncategorized resource utilization traces.");
- xbt_cfg_register_string(OPT_VIVA_CAT_CONF, "", nullptr, "Viva Graph configuration file for categorized resource utilization traces.");
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_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 = 1;
+ trace_configured = true;
}
static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
{
- char str[INSTR_DEFAULT_STR_SIZE];
- snprintf (str, INSTR_DEFAULT_STR_SIZE, "--cfg=%s ", option);
+ std::string str = std::string("--cfg=") + option + " ";
- int len = strlen (str);
- printf ("%s%*.*s %s\n", str, 30-len, 30-len, "", desc);
+ int len = str.size();
+ printf("%s%*.*s %s\n", str.c_str(), 30 - len, 30 - len, "", desc);
if (longdesc != nullptr && detailed){
printf ("%s\n\n", longdesc);
}
" 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 Viva, Paje, and PajeNG visualization\n"
- " tools. More information can be found in these webpages:\n"
- " http://github.com/schnorr/viva/\n"
- " http://github.com/schnorr/pajeng/\n"
- " http://paje.sourceforge.net/", 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"
" 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"
" Use this to add a comment line to the top of the trace file.", detailed);
print_line (OPT_TRACING_COMMENT_FILE, "File contents added to trace file as comment.",
" Use this to add the contents of a file to the top of the trace file as comment.", detailed);
- print_line (OPT_VIVA_UNCAT_CONF, "Generate a graph configuration for Viva",
- " This option can be used in all types of simulators build with SimGrid\n"
- " to generate a uncategorized resource utilization graph to be used as\n"
- " configuration for the Viva visualization tool. This option\n"
- " can be used with tracing/categorized:1 and tracing:1 options to\n"
- " analyze an unmodified simulator before changing it to contain\n"
- " categories.", detailed);
- print_line (OPT_VIVA_CAT_CONF, "Generate an uncategorized graph configuration for Viva",
- " This option can be used if this simulator uses tracing categories\n"
- " in its code. The file specified by this option holds a graph configuration\n"
- " file for the Viva visualization tool that can be used to analyze a categorized\n"
- " resource utilization.", detailed);
print_line (OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
" This option (enabled by default) can be used to disable the tracing of\n"
" the platform topology in the trace file. Sometimes, such task is really\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 void output_categories(const char* name, FILE* file)
-{
- unsigned int i = created_categories.size();
- fprintf (file, " values = (");
- for (auto const& cat : created_categories) {
- --i;
- fprintf(file, "\"%s%s\"", name, cat.c_str());
- if (i > 0) {
- fprintf (file, ",");
- }else{
- fprintf (file, ");\n");
- }
- }
-}
-
-static void uncat_configuration (FILE *file)
-{
- //register NODE and EDGE types
- output_types ("node", TRACE_get_node_types(), file);
- output_types ("edge", TRACE_get_edge_types(), file);
- fprintf (file, "\n");
-
- //configuration for all nodes
- fprintf (file,
- " host = {\n"
- " type = \"square\";\n"
- " size = \"power\";\n"
- " values = (\"power_used\");\n"
- " };\n"
- " link = {\n"
- " type = \"rhombus\";\n"
- " size = \"bandwidth\";\n"
- " values = (\"bandwidth_used\");\n"
- " };\n");
- //close
-}
-
-static void cat_configuration (FILE *file)
-{
- //register NODE and EDGE types
- output_types ("node", TRACE_get_node_types(), file);
- output_types ("edge", TRACE_get_edge_types(), file);
- fprintf (file, "\n");
-
- //configuration for all nodes
- fprintf (file,
- " host = {\n"
- " type = \"square\";\n"
- " size = \"power\";\n");
- output_categories("p", file);
- fprintf (file,
- " };\n"
- " link = {\n"
- " type = \"rhombus\";\n"
- " size = \"bandwidth\";\n");
- output_categories("b", file);
- fprintf (file, " };\n");
- //close
-}
-
-static void generate_uncat_configuration (const char *output, const char *name, int brackets)
-{
- if (output && strlen(output) > 0){
- FILE *file = fopen (output, "w");
- if (file == nullptr){
- THROWF (system_error, 1, "Unable to open file (%s) for writing %s graph configuration (uncategorized).",
- output, name);
- }
-
- if (brackets)
- fprintf (file, "{\n");
- uncat_configuration (file);
- if (brackets)
- fprintf (file, "}\n");
- fclose (file);
- }
-}
-
-static void generate_cat_configuration (const char *output, const char *name, int brackets)
-{
- if (output && strlen(output) > 0){
- //check if we do have categories declared
- if (created_categories.empty()) {
- XBT_INFO("No categories declared, ignoring generation of %s graph configuration", name);
- return;
- }
-
- FILE *file = fopen (output, "w");
- if (file == nullptr){
- THROWF (system_error, 1, "Unable to open file (%s) for writing %s graph "
- "configuration (categorized).", output, name);
- }
-
- if (brackets) fprintf (file, "{\n");
- cat_configuration (file);
- if (brackets) fprintf (file, "}\n");
- fclose (file);
- }
-}
-
-void TRACE_generate_viva_uncat_conf ()
-{
- generate_uncat_configuration (TRACE_get_viva_uncat_conf (), "viva", 0);
-}
-
-void TRACE_generate_viva_cat_conf ()
-{
- generate_cat_configuration (TRACE_get_viva_cat_conf(), "viva", 0);
-}
-
-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 = 0;
- 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 = 1;
- }
- XBT_DEBUG ("Tracing is resumed.");
- previous_trace_state = -1;
-}
