Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[tracing] Use trace_smpi_enabled.
[simgrid.git] / src / instr / instr_config.c
index 998e2aa..2770759 100644 (file)
@@ -13,25 +13,53 @@ 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_PLATFORM_METHOD "tracing/platform/method"
+#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_process_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_process_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_PROCESS);
+  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()
 {
+  TRACE_getopts();
+
   // tracing system must be:
   //    - enabled (with --cfg=tracing:1)
   //    - already configured (TRACE_global_init already called)
@@ -45,10 +73,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;
@@ -56,7 +88,7 @@ int TRACE_start()
 
 int TRACE_end()
 {
-  if (!TRACE_is_active())
+  if (!trace_active)
     return 1;
 
   /* generate uncategorized graph configuration for triva */
@@ -74,38 +106,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)
-{
-  xbt_assert (trace_active==0, "Tracing is already active.");
-  trace_active = 1;
-  XBT_DEBUG ("Tracing is on");
-}
-
-void TRACE_desactivate (void)
+int TRACE_needs_platform (void)
 {
-  trace_active = 0;
-  XBT_DEBUG ("Tracing is off");
+  return TRACE_msg_process_is_enabled() ||
+         TRACE_categorized() ||
+         TRACE_uncategorized() ||
+         TRACE_platform () ||
+         (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
 }
 
-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 xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING);
+  return trace_platform;
 }
 
 int TRACE_is_configured(void)
@@ -115,51 +150,48 @@ int TRACE_is_configured(void)
 
 int TRACE_smpi_is_enabled(void)
 {
-  return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI) &&
-      TRACE_is_enabled();
+  return (trace_smpi_enabled || TRACE_smpi_is_grouped())
+    && TRACE_is_enabled();
 }
 
 int TRACE_smpi_is_grouped(void)
 {
-  return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI_GROUP);
+  return trace_smpi_grouped;
 }
 
 int TRACE_categorized (void)
 {
-  return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_CATEGORIZED);
+  return trace_categorized;
 }
 
 int TRACE_uncategorized (void)
 {
-  return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_UNCATEGORIZED);
+  return trace_uncategorized;
 }
 
-int TRACE_msg_task_is_enabled(void)
+int TRACE_msg_process_is_enabled(void)
 {
-  return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_TASK) &&
-      TRACE_is_enabled();
+  return trace_msg_process_enabled && TRACE_is_enabled();
 }
 
-int TRACE_msg_process_is_enabled(void)
+int TRACE_buffer (void)
 {
-  return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_PROCESS) &&
-      TRACE_is_enabled();
+  return trace_buffer && TRACE_is_enabled();
 }
 
-int TRACE_msg_volume_is_enabled(void)
+int TRACE_onelink_only (void)
 {
-  return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_VOLUME) &&
-      TRACE_is_enabled();
+  return trace_onelink_only && TRACE_is_enabled();
 }
 
-char *TRACE_get_filename(void)
+int TRACE_disable_destroy (void)
 {
-  return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_FILENAME);
+  return trace_disable_destroy && TRACE_is_enabled();
 }
 
-char *TRACE_get_platform_method(void)
+char *TRACE_get_filename(void)
 {
-  return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_PLATFORM_METHOD);
+  return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_FILENAME);
 }
 
 char *TRACE_get_triva_uncat_conf (void)
@@ -188,6 +220,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,
@@ -203,34 +242,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);
 
-  /* platform method */
-  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,
-                   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,
@@ -238,11 +263,25 @@ 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,
+  /* tracing buffer */
+  int default_buffer = 0;
+  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);
+
+  /* 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 */
@@ -292,18 +331,6 @@ void TRACE_help (int detailed)
       "  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"
@@ -321,18 +348,29 @@ 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.",
+  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"
@@ -358,9 +396,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");
@@ -382,45 +421,18 @@ void TRACE_generate_triva_uncat_conf (void)
         ");\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");
-
+    //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
     fprintf (file, "}\n");
     fclose (file);
@@ -435,15 +447,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");
@@ -465,71 +478,55 @@ void TRACE_generate_triva_cat_conf (void)
         ");\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");
+    //configuration for all nodes
+    fprintf (file,
+        "  host = {\n"
+        "    type = square;\n"
+        "    size = power;\n"
+        "    values = (");
+    xbt_dict_foreach(created_categories,cursor2,name2,value2) {
+      fprintf (file, "p%s, ", name2);
     }
-
-    //EDGE configuration
-    xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
-      fprintf (file, "  %s = { size = 1; };\n", name);
+    fprintf (file,
+        ");\n"
+        "  };\n"
+        "  link = {\n"
+        "    type = rhombus;\n"
+        "    size = bandwidth;\n"
+        "    values = (");
+    xbt_dict_foreach(created_categories,cursor2,name2,value2) {
+      fprintf (file, "b%s, ", name2);
     }
-
-    //graphviz configuration
-    fprintf (file, "\n");
-    fprintf (file, "  graphviz-algorithm = neato;\n");
-
+    fprintf (file,
+        ");\n"
+        "  };\n");
     //close
     fprintf (file, "}\n");
     fclose (file);
   }
 }
 
+void TRACE_set_network_update_mechanism (void)
+{
+  if (TRACE_is_enabled()){
+    if (TRACE_categorized() || TRACE_uncategorized()){
+      XBT_INFO ("Tracing resource utilization active, network/optim configuration now set to Full.");
+      xbt_cfg_set_string (_surf_cfg_set, "network/optim", "Full");
+    }
+  }
+}
+
 #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