* under the terms of the license (GNU LGPL) which comes with this package. */
-#include "instr/private.h"
+#include "instr/instr_private.h"
#ifdef HAVE_TRACING
+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");
+
+#define OPT_TRACING "tracing"
#define OPT_TRACING_SMPI "tracing/smpi"
-#define OPT_TRACING_PLATFORM "tracing/platform"
+#define OPT_TRACING_SMPI_GROUP "tracing/smpi/group"
+#define OPT_TRACING_CATEGORIZED "tracing/categorized"
+#define OPT_TRACING_UNCATEGORIZED "tracing/uncategorized"
#define OPT_TRACING_MSG_TASK "tracing/msg/task"
#define OPT_TRACING_MSG_PROCESS "tracing/msg/process"
#define OPT_TRACING_MSG_VOLUME "tracing/msg/volume"
#define OPT_TRACING_FILENAME "tracing/filename"
#define OPT_TRACING_PLATFORM_METHOD "tracing/platform/method"
+#define OPT_TRIVA_UNCAT_CONF "triva/uncategorized"
+#define OPT_TRIVA_CAT_CONF "triva/categorized"
static int trace_configured = 0;
+static int trace_active = 0;
+
+xbt_dict_t created_categories; //declared in instr_interface.c
+
+int TRACE_start()
+{
+ // tracing system must be:
+ // - enabled (with --cfg=tracing:1)
+ // - already configured (TRACE_global_init already called)
+ if (!(TRACE_is_enabled() && TRACE_is_configured())){
+ return 0;
+ }
+
+ DEBUG0("Tracing starts");
+
+ /* open the trace file */
+ TRACE_paje_start();
+
+ /* activate trace */
+ TRACE_activate ();
+
+ /* other trace initialization */
+ created_categories = xbt_dict_new();
+ TRACE_surf_alloc();
+ TRACE_smpi_alloc();
+ return 0;
+}
+
+int TRACE_end()
+{
+ if (!TRACE_is_active())
+ return 1;
+
+ /* generate uncategorized graph configuration for triva */
+ if (TRACE_get_triva_uncat_conf()){
+ TRACE_generate_triva_uncat_conf();
+ }
+
+ /* generate categorized graph configuration for triva */
+ if (TRACE_get_triva_cat_conf()){
+ TRACE_generate_triva_cat_conf();
+ }
+
+ /* dump trace buffer */
+ TRACE_last_timestamp_to_dump = surf_get_clock();
+ TRACE_paje_dump_buffer(1);
+
+ /* destroy all data structures of tracing (and free) */
+ destroyAllContainers();
+
+ /* close the trace file */
+ TRACE_paje_end();
+
+ /* activate trace */
+ TRACE_desactivate ();
+ DEBUG0("Tracing system is shutdown");
+ return 0;
+}
+
+void TRACE_activate (void)
+{
+ xbt_assert0 (trace_active==0, "Tracing is already active.");
+ trace_active = 1;
+ DEBUG0 ("Tracing is on");
+}
+
+void TRACE_desactivate (void)
+{
+ trace_active = 0;
+ DEBUG0 ("Tracing is off");
+}
+
+int TRACE_is_active (void)
+{
+ return trace_active;
+}
+
+int TRACE_is_enabled(void)
+{
+ return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING);
+}
int TRACE_is_configured(void)
{
int TRACE_smpi_is_enabled(void)
{
- return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI);
+ return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI) &&
+ TRACE_is_enabled();
}
-int TRACE_platform_is_enabled(void)
+int TRACE_smpi_is_grouped(void)
{
- return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_PLATFORM);
+ return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI_GROUP);
+}
+
+int TRACE_categorized (void)
+{
+ return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_CATEGORIZED);
+}
+
+int TRACE_uncategorized (void)
+{
+ return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_UNCATEGORIZED);
}
int TRACE_msg_task_is_enabled(void)
{
- return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_TASK);
+ return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_TASK) &&
+ TRACE_is_enabled();
}
int TRACE_msg_process_is_enabled(void)
{
- return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_PROCESS);
+ return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_PROCESS) &&
+ TRACE_is_enabled();
}
int TRACE_msg_volume_is_enabled(void)
{
- return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_VOLUME);
+ return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_VOLUME) &&
+ TRACE_is_enabled();
}
char *TRACE_get_filename(void)
return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_PLATFORM_METHOD);
}
+char *TRACE_get_triva_uncat_conf (void)
+{
+ return xbt_cfg_get_string(_surf_cfg_set, OPT_TRIVA_UNCAT_CONF);
+}
+
+char *TRACE_get_triva_cat_conf (void)
+{
+ return xbt_cfg_get_string(_surf_cfg_set, OPT_TRIVA_CAT_CONF);
+}
+
void TRACE_global_init(int *argc, char **argv)
{
/* name of the tracefile */
xbt_cfgelm_string, &default_tracing_filename, 1, 1,
NULL, NULL);
+ /* tracing */
+ int default_tracing = 0;
+ xbt_cfg_register(&_surf_cfg_set, OPT_TRACING,
+ "Enable Tracing.",
+ xbt_cfgelm_int, &default_tracing, 0, 1,
+ NULL, NULL);
+
/* smpi */
int default_tracing_smpi = 0;
xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_SMPI,
xbt_cfgelm_int, &default_tracing_smpi, 0, 1,
NULL, NULL);
+ /* smpi grouped */
+ int default_tracing_smpi_grouped = 0;
+ xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_SMPI_GROUP,
+ "Group MPI processes by host.",
+ xbt_cfgelm_int, &default_tracing_smpi_grouped, 0, 1,
+ NULL, NULL);
+
+
/* platform */
int default_tracing_platform = 0;
- xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_PLATFORM,
+ xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_CATEGORIZED,
"Tracing of categorized platform (host and link) utilization.",
xbt_cfgelm_int, &default_tracing_platform, 0, 1,
NULL, NULL);
+ /* tracing uncategorized resource utilization */
+ int default_tracing_uncategorized = 0;
+ xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_UNCATEGORIZED,
+ "Tracing of uncategorized resource (host and link) utilization.",
+ xbt_cfgelm_int, &default_tracing_uncategorized, 0, 1,
+ NULL, NULL);
+
/* platform method */
- char *default_tracing_platform_method = xbt_strdup("b");
+ char *default_tracing_platform_method = xbt_strdup("a");
xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_PLATFORM_METHOD,
"Tracing method used to register categorized resource behavior.",
xbt_cfgelm_string, &default_tracing_platform_method, 1,
xbt_cfgelm_int, &default_tracing_msg_volume, 0, 1,
NULL, NULL);
+ /* Triva graph configuration for uncategorized tracing */
+ char *default_triva_uncat_conf_file = xbt_strdup ("");
+ xbt_cfg_register(&_surf_cfg_set, OPT_TRIVA_UNCAT_CONF,
+ "Triva Graph configuration file for uncategorized resource utilization traces.",
+ xbt_cfgelm_string, &default_triva_uncat_conf_file, 1, 1,
+ NULL, NULL);
+
+ /* Triva graph configuration for uncategorized tracing */
+ char *default_triva_cat_conf_file = xbt_strdup ("");
+ xbt_cfg_register(&_surf_cfg_set, OPT_TRIVA_CAT_CONF,
+ "Triva Graph configuration file for categorized resource utilization traces.",
+ xbt_cfgelm_string, &default_triva_cat_conf_file, 1, 1,
+ NULL, NULL);
+
/* instrumentation can be considered configured now */
trace_configured = 1;
}
-#endif
+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);
+
+ int len = strlen (str);
+ printf ("%s%*.*s %s\n", str, 30-len, 30-len, "", desc);
+ if (!!longdesc && detailed){
+ printf ("%s\n\n", longdesc);
+ }
+}
+
+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);
+ print_line (OPT_TRACING_UNCATEGORIZED, "Trace uncategorized resource utilization",
+ " 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_PLATFORM_METHOD, "Change the resource utilization tracing method",
+ " It changes the way resource utilization (categorized or not) is traced\n"
+ " inside the simulation core. Method 'a' (default) traces all updates defined\n"
+ " by the CPU/network model of a given resource. Depending on the interface used\n"
+ " by this simulator (MSG, SMPI, SimDAG), the default method can generate large\n"
+ " trace files. Method 'b' tries to make smaller tracefiles using clever updates,\n"
+ " without losing details of resource utilization. Method 'c' generates even\n"
+ " smaller files by doing time integration during the simulation, but it loses\n"
+ " precision. If this last method is used, the smallest timeslice used in the\n"
+ " tracefile analysis must be bigger than the smaller resource utilization. If\n"
+ " unsure, do not change this option.",
+ 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 Triva or Paje visualization\n"
+ " tools. More information can be found in these webpages:\n"
+ " http://triva.gforge.inria.fr/\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"
+ " visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
+ " state, and point-to-point communications can be analyzed with arrows.",
+ detailed);
+ print_line (OPT_TRACING_SMPI_GROUP, "Group MPI processes by host (SMPI)",
+ " This option only has effect if this simulator is SMPI-based. The processes\n"
+ " are grouped by the hosts where they were executed.",
+ detailed);
+ print_line (OPT_TRACING_MSG_TASK, "Trace task behavior (MSG)",
+ " This option only has effect if this simulator is MSG-based. It traces the\n"
+ " behavior of all categorized MSG tasks, grouping them by hosts.",
+ 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_MSG_VOLUME, "Tracing of communication volume (MSG)",
+ " This experimental option only has effect if this simulator is MSG-based.\n"
+ " It traces the communication volume of MSG send/receive.",
+ detailed);
+ print_line (OPT_TRIVA_UNCAT_CONF, "Generate graph configuration for Triva",
+ " 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 Triva visualization analysis. 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_TRIVA_CAT_CONF, "generate uncategorized graph configuration for Triva",
+ " 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 Triva visualization tool that can be used to analyze a categorized\n"
+ " resource utilization.",
+ detailed);
+}
+
+void TRACE_generate_triva_uncat_conf (void)
+{
+ char *output = TRACE_get_triva_uncat_conf ();
+ if (output && strlen(output) > 0){
+ xbt_dict_cursor_t cursor=NULL;
+ char *name, *value;
+
+ FILE *file = fopen (output, "w");
+ xbt_assert1 (file != NULL,
+ "Unable to open file (%s) for writing triva graph "
+ "configuration (uncategorized).", output);
+
+ //open
+ fprintf (file, "{\n");
+
+ //register NODE types
+ fprintf (file, " node = (");
+ xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
+ fprintf (file, "%s, ", name);
+ }
+
+ //register EDGE types
+ fprintf (file,
+ ");\n"
+ " edge = (");
+ xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
+ fprintf (file, "%s, ", name);
+ }
+ fprintf (file,
+ ");\n"
+ "\n");
+
+ //register each NODE type layout
+ xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
+ fprintf (file, " %s = {\n", name);
+ if (strcmp (name, "HOST") == 0){
+ fprintf (file,
+ " type = node;\n"
+ " size = power;\n"
+ " host_sep = {\n"
+ " type = separation;\n"
+ " size = power;\n"
+ " values = (power_used);\n"
+ " };\n");
+ }else if (strcmp (name, "ROUTER") == 0){
+ fprintf (file,
+ " type = node;\n"
+ " size = 10;\n");
+ }else if (strcmp (name, "LINK") == 0){
+ fprintf (file,
+ " type = edge;\n"
+ " size = bandwidth;\n"
+ " scale = global;\n"
+ " link_sep = {\n"
+ " type = separation;\n"
+ " size = bandwidth;\n"
+ " values = (bandwidth_used);\n"
+ " };\n");
+ }
+ fprintf (file, " };\n\n");
+ }
+
+ //EDGE configuration
+ xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
+ fprintf (file, " %s = { size = 1; };\n", name);
+ }
+
+ //graphviz configuration
+ fprintf (file, "\n");
+ fprintf (file, " graphviz-algorithm = neato;\n");
+
+ //close
+ fprintf (file, "}\n");
+ fclose (file);
+ }
+}
+
+void TRACE_generate_triva_cat_conf (void)
+{
+ char *output = TRACE_get_triva_cat_conf();
+ if (output && strlen(output) > 0){
+ xbt_dict_cursor_t cursor=NULL, cursor2=NULL;
+ char *name, *name2, *value, *value2;
+
+ //check if we do have categories declared
+ if (xbt_dict_length(created_categories) == 0){
+ INFO0("No categories declared, ignoring generation of triva graph configuration");
+ return;
+ }
+
+ FILE *file = fopen (output, "w");
+ xbt_assert1 (file != NULL,
+ "Unable to open file (%s) for writing triva graph "
+ "configuration (categorized).", output);
+
+ //open
+ fprintf (file, "{\n");
+
+ //register NODE types
+ fprintf (file, " node = (");
+ xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
+ fprintf (file, "%s, ", name);
+ }
+
+ //register EDGE types
+ fprintf (file,
+ ");\n"
+ " edge = (");
+ xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
+ fprintf (file, "%s, ", name);
+ }
+ fprintf (file,
+ ");\n"
+ "\n");
+
+ //register each NODE type layout
+ xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
+ fprintf (file, " %s = {\n", name);
+ if (strcmp (name, "HOST") == 0){
+ fprintf (file,
+ " type = node;\n"
+ " size = power;\n"
+ " host_sep = {\n"
+ " type = separation;\n"
+ " size = power;\n"
+ " values = (");
+ xbt_dict_foreach(created_categories,cursor2,name2,value2) {
+ fprintf (file, "%s, ", name2);
+ }
+ fprintf (file,
+ ");\n"
+ " };\n");
+ }else if (strcmp (name, "ROUTER") == 0){
+ fprintf (file,
+ " type = node;\n"
+ " size = 10;\n");
+ }else if (strcmp (name, "LINK") == 0){
+ fprintf (file,
+ " type = edge;\n"
+ " size = bandwidth;\n"
+ " scale = global;\n"
+ " link_sep = {\n"
+ " type = separation;\n"
+ " size = bandwidth;\n"
+ " values = (");
+ xbt_dict_foreach(created_categories,cursor2,name2,value2) {
+ fprintf (file, "%s, ", name2);
+ }
+ fprintf (file,
+ ");\n"
+ " };\n");
+ }
+ fprintf (file, " };\n\n");
+ }
+
+ //EDGE configuration
+ xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
+ fprintf (file, " %s = { size = 1; };\n", name);
+ }
+
+ //graphviz configuration
+ fprintf (file, "\n");
+ fprintf (file, " graphviz-algorithm = neato;\n");
+
+ //close
+ fprintf (file, "}\n");
+ fclose (file);
+ }
+}
+
+#undef OPT_TRACING
+#undef OPT_TRACING_SMPI
+#undef OPT_TRACING_SMPI_GROUP
+#undef OPT_TRACING_CATEGORIZED
+#undef OPT_TRACING_UNCATEGORIZED
+#undef OPT_TRACING_MSG_TASK
+#undef OPT_TRACING_MSG_PROCESS
+#undef OPT_TRACING_MSG_VOLUME
+#undef OPT_TRACING_FILENAME
+#undef OPT_TRACING_PLATFORM_METHOD
+#undef OPT_TRIVA_UNCAT_CONF
+#undef OPT_TRIVA_CAT_CONF
+
+#endif /* HAVE_TRACING */