src/instr/instr_paje_containers.cpp

   1 /* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/s4u/Engine.hpp"
   7 #include "simgrid/s4u/Host.hpp"
   8 #include "src/instr/instr_private.hpp"
   9 #include "surf/surf.h"
  10 #include <unordered_map>
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
  13
  14 extern FILE* tracing_file;
  15 extern std::map<container_t, FILE*> tracing_files; // TI specific
  16 double prefix = 0.0;                               // TI specific
  17
  18 static container_t rootContainer = nullptr;    /* the root container */
  19 static std::unordered_map<std::string, container_t> allContainers; /* all created containers indexed by name */
  20 std::set<std::string> trivaNodeTypes;           /* all host types defined */
  21 std::set<std::string> trivaEdgeTypes;           /* all link types defined */
  22
  23 long long int instr_new_paje_id ()
  24 {
  25   static long long int type_id = 0;
  26   return type_id++;
  27 }
  28
  29 container_t PJ_container_get_root()
  30 {
  31   return rootContainer;
  32 }
  33
  34 void PJ_container_set_root (container_t root)
  35 {
  36   rootContainer = root;
  37 }
  38
  39 namespace simgrid {
  40 namespace instr {
  41
  42 Container::Container(std::string name, e_container_types kind, Container* father)
  43     : kind_(kind), name_(name), father_(father)
  44 {
  45   static long long int container_id = 0;
  46   id_                               = std::to_string(container_id); // id (or alias) of the container
  47   container_id++;
  48
  49   if (father_) {
  50     level_ = father_->level_ + 1;
  51     XBT_DEBUG("new container %s, child of %s", name.c_str(), father->name_.c_str());
  52   }
  53
  54   // Search for network_element_t for AS, ROUTER and HOST
  55   // Name the kind of container. For AS otherwise, the name depends on its level
  56   std::string typeNameBuff;
  57   switch (kind_) {
  58     case INSTR_AS:
  59       netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
  60       xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
  61       typeNameBuff = std::string("L") + std::to_string(level_);
  62       break;
  63     case INSTR_ROUTER:
  64       netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
  65       xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
  66       typeNameBuff = std::string("ROUTER");
  67       break;
  68     case INSTR_HOST:
  69       netpoint_ = sg_host_by_name(name.c_str())->pimpl_netpoint;
  70       xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
  71       typeNameBuff = std::string("HOST");
  72       break;
  73     case INSTR_LINK:
  74       typeNameBuff = std::string("LINK");
  75       break;
  76     case INSTR_SMPI:
  77       typeNameBuff = std::string("MPI");
  78       break;
  79     case INSTR_MSG_PROCESS:
  80       typeNameBuff = std::string("MSG_PROCESS");
  81       break;
  82     case INSTR_MSG_VM:
  83       typeNameBuff = std::string("MSG_VM");
  84       break;
  85     case INSTR_MSG_TASK:
  86       typeNameBuff = std::string("MSG_TASK");
  87       break;
  88     default:
  89       THROWF(tracing_error, 0, "new container kind is unknown.");
  90       break;
  91   }
  92
  93   if (father_) {
  94     type_ = father_->type_->getOrCreateContainerType(typeNameBuff);
  95     father_->children_.insert({name_, this});
  96     logCreation();
  97   } else if (kind_ == INSTR_AS) {
  98     type_ = Type::createRootType();
  99   }
 100
 101   //register all kinds by name
 102   if (not allContainers.emplace(name_, this).second) {
 103     THROWF(tracing_error, 1, "container %s already present in allContainers data structure", name_.c_str());
 104   }
 105
 106   XBT_DEBUG("Add container name '%s'", name_.c_str());
 107
 108   //register NODE types for triva configuration
 109   if (kind_ == INSTR_HOST || kind_ == INSTR_LINK || kind_ == INSTR_ROUTER)
 110     trivaNodeTypes.insert(type_->getName());
 111 }
 112
 113 Container::~Container()
 114 {
 115   XBT_DEBUG("destroy container %s", name_.c_str());
 116   // Begin with destroying my own children
 117   for (auto child : children_) {
 118     delete child.second;
 119   }
 120
 121   // obligation to dump previous events because they might reference the container that is about to be destroyed
 122   TRACE_last_timestamp_to_dump = surf_get_clock();
 123   TRACE_paje_dump_buffer(true);
 124
 125   // trace my destruction
 126   if (not TRACE_disable_destroy() && this != PJ_container_get_root()) {
 127     // do not trace the container destruction if user requests or if the container is root
 128     logDestruction();
 129   }
 130
 131   // remove me from the allContainers data structure
 132   allContainers.erase(name_);
 133 }
 134
 135 Container* Container::byNameOrNull(std::string name)
 136 {
 137   auto cont = allContainers.find(name);
 138   return cont == allContainers.end() ? nullptr : cont->second;
 139 }
 140
 141 Container* Container::byName(std::string name)
 142 {
 143   Container* ret = Container::byNameOrNull(name);
 144   if (ret == nullptr)
 145     THROWF(tracing_error, 1, "container with name %s not found", name.c_str());
 146
 147   return ret;
 148 }
 149
 150 void Container::removeFromParent()
 151 {
 152   if (father_) {
 153     XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", name_.c_str(), father_->name_.c_str());
 154     father_->children_.erase(name_);
 155   }
 156 }
 157
 158 void Container::logCreation()
 159 {
 160   double timestamp = SIMIX_get_clock();
 161   std::stringstream stream;
 162
 163   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, simgrid::instr::PAJE_CreateContainer, timestamp);
 164
 165   if (instr_fmt_type == instr_fmt_paje) {
 166     stream << std::fixed << std::setprecision(TRACE_precision());
 167     stream << simgrid::instr::PAJE_CreateContainer;
 168     stream << " ";
 169     /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
 170     if (timestamp < 1e-12)
 171       stream << 0;
 172     else
 173       stream << timestamp;
 174     stream << " " << id_ << " " << type_->getId() << " " << father_->id_ << " \"" << name_ << "\"" << std::endl;
 175     fprintf(tracing_file, "%s", stream.str().c_str());
 176     XBT_DEBUG("Dump %s", stream.str().c_str());
 177     stream.str("");
 178     stream.clear();
 179   } else if (instr_fmt_type == instr_fmt_TI) {
 180     // if we are in the mode with only one file
 181     static FILE* ti_unique_file = nullptr;
 182
 183     if (tracing_files.empty()) {
 184       // generate unique run id with time
 185       prefix = xbt_os_time();
 186     }
 187
 188     if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
 189       char* folder_name = bprintf("%s_files", TRACE_get_filename());
 190       char* filename    = bprintf("%s/%f_%s.txt", folder_name, prefix, name_.c_str());
 191 #ifdef WIN32
 192       _mkdir(folder_name);
 193 #else
 194       mkdir(folder_name, S_IRWXU | S_IRWXG | S_IRWXO);
 195 #endif
 196       ti_unique_file = fopen(filename, "w");
 197       xbt_assert(ti_unique_file, "Tracefile %s could not be opened for writing: %s", filename, strerror(errno));
 198       fprintf(tracing_file, "%s\n", filename);
 199
 200       xbt_free(folder_name);
 201       xbt_free(filename);
 202     }
 203
 204     tracing_files.insert({this, ti_unique_file});
 205   } else {
 206     THROW_IMPOSSIBLE;
 207   }
 208 }
 209
 210 void Container::logDestruction()
 211 {
 212   std::stringstream stream;
 213   double timestamp = SIMIX_get_clock();
 214
 215   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, simgrid::instr::PAJE_DestroyContainer, timestamp);
 216
 217   if (instr_fmt_type == instr_fmt_paje) {
 218     stream << std::fixed << std::setprecision(TRACE_precision());
 219     stream << simgrid::instr::PAJE_DestroyContainer;
 220     stream << " ";
 221     /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
 222     if (timestamp < 1e-12)
 223       stream << 0;
 224     else
 225       stream << timestamp;
 226     stream << " " << type_->getId() << " " << id_ << std::endl;
 227     fprintf(tracing_file, "%s", stream.str().c_str());
 228     XBT_DEBUG("Dump %s", stream.str().c_str());
 229     stream.str("");
 230     stream.clear();
 231   } else if (instr_fmt_type == instr_fmt_TI) {
 232     if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
 233       FILE* f = tracing_files.at(this);
 234       fclose(f);
 235     }
 236     tracing_files.erase(this);
 237   } else {
 238     THROW_IMPOSSIBLE;
 239   }
 240 }
 241 }
 242 }