Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics
[simgrid.git] / src / instr / instr_config.cpp
index f81f5d9..a1fe6b2 100644 (file)
@@ -4,14 +4,19 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "include/xbt/config.hpp"
+#include "simgrid/s4u/Engine.hpp"
 #include "src/instr/instr_private.hpp"
 #include "surf/surf.hpp"
+#include "xbt/virtu.h" /* sg_cmdline */
+#include <fstream>
 #include <string>
 #include <vector>
 
 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");
 
+std::ofstream tracing_file;
+
 #define OPT_TRACING_BASIC                "tracing/basic"
 #define OPT_TRACING_BUFFER               "tracing/buffer"
 #define OPT_TRACING_CATEGORIZED          "tracing/categorized"
@@ -75,72 +80,83 @@ static bool trace_active     = false;
 
 simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje;
 
-int TRACE_start()
+static void TRACE_start()
 {
+  if (trace_active)
+    return;
+
   // tracing system must be:
   //    - enabled (with --cfg=tracing:yes)
   //    - already configured (TRACE_global_init already called)
   if (TRACE_is_enabled()) {
+    instr_define_callbacks();
 
     XBT_DEBUG("Tracing starts");
     /* init the tracing module to generate the right output */
+    std::string format = simgrid::config::get_value<std::string>(OPT_TRACING_FORMAT);
+    XBT_DEBUG("Tracing format %s", format.c_str());
 
     /* open the trace file(s) */
-    std::string format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
-    XBT_DEBUG("Tracing format %s\n", format.c_str());
-    if (format == "Paje") {
-      TRACE_paje_start();
-    } else if (format == "TI") {
-      simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti;
-      TRACE_TI_start();
-    }else{
-      xbt_die("Unknown trace format :%s ", format.c_str());
+    std::string filename = TRACE_get_filename();
+    tracing_file.open(filename.c_str(), std::ofstream::out);
+    if (tracing_file.fail()) {
+      THROWF(system_error, 1, "Tracefile %s could not be opened for writing.", filename.c_str());
     }
 
-    /* activate trace */
-    if (trace_active) {
-      THROWF(tracing_error, 0, "Tracing is already active");
+    XBT_DEBUG("Filename %s is open for writing", filename.c_str());
+
+    if (format == "Paje") {
+      /* output generator version */
+      tracing_file << "#This file was generated using SimGrid-" << SIMGRID_VERSION_MAJOR << "." << SIMGRID_VERSION_MINOR
+                   << "." << SIMGRID_VERSION_PATCH << std::endl;
+      tracing_file << "#[";
+      unsigned int cpt;
+      char* str;
+      xbt_dynar_foreach (xbt_cmdline, cpt, str) {
+        tracing_file << str << " ";
+      }
+      tracing_file << "]" << std::endl;
     }
+
+    /* output one line comment */
+    dump_comment(simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT));
+
+    /* output comment file */
+    dump_comment_file(simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT_FILE));
+
+    if (format == "Paje") {
+      /* output Pajé header */
+      TRACE_header(TRACE_basic(), TRACE_display_sizes());
+    } else
+      simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti;
+
     trace_active = true;
     XBT_DEBUG("Tracing is on");
   }
-  return 0;
 }
 
-int TRACE_end()
+static void TRACE_end()
 {
-  int retval;
-  if (not trace_active) {
-    retval = 1;
-  } else {
-    retval = 0;
-
-    /* dump trace buffer */
-    TRACE_last_timestamp_to_dump = surf_get_clock();
-    TRACE_paje_dump_buffer(true);
-
-    simgrid::instr::Type* root_type = simgrid::instr::Container::getRoot()->type_;
-    /* destroy all data structures of tracing (and free) */
-    delete simgrid::instr::Container::getRoot();
-    delete root_type;
-
-    /* close the trace files */
-    std::string format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
-    XBT_DEBUG("Tracing format %s\n", format.c_str());
-    if (format == "Paje") {
-      TRACE_paje_end();
-    } else if (format == "TI") {
-      TRACE_TI_end();
-    }else{
-      xbt_die("Unknown trace format :%s ", format.c_str());
-    }
+  if (not trace_active)
+    return;
 
-    /* de-activate trace */
-    trace_active = false;
-    XBT_DEBUG("Tracing is off");
-    XBT_DEBUG("Tracing system is shutdown");
-  }
-  return retval;
+  /* dump trace buffer */
+  TRACE_last_timestamp_to_dump = surf_get_clock();
+  TRACE_paje_dump_buffer(true);
+
+  simgrid::instr::Type* root_type = simgrid::instr::Container::get_root()->type_;
+  /* destroy all data structures of tracing (and free) */
+  delete simgrid::instr::Container::get_root();
+  delete root_type;
+
+  /* close the trace files */
+  tracing_file.close();
+  XBT_DEBUG("Filename %s is closed", TRACE_get_filename().c_str());
+
+  /* de-activate trace */
+  trace_active = false;
+  XBT_DEBUG("Tracing is off");
+  XBT_DEBUG("Tracing system is shutdown");
 }
 
 bool TRACE_needs_platform ()
