Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Don't return when debug is enabled.
[simgrid.git] / src / instr / instr_paje_trace.cpp
index d436124..9c094b6 100644 (file)
@@ -1,28 +1,85 @@
-/* Copyright (c) 2010-2016. The SimGrid Team.
+/* Copyright (c) 2010-2017. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "src/instr/instr_private.h"
-#include "xbt/virtu.h" /* sg_cmdline */
-#include <sstream>
-#include <vector>
-#include <iomanip> /** std::setprecision **/
 #include "simgrid/sg_config.h"
+#include "src/instr/instr_private.hpp"
+#include "src/instr/instr_smpi.hpp"
+#include "src/smpi/include/private.hpp"
+#include "typeinfo"
+#include "xbt/virtu.h" /* sg_cmdline */
+#include <fstream>
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_paje_trace, instr_trace, "tracing event system");
-
-extern FILE * tracing_file;
-extern s_instr_trace_writer_t active_writer;
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_paje_trace, instr, "tracing event system");
 
 static std::stringstream stream;
+FILE *tracing_file = nullptr;
+
+std::vector<simgrid::instr::PajeEvent*> buffer;
+void buffer_debug(std::vector<simgrid::instr::PajeEvent*>* buf);
+
+void dump_comment(std::string comment)
+{
+  if (comment.empty())
+    return;
+  fprintf(tracing_file, "# %s\n", comment.c_str());
+}
+
+void dump_comment_file(std::string filename)
+{
+  if (filename.empty())
+    return;
+  std::ifstream* fs = new std::ifstream();
+  fs->open(filename.c_str(), std::ifstream::in);
+
+  if (fs->fail()) {
+    THROWF(system_error, 1, "Comment file %s could not be opened for reading.", filename.c_str());
+  }
+  while (not fs->eof()) {
+    std::string line;
+    fprintf (tracing_file, "# ");
+    std::getline(*fs, line);
+    fprintf(tracing_file, "%s", line.c_str());
+  }
+  fs->close();
+}
+
+double TRACE_last_timestamp_to_dump = 0;
+//dumps the trace file until the timestamp TRACE_last_timestamp_to_dump
+void TRACE_paje_dump_buffer(bool force)
+{
+  if (not TRACE_is_enabled())
+    return;
+  XBT_DEBUG("%s: dump until %f. starts", __FUNCTION__, TRACE_last_timestamp_to_dump);
+  if (force){
+    for (auto const& event : buffer) {
+      event->print();
+      delete event;
+    }
+    buffer.clear();
+  }else{
+    std::vector<simgrid::instr::PajeEvent*>::iterator i = buffer.begin();
+    for (auto const& event : buffer) {
+      double head_timestamp = event->timestamp_;
+      if (head_timestamp > TRACE_last_timestamp_to_dump)
+        break;
+      event->print();
+      delete event;
+      ++i;
+    }
+    buffer.erase(buffer.begin(), i);
+  }
+  XBT_DEBUG("%s: ends", __FUNCTION__);
+}
 
