Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] detailed description of new configuration options
[simgrid.git] / src / instr / instr_config.c
index 4a783d8..f8a58a7 100644 (file)
@@ -5,7 +5,7 @@
   * 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
 
 #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;
+
+extern xbt_dict_t created_categories; //declared in instr_interface.c
+
+void TRACE_activate (void)
+{
+  if (trace_active){
+    THROW0(tracing_error, TRACE_ERROR_ALREADY_ACTIVE,
+           "Tracing is already active.");
+  }
+  trace_active = 1;
+}
+
+void TRACE_desactivate (void)
+{
+  trace_active = 0;
+}
+
+int TRACE_is_active (void)
+{
+  return trace_active;
+}
 
 int TRACE_is_enabled(void)
 {
@@ -77,6 +101,16 @@ char *TRACE_get_platform_method(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 */
@@ -150,6 +184,20 @@ void TRACE_global_init(int *argc, char **argv)
                    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;
 }
@@ -225,6 +273,119 @@ void TRACE_help (int detailed)
       "  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){
+    FILE *file = fopen (output, "w");
+    if (!file){
+      THROW1(tracing_error, TRACE_ERROR_FILE_OPEN,
+             "Unable to open file (%s) for writing triva graph configuration (uncategorized).", output);
+    }
+    fprintf (file,
+        "{\n"
+        "  node = (HOST);\n"
+        "  edge = (LINK);\n"
+        "\n"
+        "  HOST = {\n"
+        "    size = power;\n"
+        "    scale = global;\n"
+        "    host_sep = {\n"
+        "      type = separation;\n"
+        "      size = power;\n"
+        "      values = (power_used);\n"
+        "    };\n"
+        "  };\n"
+        "  LINK = {\n"
+        "    src = source;\n"
+        "    dst = destination;\n"
+        "    size = bandwidth;\n"
+        "    scale = global;\n"
+        "    link_sep = {\n"
+        "      type = separation;\n"
+        "      size = bandwidth;\n"
+        "      values = (bandwidth_used);\n"
+        "    };\n"
+        "  };\n"
+        "  graphviz-algorithm = neato;\n"
+        "}\n"
+        );
+    fclose (file);
+  }
+}
+
+void TRACE_generate_triva_cat_conf (void)
+{
+  char *output = TRACE_get_triva_cat_conf();
+  if (output && strlen(output) > 0){
+    //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;
+    }
+    xbt_dict_cursor_t cursor=NULL;
+    char *key, *data;
+    FILE *file = fopen (output, "w");
+    if (!file){
+      THROW1(tracing_error, TRACE_ERROR_FILE_OPEN,
+             "Unable to open file (%s) for writing triva graph configuration (categorized).", output);
+    }
+    fprintf (file,
+        "{\n"
+        "  node = (HOST);\n"
+        "  edge = (LINK);\n"
+        "\n"
+        "  HOST = {\n"
+        "    size = power;\n"
+        "    scale = global;\n"
+        "    host_sep = {\n"
+        "      type = separation;\n"
+        "      size = power;\n"
+        "      values = (");
+    xbt_dict_foreach(created_categories,cursor,key,data) {
+      fprintf(file, "p%s, ",key);
+    }
+    fprintf (file,
+        ");\n"
+        "    };\n"
+        "  };\n"
+        "  LINK = {\n"
+        "    src = source;\n"
+        "    dst = destination;\n"
+        "    size = bandwidth;\n"
+        "    scale = global;\n"
+        "    link_sep = {\n"
+        "      type = separation;\n"
+        "      size = bandwidth;\n"
+        "      values = (");
+    xbt_dict_foreach(created_categories,cursor,key,data) {
+      fprintf(file, "b%s, ",key);
+    }
+    fprintf (file,
+        ");\n"
+        "    };\n"
+        "  };\n"
+        "  graphviz-algorithm = neato;\n"
+        "}\n"
+        );
+    fclose(file);
+  }
 }
 
 #undef OPT_TRACING
@@ -237,5 +398,7 @@ void TRACE_help (int detailed)
 #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
+#endif /* HAVE_TRACING */