Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use s4u API in example.
[simgrid.git] / src / instr / instr_paje_containers.cpp
index c2b6515..3316dbd 100644 (file)
@@ -5,17 +5,20 @@
 
 #include "simgrid/s4u/Engine.hpp"
 #include "simgrid/s4u/Host.hpp"
-
+#include "src/instr/instr_private.hpp"
 #include "surf/surf.h"
-
-#include "src/instr/instr_private.h"
+#include <unordered_map>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
 
+extern FILE* tracing_file;
+extern std::map<container_t, FILE*> tracing_files; // TI specific
+double prefix = 0.0;                               // TI specific
+
 static container_t rootContainer = nullptr;    /* the root container */
-static xbt_dict_t allContainers = nullptr;     /* all created containers indexed by name */
-xbt_dict_t trivaNodeTypes = nullptr;     /* all host types defined */
-xbt_dict_t trivaEdgeTypes = nullptr;     /* all link types defined */
+static std::unordered_map<std::string, container_t> allContainers; /* all created containers indexed by name */
+std::set<std::string> trivaNodeTypes;           /* all host types defined */
+std::set<std::string> trivaEdgeTypes;           /* all link types defined */
 
 long long int instr_new_paje_id ()
 {
@@ -23,18 +26,9 @@ long long int instr_new_paje_id ()
   return type_id++;
 }
 
-void PJ_container_alloc ()
+container_t PJ_container_get_root()
 {
-  allContainers = xbt_dict_new_homogeneous(nullptr);
-  trivaNodeTypes = xbt_dict_new_homogeneous(xbt_free_f);
-  trivaEdgeTypes = xbt_dict_new_homogeneous(xbt_free_f);
-}
-
-void PJ_container_release ()
-{
-  xbt_dict_free (&allContainers);
-  xbt_dict_free (&trivaNodeTypes);
-  xbt_dict_free (&trivaEdgeTypes);
+  return rootContainer;
 }
 
 void PJ_container_set_root (container_t root)
@@ -42,210 +36,207 @@ void PJ_container_set_root (container_t root)
   rootContainer = root;
 }
 