@@ -201,62 +217,52 @@ bool TRACE_uncategorized ()
 
 bool TRACE_actor_is_enabled()
 {
-  return trace_actor_enabled && TRACE_is_enabled();
+  return trace_actor_enabled && trace_enabled;
 }
 
 bool TRACE_vm_is_enabled()
 {
-  return trace_vm_enabled && TRACE_is_enabled();
+  return trace_vm_enabled && trace_enabled;
 }
 
 bool TRACE_disable_link()
 {
-  return trace_disable_link && TRACE_is_enabled();
+  return trace_disable_link && trace_enabled;
 }
 
 bool TRACE_disable_speed()
 {
-  return trace_disable_power && TRACE_is_enabled();
+  return trace_disable_power && trace_enabled;
 }
 
 bool TRACE_buffer ()
 {
-  return trace_buffer && TRACE_is_enabled();
+  return trace_buffer && trace_enabled;
 }
 
 bool TRACE_disable_destroy ()
 {
-  return trace_disable_destroy && TRACE_is_enabled();
+  return trace_disable_destroy && trace_enabled;
 }
 
 bool TRACE_basic ()
 {
-  return trace_basic && TRACE_is_enabled();
+  return trace_basic && trace_enabled;
 }
 
 bool TRACE_display_sizes ()
 {
-   return trace_display_sizes && trace_smpi_enabled && TRACE_is_enabled();
-}
-
-std::string TRACE_get_comment()
-{
-  return xbt_cfg_get_string(OPT_TRACING_COMMENT);
-}
-
-std::string TRACE_get_comment_file()
-{
-  return xbt_cfg_get_string(OPT_TRACING_COMMENT_FILE);
+  return trace_display_sizes && trace_smpi_enabled && trace_enabled;
 }
 
 int TRACE_precision ()
 {
-  return xbt_cfg_get_int(OPT_TRACING_PRECISION);
+  return simgrid::config::get_value<int>(OPT_TRACING_PRECISION);
 }
 
 std::string TRACE_get_filename()
 {
-  return xbt_cfg_get_string(OPT_TRACING_FILENAME);
+  return simgrid::config::get_value<std::string>(OPT_TRACING_FILENAME);
 }
 
 void TRACE_global_init()
@@ -266,22 +272,28 @@ void TRACE_global_init()
     return;
 
   is_initialised = true;
+
   /* name of the tracefile */
-  simgrid::config::declareFlag<std::string>(OPT_TRACING_FILENAME, "Trace file created by the instrumented SimGrid.",
-                                            "simgrid.trace");
-  simgrid::config::declareFlag<std::string>(OPT_TRACING_FORMAT, "(smpi only) Switch the output format of Tracing",
-                                            "Paje");
-  simgrid::config::declareFlag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
-                                     "(smpi only) For replay format only : output to one file only", false);
+  simgrid::config::declare_flag<std::string>(OPT_TRACING_FILENAME, "Trace file created by the instrumented SimGrid.",
+                                             "simgrid.trace");
+  simgrid::config::declare_flag<std::string>(OPT_TRACING_FORMAT, "(smpi only) Switch the output format of Tracing",
+                                             "Paje");
+  simgrid::config::declare_flag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
+                                      "(smpi only) For replay format only : output to one file only", false);
   simgrid::config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"});
-  simgrid::config::declareFlag<std::string>(OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
-                                            "");
-  simgrid::config::declareFlag<std::string>(
+  simgrid::config::declare_flag<std::string>(OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
+                                             "");
+  simgrid::config::declare_flag<std::string>(
       OPT_TRACING_COMMENT_FILE, "The contents of the file are added to the top of the trace file as comment.", "");
   simgrid::config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"});
-  simgrid::config::declareFlag<int>(OPT_TRACING_PRECISION, "Numerical precision used when timestamping events "
-                                                           "(expressed in number of digits after decimal point)",
-                                    6);
+  simgrid::config::declare_flag<int>(OPT_TRACING_PRECISION, "Numerical precision used when timestamping events "
+                                                            "(expressed in number of digits after decimal point)",
+                                     6);
+
+  /* Connect callbacks */
+  simgrid::s4u::on_platform_creation.connect(TRACE_start);
+  simgrid::s4u::on_deadlock.connect(TRACE_end);
+  simgrid::s4u::on_simulation_end.connect(TRACE_end);
 }
 
 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)