+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_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_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_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"
+ " the simulated time).",
+ 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);
+ 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);
+}
+
+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 = *(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, xbt_dynar_t cats, FILE *file)
+{
+ unsigned int i;
+ fprintf (file, " values = (");
+ for (i = xbt_dynar_length(cats); i > 0; i--) {
+ char *cat = *(char**)xbt_dynar_get_ptr(cats, i - 1);
+ fprintf (file, "\"%s%s\"", name, cat);
+ if (i - 1 > 0){
+ fprintf (file, ",");
+ }else{
+ fprintf (file, ");\n");
+ }
+ }
+ xbt_dynar_free (&cats);
+}
+
+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", TRACE_get_categories(), file);
+ fprintf (file,
+ " };\n"
+ " link = {\n"
+ " type = \"rhombus\";\n"
+ " size = \"bandwidth\";\n");
+ output_categories ("b", TRACE_get_categories(), 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 == NULL){
+ 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 (xbt_dict_is_empty(created_categories)){
+ XBT_INFO("No categories declared, ignoring generation of %s graph configuration", name);
+ return;
+ }
+
+ FILE *file = fopen (output, "w");
+ if (file == NULL){
+ THROWF (system_error, 1, "Unable to open file (%s) for writing %s graph "
+ "configuration (categorized).", output, name);
+ }
+
+ fprintf (file, "{\n");
+ cat_configuration (file);
+ fprintf (file, "}\n");
+ fclose (file);
+ }
+}
+
+void TRACE_generate_triva_uncat_conf (void)
+{
+ generate_uncat_configuration (TRACE_get_triva_uncat_conf (), "triva", 1);
+}
+
+void TRACE_generate_triva_cat_conf (void)
+{
+ generate_cat_configuration (TRACE_get_triva_cat_conf(), "triva", 1);
+}
+
+void TRACE_generate_viva_uncat_conf (void)
+{
+ generate_uncat_configuration (TRACE_get_viva_uncat_conf (), "viva", 0);
+}
+
+void TRACE_generate_viva_cat_conf (void)
+{
+ generate_cat_configuration (TRACE_get_viva_cat_conf(), "viva", 0);
+}
+