-container_t PJ_container_new (const char *name, e_container_types kind, container_t father)
-{
-  if (name == nullptr){
-    THROWF (tracing_error, 0, "can't create a container with a nullptr name");
-  }
+namespace simgrid {
+namespace instr {
 
+Container::Container(std::string name, e_container_types kind, Container* father)
+    : kind_(kind), name_(name), father_(father)
+{
   static long long int container_id = 0;
-  char id_str[INSTR_DEFAULT_STR_SIZE];
-  snprintf (id_str, INSTR_DEFAULT_STR_SIZE, "%lld", container_id);
+  id_                               = std::to_string(container_id); // id (or alias) of the container
   container_id++;
 
-  container_t newContainer = xbt_new0(s_container_t, 1);
-  newContainer->name = xbt_strdup (name); // name of the container
-  newContainer->id = xbt_strdup (id_str); // id (or alias) of the container
-  newContainer->father = father;
-  sg_host_t sg_host = sg_host_by_name(name);
+  if (father_) {
+    level_ = father_->level_ + 1;
+    XBT_DEBUG("new container %s, child of %s", name.c_str(), father->name_.c_str());
+  }
 
-  //Search for network_element_t
-  switch (kind){
-    case INSTR_HOST:
-      newContainer->netpoint = sg_host->pimpl_netpoint;
-      xbt_assert(newContainer->netpoint, "Element '%s' not found", name);
+  // Search for network_element_t for AS, ROUTER and HOST
+  // Name the kind of container. For AS otherwise, the name depends on its level
+  std::string typeNameBuff;
+  switch (kind_) {
+    case INSTR_AS:
+      netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
+      xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
+      typeNameBuff = std::string("L") + std::to_string(level_);
       break;
     case INSTR_ROUTER:
-      newContainer->netpoint = simgrid::s4u::Engine::instance()->netpointByNameOrNull(name);
-      xbt_assert(newContainer->netpoint, "Element '%s' not found", name);
+      netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
+      xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
+      typeNameBuff = std::string("ROUTER");
       break;
-    case INSTR_AS:
-      newContainer->netpoint = simgrid::s4u::Engine::instance()->netpointByNameOrNull(name);
-      xbt_assert(newContainer->netpoint, "Element '%s' not found", name);
+    case INSTR_HOST:
+      netpoint_ = sg_host_by_name(name.c_str())->pimpl_netpoint;
+      xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
+      typeNameBuff = std::string("HOST");
+      break;
+    case INSTR_LINK:
+      typeNameBuff = std::string("LINK");
+      break;
+    case INSTR_SMPI:
+      typeNameBuff = std::string("MPI");
+      break;
+    case INSTR_MSG_PROCESS:
+      typeNameBuff = std::string("MSG_PROCESS");
+      break;
+    case INSTR_MSG_VM:
+      typeNameBuff = std::string("MSG_VM");
+      break;
+    case INSTR_MSG_TASK:
+      typeNameBuff = std::string("MSG_TASK");
       break;
     default:
-      newContainer->netpoint = nullptr;
+      THROWF(tracing_error, 0, "new container kind is unknown.");
       break;
   }
 
-  // level depends on level of father
-  if (newContainer->father){
-    newContainer->level = newContainer->father->level+1;
-    XBT_DEBUG("new container %s, child of %s", name, father->name);
-  }else{
-    newContainer->level = 0;
-  }
-  // type definition (method depends on kind of this new container)
-  newContainer->kind = kind;
-  if (newContainer->kind == INSTR_AS){
-    //if this container is of an AS, its type name depends on its level
-    char as_typename[INSTR_DEFAULT_STR_SIZE];
-    snprintf (as_typename, INSTR_DEFAULT_STR_SIZE, "L%d", newContainer->level);
-    if (newContainer->father){
-      newContainer->type = PJ_type_get_or_null (as_typename, newContainer->father->type);
-      if (newContainer->type == nullptr){
-        newContainer->type = PJ_type_container_new (as_typename, newContainer->father->type);
-      }
-    }else{
-      newContainer->type = PJ_type_container_new ("0", nullptr);
-    }
-  }else{
-    //otherwise, the name is its kind
-    char typeNameBuff[INSTR_DEFAULT_STR_SIZE];
-    switch (newContainer->kind){
-      case INSTR_HOST:
-        snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "HOST");
-        break;
-      case INSTR_LINK:
-        snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "LINK");
-        break;
-      case INSTR_ROUTER:
-        snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "ROUTER");
-        break;
-      case INSTR_SMPI:
-        snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MPI");
-        break;
-      case INSTR_MSG_PROCESS:
-        snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_PROCESS");
-        break;
-      case INSTR_MSG_VM:
-        snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_VM");
-        break;
-      case INSTR_MSG_TASK:
-        snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_TASK");
-        break;
-      default:
-        THROWF (tracing_error, 0, "new container kind is unknown.");
-        break;
-    }
-    type_t type = PJ_type_get_or_null (typeNameBuff, newContainer->father->type);
-    if (type == nullptr){
-      newContainer->type = PJ_type_container_new (typeNameBuff, newContainer->father->type);
-    }else{
-      newContainer->type = type;
-    }
-  }
-  newContainer->children = xbt_dict_new_homogeneous(nullptr);
-  if (newContainer->father){
-    xbt_dict_set(newContainer->father->children, newContainer->name, newContainer, nullptr);
-    LogContainerCreation(newContainer);
+  if (father_) {
+    type_ = father_->type_->getOrCreateContainerType(typeNameBuff);
+    father_->children_.insert({name_, this});
+    logCreation();
+  } else if (kind_ == INSTR_AS) {
+    type_ = Type::createRootType();
   }
 
   //register all kinds by name
-  if (xbt_dict_get_or_null(allContainers, newContainer->name) != nullptr){
-    THROWF(tracing_error, 1, "container %s already present in allContainers data structure", newContainer->name);
+  if (not allContainers.emplace(name_, this).second) {
+    THROWF(tracing_error, 1, "container %s already present in allContainers data structure", name_.c_str());
   }
 
-  xbt_dict_set (allContainers, newContainer->name, newContainer, nullptr);
-  XBT_DEBUG("Add container name '%s'",newContainer->name);
+  XBT_DEBUG("Add container name '%s'", name_.c_str());
 
   //register NODE types for triva configuration
-  if (newContainer->kind == INSTR_HOST || newContainer->kind == INSTR_LINK || newContainer->kind == INSTR_ROUTER) {
-    xbt_dict_set (trivaNodeTypes, newContainer->type->name, xbt_strdup("1"), nullptr);
-  }
-  return newContainer;
+  if (kind_ == INSTR_HOST || kind_ == INSTR_LINK || kind_ == INSTR_ROUTER)
+    trivaNodeTypes.insert(type_->getName());
 }
 
-container_t PJ_container_get (const char *name)
+Container::~Container()
 {
-  container_t ret = PJ_container_get_or_null (name);
-  if (ret == nullptr){
-    THROWF(tracing_error, 1, "container with name %s not found", name);
+  XBT_DEBUG("destroy container %s", name_.c_str());
+  // Begin with destroying my own children
+  for (auto child : children_) {
+    delete child.second;
   }
-  return ret;
+
+  // obligation to dump previous events because they might reference the container that is about to be destroyed
+  TRACE_last_timestamp_to_dump = surf_get_clock();
+  TRACE_paje_dump_buffer(true);
+
+  // trace my destruction
+  if (not TRACE_disable_destroy() && this != PJ_container_get_root()) {
+    // do not trace the container destruction if user requests or if the container is root
+    logDestruction();
+  }
+
+  // remove me from the allContainers data structure
+  allContainers.erase(name_);
 }
 
-container_t PJ_container_get_or_null (const char *name)
+Container* Container::byNameOrNull(std::string name)
 {
-  return static_cast<container_t>(name != nullptr ? xbt_dict_get_or_null(allContainers, name) : nullptr);
+  auto cont = allContainers.find(name);
+  return cont == allContainers.end() ? nullptr : cont->second;
 }
 
-container_t PJ_container_get_root ()
+Container* Container::byName(std::string name)
 {
-  return rootContainer;
+  Container* ret = Container::byNameOrNull(name);
+  if (ret == nullptr)
+    THROWF(tracing_error, 1, "container with name %s not found", name.c_str());
+
+  return ret;
 }
 
-void PJ_container_remove_from_parent (container_t child)
+void Container::removeFromParent()
 {
-  if (child == nullptr){
-    THROWF (tracing_error, 0, "can't remove from parent with a nullptr child");
-  }
-
-  container_t parent = child->father;
-  if (parent){
-    XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ",
-        child->name,
-        parent->name);
-    xbt_dict_remove (parent->children, child->name);
+  if (father_) {
+    XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", name_.c_str(), father_->name_.c_str());
+    father_->children_.erase(name_);
   }
 }
 
-void PJ_container_free (container_t container)
+void Container::logCreation()
 {
-  if (container == nullptr){
-    THROWF (tracing_error, 0, "trying to free a nullptr container");
-  }
-  XBT_DEBUG("destroy container %s", container->name);
+  double timestamp = SIMIX_get_clock();
+  std::stringstream stream;
+
+  XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, simgrid::instr::PAJE_CreateContainer, timestamp);
+
+  if (instr_fmt_type == instr_fmt_paje) {
+    stream << std::fixed << std::setprecision(TRACE_precision());
+    stream << simgrid::instr::PAJE_CreateContainer;
+    stream << " ";
+    /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
+    if (timestamp < 1e-12)
+      stream << 0;
+    else
+      stream << timestamp;
+    stream << " " << id_ << " " << type_->getId() << " " << father_->id_ << " \"" << name_ << "\"" << std::endl;
+    fprintf(tracing_file, "%s", stream.str().c_str());
+    XBT_DEBUG("Dump %s", stream.str().c_str());
+    stream.str("");
+    stream.clear();
+  } else if (instr_fmt_type == instr_fmt_TI) {
+    // if we are in the mode with only one file
+    static FILE* ti_unique_file = nullptr;
+
+    if (tracing_files.empty()) {
+      // generate unique run id with time
+      prefix = xbt_os_time();
+    }
 
-  //obligation to dump previous events because they might
-  //reference the container that is about to be destroyed
-  TRACE_last_timestamp_to_dump = surf_get_clock();
-  TRACE_paje_dump_buffer(1);
+    if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
+      char* folder_name = bprintf("%s_files", TRACE_get_filename());
+      char* filename    = bprintf("%s/%f_%s.txt", folder_name, prefix, name_.c_str());
+#ifdef WIN32
+      _mkdir(folder_name);
+#else
+      mkdir(folder_name, S_IRWXU | S_IRWXG | S_IRWXO);
+#endif
+      ti_unique_file = fopen(filename, "w");
+      xbt_assert(ti_unique_file, "Tracefile %s could not be opened for writing: %s", filename, strerror(errno));
+      fprintf(tracing_file, "%s\n", filename);
+
+      xbt_free(folder_name);
+      xbt_free(filename);
+    }
 
-  //trace my destruction
-  if (not TRACE_disable_destroy() && container != PJ_container_get_root()) {
-    //do not trace the container destruction if user requests
-    //or if the container is root
-    LogContainerDestruction(container);
+    tracing_files.insert({this, ti_unique_file});
+  } else {
+    THROW_IMPOSSIBLE;
   }
-
-  //remove it from allContainers data structure
-  xbt_dict_remove (allContainers, container->name);
-
-  //free
-  xbt_free (container->name);
-  xbt_free (container->id);
-  xbt_dict_free (&container->children);
-  xbt_free (container);
-  container = nullptr;
 }
 
-static void recursiveDestroyContainer (container_t container)
+void Container::logDestruction()
 {
-  if (container == nullptr){
-    THROWF (tracing_error, 0, "trying to recursively destroy a nullptr container");
-  }
-  XBT_DEBUG("recursiveDestroyContainer %s", container->name);
-  xbt_dict_cursor_t cursor = nullptr;
-  container_t child;
-  char *child_name;
-  xbt_dict_foreach(container->children, cursor, child_name, child) {
-    recursiveDestroyContainer (child);
+  std::stringstream stream;
+  double timestamp = SIMIX_get_clock();
+
+  XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, simgrid::instr::PAJE_DestroyContainer, timestamp);
+
+  if (instr_fmt_type == instr_fmt_paje) {
+    stream << std::fixed << std::setprecision(TRACE_precision());
+    stream << simgrid::instr::PAJE_DestroyContainer;
+    stream << " ";
+    /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
+    if (timestamp < 1e-12)
+      stream << 0;
+    else
+      stream << timestamp;
+    stream << " " << type_->getId() << " " << id_ << std::endl;
+    fprintf(tracing_file, "%s", stream.str().c_str());
+    XBT_DEBUG("Dump %s", stream.str().c_str());
+    stream.str("");
+    stream.clear();
+  } else if (instr_fmt_type == instr_fmt_TI) {
+    if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
+      FILE* f = tracing_files.at(this);
+      fclose(f);
+    }
+    tracing_files.erase(this);
+  } else {
+    THROW_IMPOSSIBLE;
   }
-  PJ_container_free (container);
 }
-
-void PJ_container_free_all ()
-{
-  container_t root = PJ_container_get_root();
-  if (root == nullptr){
-    THROWF (tracing_error, 0, "trying to free all containers, but root is nullptr");
-  }
-  recursiveDestroyContainer (root);
-  rootContainer = nullptr;
-
-  //checks
-  if (not xbt_dict_is_empty(allContainers)) {
-    THROWF(tracing_error, 0, "some containers still present even after destroying all of them");
-  }
+}
 }