-void buffer_debug(std::vector<PajeEvent*> *buf);
-void buffer_debug(std::vector<PajeEvent*> *buf) {
-  return;
+void buffer_debug(std::vector<simgrid::instr::PajeEvent*>* buf)
+{
+  if (not XBT_LOG_ISENABLED(instr_paje_trace, xbt_log_priority_debug))
+    return;
   XBT_DEBUG(">>>>>> Dump the state of the buffer. %zu events", buf->size());
-  for (auto event :*buf){
+  for (auto const& event : *buf) {
     event->print();
     XBT_DEBUG("%p %s", event, stream.str().c_str());
     stream.str("");
@@ -31,28 +88,36 @@ void buffer_debug(std::vector<PajeEvent*> *buf) {
   XBT_DEBUG("<<<<<<");
 }
 
-static void init_stream(PajeEvent* event) {
-  stream << std::fixed << std::setprecision(TRACE_precision());
-  stream << (int) event->event_type;
-}
+/* internal do the instrumentation module */
+void simgrid::instr::PajeEvent::insertIntoBuffer()
+{
+  if (not TRACE_buffer()) {
+    print();
+    delete this;
+    return;
+  }
+  buffer_debug(&buffer);
+
+  XBT_DEBUG("%s: insert event_type=%u, timestamp=%f, buffersize=%zu)", __FUNCTION__, eventType_, timestamp_,
+            buffer.size());
+  std::vector<simgrid::instr::PajeEvent*>::reverse_iterator i;
+  for (i = buffer.rbegin(); i != buffer.rend(); ++i) {
+    simgrid::instr::PajeEvent* e1 = *i;
+    XBT_DEBUG("compare to %p is of type %u; timestamp:%f", e1, e1->eventType_, e1->timestamp_);
+    if (e1->timestamp_ <= timestamp_)
+      break;
+  }
+  if (i == buffer.rend())
+    XBT_DEBUG("%s: inserted at beginning", __FUNCTION__);
+  else if (i == buffer.rbegin())
+    XBT_DEBUG("%s: inserted at end", __FUNCTION__);
+  else
+    XBT_DEBUG("%s: inserted at pos= %zd from its end", __FUNCTION__, std::distance(buffer.rbegin(), i));
+  buffer.insert(i.base(), this);
 
-static void print_row() {
-  stream << std::endl;
-  fprintf(tracing_file, "%s", stream.str().c_str());
-  XBT_DEBUG("Dump %s", stream.str().c_str());
-  stream.str("");
-  stream.clear();
+  buffer_debug(&buffer);
 }
 
-static void print_timestamp(PajeEvent* event) {
-  stream << " ";
-  /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
-  if (event->timestamp < 1e-12)
-    stream << 0;
-  else 
-    stream << event->timestamp;
-}  
-
 void TRACE_paje_start() {
   char *filename = TRACE_get_filename();
   tracing_file = fopen(filename, "w");
@@ -89,220 +154,25 @@ void TRACE_paje_end() {
   XBT_DEBUG("Filename %s is closed", filename);
 }
 
-void DefineContainerEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  stream << " " << type->id
-         << " " << type->father->id
-         << " " << type->name;
-  print_row();
-}
-
-void DefineVariableTypeEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  stream << " " << type->id
-         << " " << type->father->id
-         << " " << type->name;
-  if (type->color)
-    stream << " \"" << type->color << "\"";
-  print_row();
-}
-
-void DefineStateTypeEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  stream << " " << type->id
-         << " " << type->father->id
-         << " " << type->name;
-  print_row();
-}
-
-void DefineEventTypeEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  stream << " " << type->id
-         << " " << type->father->id
-         << " " << type->name;
-  print_row();
-}
-
-void DefineLinkTypeEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream (this);
-  stream << " " << type->id 
-         << " " << type->father->id 
-         << " " << source->id 
-         << " " << dest->id 
-         << " " << type->name;
-  print_row();
-}
-
-void DefineEntityValueEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  stream << " "   << value->id
-         << " "   << value->father->id
-         << " "   << value->name;
-  if(value->color)
-    stream << " \"" << value->color << "\"";
-  print_row();
-}
-
-void CreateContainerEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " "   << container->id
-         << " "   << container->type->id
-         << " "   << container->father->id
-         << " \"" << container->name << "\"";
-
-  print_row();
-}
-
-void DestroyContainerEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " "   << container->type->id
-         << " "   << container->id;
-
-  print_row();
-}
-
-void SetVariableEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " << type->id
-         << " " << container->id
-         << " " << value;
-  print_row();
-}
-
-void AddVariableEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " << type->id
-         << " " << container->id
-         << " " << value;
-  print_row();
-}
-
-void SubVariableEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " << type->id
-         << " " << container->id
-         << " " << value;
-  print_row();
-}
-
-void SetStateEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " << type->id
-         << " " << container->id;
-  stream << " " <<value->id;
-#if HAVE_SMPI
-  if (xbt_cfg_get_boolean("smpi/trace-call-location")) {
-    stream << " \"" << filename
-           << "\" " << linenumber;
-  }
-#endif
-  print_row();
-}
-
-void PushStateEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " << type->id
-         << " " << container->id;
-  stream << " " <<value->id;
-
-  if (TRACE_display_sizes()) {
-    stream << " ";
-    if (extra != nullptr) {
-      stream << static_cast<instr_extra_data>(extra)->send_size;
-    }
-    else {
-      stream << 0;
-    }
-  }
-#if HAVE_SMPI
-  if (xbt_cfg_get_boolean("smpi/trace-call-location")) {
-    stream << " \"" << filename
-           << "\" " << linenumber;
-  }
-#endif
-  print_row();
-
-  if (extra != nullptr) {
-    if (static_cast<instr_extra_data>(extra)->sendcounts != nullptr)
-      xbt_free(static_cast<instr_extra_data>(extra)->sendcounts);
-    if (static_cast<instr_extra_data>(extra)->recvcounts != nullptr)
-      xbt_free(static_cast<instr_extra_data>(extra)->recvcounts);
-    xbt_free(extra);
-  }
-}
-
-void PopStateEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " << type->id
-         << " " << container->id;
-  print_row();
-}
 
-void ResetStateEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " << type->id
-         << " " << container->id;
-  print_row();
-}
+void TRACE_TI_start()
+{
+  char *filename = TRACE_get_filename();
+  tracing_file = fopen(filename, "w");
+  if (tracing_file == nullptr)
+    THROWF(system_error, 1, "Tracefile %s could not be opened for writing.", filename);
 
-void StartLinkEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " <<type->id
-         << " " <<container->id
-         << " " <<value;
-  stream << " " << sourceContainer->id
-         << " " << key;
+  XBT_DEBUG("Filename %s is open for writing", filename);
 
-  if (TRACE_display_sizes()) {
-    stream << " " << size;
-  }
-  print_row();
-}
+  /* output one line comment */
+  dump_comment(TRACE_get_comment());
 
-void EndLinkEvent::print() {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream(this);
-  print_timestamp(this);
-  stream << " " <<type->id
-         << " " <<container->id
-         << " " <<value;
-  stream << " " << destContainer->id
-         << " " << key;
-  print_row();
+  /* output comment file */
+  dump_comment_file(TRACE_get_comment_file());
 }
 
-void NewEvent::print () {
-  XBT_DEBUG("%s: event_type=%d, timestamp=%.*f", __FUNCTION__, (int)event_type, TRACE_precision(), timestamp);
-  init_stream (this);
-  print_timestamp(this);
-  stream << " " << type->id
-         << " " << container->id
-         << " " << value->id;
-  print_row();
+void TRACE_TI_end()
+{
+  fclose(tracing_file);
+  XBT_DEBUG("Filename %s is closed", TRACE_get_filename());
 }