Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] move categories dictionary declaration to interface file
[simgrid.git] / src / instr / instr_config.c
index da77f22..e4f1114 100644 (file)
@@ -13,47 +13,45 @@ XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used fo
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
 
 #define OPT_TRACING               "tracing"
+#define OPT_TRACING_PLATFORM      "tracing/platform"
 #define OPT_TRACING_SMPI          "tracing/smpi"
 #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_BUFFER        "tracing/buffer"
 #define OPT_TRACING_ONELINK_ONLY  "tracing/onelink_only"
+#define OPT_TRACING_DISABLE_DESTROY "tracing/disable_destroy"
 #define OPT_TRIVA_UNCAT_CONF      "triva/uncategorized"
 #define OPT_TRIVA_CAT_CONF        "triva/categorized"
 
 static int trace_enabled;
+static int trace_platform;
 static int trace_smpi_enabled;
 static int trace_smpi_grouped;
 static int trace_categorized;
 static int trace_uncategorized;
-static int trace_msg_task_enabled;
 static int trace_msg_process_enabled;
-static int trace_msg_volume_enabled;
 static int trace_buffer;
 static int trace_onelink_only;
+static int trace_disable_destroy;
 
 static int trace_configured = 0;
 static int trace_active = 0;
 
-xbt_dict_t created_categories; //declared in instr_interface.c
-
 static void TRACE_getopts(void)
 {
   trace_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING);
+  trace_platform = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_PLATFORM);
   trace_smpi_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI);
   trace_smpi_grouped = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI_GROUP);
   trace_categorized = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_CATEGORIZED);
   trace_uncategorized = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_UNCATEGORIZED);
-  trace_msg_task_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_TASK);
   trace_msg_process_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_PROCESS);
-  trace_msg_volume_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_VOLUME);
   trace_buffer = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_BUFFER);
   trace_onelink_only = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_ONELINK_ONLY);
+  trace_disable_destroy = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_DISABLE_DESTROY);
 }
 
 int TRACE_start()
@@ -73,10 +71,14 @@ int TRACE_start()
   TRACE_paje_start();
 
   /* activate trace */
-  TRACE_activate ();
+  if (trace_active == 1){
+    THROWF (tracing_error, 0, "Tracing is already active");
+  }
+  trace_active = 1;
+  XBT_DEBUG ("Tracing is on");
 
   /* other trace initialization */
-  created_categories = xbt_dict_new();
+  created_categories = xbt_dict_new_homogeneous(xbt_free);
   TRACE_surf_alloc();
   TRACE_smpi_alloc();
   return 0;
@@ -84,7 +86,7 @@ int TRACE_start()
 
 int TRACE_end()
 {
-  if (!TRACE_is_active())
+  if (!trace_active)
     return 1;
 
   /* generate uncategorized graph configuration for triva */
@@ -102,38 +104,41 @@ int TRACE_end()
   TRACE_paje_dump_buffer(1);
 
   /* destroy all data structures of tracing (and free) */
-  destroyAllContainers();
+  PJ_container_free_all();
+  PJ_type_free_all();
+  PJ_container_release();
+  PJ_type_release();
+  TRACE_surf_release();
+  TRACE_smpi_release();
+  xbt_dict_free(&created_categories);
 
   /* close the trace file */
   TRACE_paje_end();
 
-  /* activate trace */
-  TRACE_desactivate ();
+  /* de-activate trace */
+  trace_active = 0;
+  XBT_DEBUG ("Tracing is off");
   XBT_DEBUG("Tracing system is shutdown");
   return 0;
 }
 
-void TRACE_activate (void)
+int TRACE_needs_platform (void)
 {
-  xbt_assert (trace_active==0, "Tracing is already active.");
-  trace_active = 1;
-  XBT_DEBUG ("Tracing is on");
+  return TRACE_msg_process_is_enabled() ||
+         TRACE_categorized() ||
+         TRACE_uncategorized() ||
+         TRACE_platform () ||
+         (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
 }
 
-void TRACE_desactivate (void)
-{
-  trace_active = 0;
-  XBT_DEBUG ("Tracing is off");
-}
-
-int TRACE_is_active (void)
+int TRACE_is_enabled(void)
 {
-  return trace_active;
+  return trace_enabled;
 }
 
-int TRACE_is_enabled(void)
+int TRACE_platform(void)
 {
-  return trace_enabled;
+  return trace_platform;
 }
 
 int TRACE_is_configured(void)
@@ -143,7 +148,8 @@ int TRACE_is_configured(void)
 
 int TRACE_smpi_is_enabled(void)
 {
-  return trace_smpi_enabled && TRACE_is_enabled();
+  return (trace_smpi_enabled || TRACE_smpi_is_grouped())
+    && TRACE_is_enabled();
 }
 
 int TRACE_smpi_is_grouped(void)
@@ -161,21 +167,11 @@ int TRACE_uncategorized (void)
   return trace_uncategorized;
 }
 
-int TRACE_msg_task_is_enabled(void)
-{
-  return trace_msg_task_enabled && TRACE_is_enabled();
-}
-
 int TRACE_msg_process_is_enabled(void)
 {
   return trace_msg_process_enabled && TRACE_is_enabled();
 }
 
-int TRACE_msg_volume_is_enabled(void)
-{
-  return trace_msg_volume_enabled && TRACE_is_enabled();
-}
-
 int TRACE_buffer (void)
 {
   return trace_buffer && TRACE_is_enabled();
@@ -186,6 +182,11 @@ int TRACE_onelink_only (void)
   return trace_onelink_only && TRACE_is_enabled();
 }
 
+int TRACE_disable_destroy (void)
+{
+  return trace_disable_destroy && TRACE_is_enabled();
+}
+
 char *TRACE_get_filename(void)
 {
   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_FILENAME);
@@ -217,6 +218,13 @@ void TRACE_global_init(int *argc, char **argv)
                    xbt_cfgelm_int, &default_tracing, 0, 1,
                    NULL, NULL);
 
+  /* register platform in the trace */
+  int default_tracing_platform = 0;
+  xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_PLATFORM,
+                   "Register the platform in the trace as a graph.",
+                   xbt_cfgelm_int, &default_tracing_platform, 0, 1,
+                   NULL, NULL);
+
   /* smpi */
   int default_tracing_smpi = 0;
   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_SMPI,
@@ -232,27 +240,20 @@ void TRACE_global_init(int *argc, char **argv)
                    NULL, NULL);
 
 
-  /* platform */
-  int default_tracing_platform = 0;
+  /* tracing categorized resource utilization traces */
+  int default_tracing_categorized = 0;
   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,
+                   "Tracing categorized resource utilization of hosts and links.",
+                   xbt_cfgelm_int, &default_tracing_categorized, 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.",
+                   "Tracing uncategorized resource utilization of hosts and links.",
                    xbt_cfgelm_int, &default_tracing_uncategorized, 0, 1,
                    NULL, NULL);
 
-  /* msg task */
-  int default_tracing_msg_task = 0;
-  xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_TASK,
-                   "Tracing of MSG task behavior.",
-                   xbt_cfgelm_int, &default_tracing_msg_task, 0, 1,
-                   NULL, NULL);
-
   /* msg process */
   int default_tracing_msg_process = 0;
   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_PROCESS,
@@ -260,27 +261,27 @@ void TRACE_global_init(int *argc, char **argv)
                    xbt_cfgelm_int, &default_tracing_msg_process, 0, 1,
                    NULL, NULL);
 
-  /* msg volume (experimental) */
-  int default_tracing_msg_volume = 0;
-  xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_VOLUME,
-                   "Tracing of MSG communication volume (experimental).",
-                   xbt_cfgelm_int, &default_tracing_msg_volume, 0, 1,
-                   NULL, NULL);
-
-  /* msg volume (experimental) */
-  int default_buffer = 0;
+  /* tracing buffer */
+  int default_buffer = 1;
   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_BUFFER,
                    "Buffer trace events to put them in temporal order.",
                    xbt_cfgelm_int, &default_buffer, 0, 1,
                    NULL, NULL);
 
-  /* msg volume (experimental) */
+  /* tracing one link only */
   int default_onelink_only = 0;
   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_ONELINK_ONLY,
                    "Use only routes with one link to trace platform.",
                    xbt_cfgelm_int, &default_onelink_only, 0, 1,
                    NULL, NULL);
 
+  /* disable destroy */
+  int default_disable_destroy = 0;
+  xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_DISABLE_DESTROY,
+                   "Disable platform containers destruction.",
+                   xbt_cfgelm_int, &default_disable_destroy, 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,
@@ -345,19 +346,11 @@ void TRACE_help (int detailed)
       "  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_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"
@@ -372,6 +365,11 @@ void TRACE_help (int detailed)
       "  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"
@@ -396,9 +394,10 @@ void TRACE_generate_triva_uncat_conf (void)
     char *name, *value;
 
     FILE *file = fopen (output, "w");
-    xbt_assert (file != NULL,
-       "Unable to open file (%s) for writing triva graph "
-       "configuration (uncategorized).", output);
+    if (file == NULL){
+      THROWF (system_error, 1, "Unable to open file (%s) for writing triva graph "
+          "configuration (uncategorized).", output);
+    }
 
     //open
     fprintf (file, "{\n");
@@ -446,15 +445,16 @@ void TRACE_generate_triva_cat_conf (void)
     char *name, *name2, *value, *value2;
 
     //check if we do have categories declared
-    if (xbt_dict_length(created_categories) == 0){
+    if (xbt_dict_is_empty(created_categories)){
       XBT_INFO("No categories declared, ignoring generation of triva graph configuration");
       return;
     }
 
     FILE *file = fopen (output, "w");
-    xbt_assert (file != NULL,
-       "Unable to open file (%s) for writing triva graph "
-       "configuration (categorized).", output);
+    if (file == NULL){
+      THROWF (system_error, 1, "Unable to open file (%s) for writing triva graph "
+          "configuration (categorized).", output);
+    }
 
     //open
     fprintf (file, "{\n");
@@ -505,15 +505,16 @@ void TRACE_generate_triva_cat_conf (void)
 }
 
 #undef OPT_TRACING
+#undef OPT_TRACING_PLATFORM
 #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_TRACING_BUFFER
+#undef OPT_TRACING_ONELINK_ONLY
+#undef OPT_TRACING_DISABLE_DESTROY
 #undef OPT_TRIVA_UNCAT_CONF
 #undef OPT_TRIVA_CAT_CONF