src/instr/instr_paje_containers.cpp

   1 /* Copyright (c) 2010-2018. 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
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
  11
  12 extern FILE* tracing_file;
  13 extern std::map<container_t, FILE*> tracing_files; // TI specific
  14 double prefix = 0.0;                               // TI specific
  15
  16 static container_t rootContainer = nullptr;    /* the root container */
  17 static std::map<std::string, container_t> allContainers; /* all created containers indexed by name */
  18 std::set<std::string> trivaNodeTypes;           /* all host types defined */
  19 std::set<std::string> trivaEdgeTypes;           /* all link types defined */
  20
  21 long long int instr_new_paje_id ()
  22 {
  23   static long long int type_id = 0;
  24   return type_id++;
  25 }
  26
  27 namespace simgrid {
  28 namespace instr {
  29
  30 container_t Container::getRoot()
  31 {
  32   return rootContainer;
  33 }
  34
  35 NetZoneContainer::NetZoneContainer(std::string name, unsigned int level, NetZoneContainer* father)
  36     : Container::Container(name, "", father)
  37 {
  38   netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
  39   xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
  40   if (father_) {
  41     type_ = father_->type_->getOrCreateContainerType(std::string("L") + std::to_string(level));
  42     father_->children_.insert({get_name(), this});
  43     logCreation();
  44   } else {
  45     type_         = new ContainerType("0");
  46     rootContainer = this;
  47   }
  48 }
  49
  50 RouterContainer::RouterContainer(std::string name, Container* father) : Container::Container(name, "ROUTER", father)
  51 {
  52   xbt_assert(father, "Only the Root container has no father");
  53
  54   netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
  55   xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
  56
  57   trivaNodeTypes.insert(type_->get_name());
  58 }
  59
  60 HostContainer::HostContainer(simgrid::s4u::Host& host, NetZoneContainer* father)
  61     : Container::Container(host.get_cname(), "HOST", father)
  62 {
  63   xbt_assert(father, "Only the Root container has no father");
  64
  65   netpoint_ = host.pimpl_netpoint;
  66   xbt_assert(netpoint_, "Element '%s' not found", host.get_cname());
  67
  68   trivaNodeTypes.insert(type_->get_name());
  69 }
  70
  71 Container::Container(std::string name, std::string type_name, Container* father) : name_(name), father_(father)
  72 {
  73   static long long int container_id = 0;
  74   id_                               = container_id; // id (or alias) of the container
  75   container_id++;
  76
  77   if (father_) {
  78     XBT_DEBUG("new container %s, child of %s", name.c_str(), father->name_.c_str());
  79
  80     if (not type_name.empty()) {
  81       type_ = father_->type_->getOrCreateContainerType(type_name);
  82       father_->children_.insert({name_, this});
  83       logCreation();
  84     }
  85   }
  86
  87   //register all kinds by name
  88   if (not allContainers.emplace(name_, this).second)
  89     THROWF(tracing_error, 1, "container %s already present in allContainers data structure", name_.c_str());
  90
  91   XBT_DEBUG("Add container name '%s'", name_.c_str());
  92
  93   //register NODE types for triva configuration
  94   if (type_name == "LINK")
  95     trivaNodeTypes.insert(type_->get_name());
  96 }
  97
  98 Container::~Container()
  99 {
 100   XBT_DEBUG("destroy container %s", name_.c_str());
 101   // Begin with destroying my own children
 102   for (auto child : children_)
 103     delete child.second;
 104
 105   // obligation to dump previous events because they might reference the container that is about to be destroyed
 106   TRACE_last_timestamp_to_dump = SIMIX_get_clock();
 107   TRACE_paje_dump_buffer(true);
 108
 109   // trace my destruction, but not if user requests so or if the container is root
 110   if (not TRACE_disable_destroy() && this != Container::getRoot())
 111     logDestruction();
 112
 113   // remove me from the allContainers data structure
 114   allContainers.erase(name_);
 115 }
 116
 117 void Container::createChild(std::string name, std::string type_name)
 118 {
 119   new Container(name, type_name, this);
 120 }
 121
 122 Container* Container::byNameOrNull(std::string name)
 123 {
 124   auto cont = allContainers.find(name);
 125   return cont == allContainers.end() ? nullptr : cont->second;
 126 }
 127
 128 Container* Container::byName(std::string name)
 129 {
 130   Container* ret = Container::byNameOrNull(name);
 131   if (ret == nullptr)
 132     THROWF(tracing_error, 1, "container with name %s not found", name.c_str());
 133
 134   return ret;
 135 }
 136
 137 void Container::removeFromParent()
 138 {
 139   if (father_) {
 140     XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", get_cname(), father_->get_cname());
 141     father_->children_.erase(name_);
 142   }
 143   delete this;
 144 }
 145
 146 void Container::logCreation()
 147 {
 148   double timestamp = SIMIX_get_clock();
 149   std::stringstream stream;
 150
 151   XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_CreateContainer, timestamp);
 152
 153   if (instr_fmt_type == instr_fmt_paje) {
 154     stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_CreateContainer << " ";
 155     stream << timestamp << " " << id_ << " " << type_->get_id() << " " << father_->id_ << " \"" << name_ << "\"";
 156     XBT_DEBUG("Dump %s", stream.str().c_str());
 157     fprintf(tracing_file, "%s\n", stream.str().c_str());
 158   } else if (instr_fmt_type == instr_fmt_TI) {
 159     // if we are in the mode with only one file
 160     static FILE* ti_unique_file = nullptr;
 161
 162     if (tracing_files.empty()) {
 163       // generate unique run id with time
 164       prefix = xbt_os_time();
 165     }
 166
 167     if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
 168       std::string folder_name = TRACE_get_filename() + "_files";
 169       std::string filename    = folder_name + "/" + std::to_string(prefix) + "_" + name_ + ".txt";
 170 #ifdef WIN32
 171       _mkdir(folder_name.c_str());
 172 #else
 173       mkdir(folder_name.c_str(), S_IRWXU | S_IRWXG | S_IRWXO);
 174 #endif
 175       ti_unique_file = fopen(filename.c_str(), "w");
 176       xbt_assert(ti_unique_file, "Tracefile %s could not be opened for writing: %s", filename.c_str(), strerror(errno));
 177       fprintf(tracing_file, "%s\n", filename.c_str());
 178     }
 179     tracing_files.insert({this, ti_unique_file});
 180   } else {
 181     THROW_IMPOSSIBLE;
 182   }
 183 }
 184
 185 void Container::logDestruction()
 186 {
 187   std::stringstream stream;
 188   double timestamp = SIMIX_get_clock();
 189
 190   XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_DestroyContainer, timestamp);
 191
 192   if (instr_fmt_type == instr_fmt_paje) {
 193     stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_DestroyContainer << " ";
 194     stream << timestamp << " " << type_->get_id() << " " << id_;
 195     XBT_DEBUG("Dump %s", stream.str().c_str());
 196     fprintf(tracing_file, "%s\n", stream.str().c_str());
 197   } else if (instr_fmt_type == instr_fmt_TI) {
 198     if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
 199       fclose(tracing_files.at(this));
 200     }
 201     tracing_files.erase(this);
 202   } else {
 203     THROW_IMPOSSIBLE;
 204   }
 205 }
 206
 207 StateType* Container::getState(std::string name)
 208 {
 209   StateType* ret = dynamic_cast<StateType*>(type_->byName(name));
 210   ret->setCallingContainer(this);
 211   return ret;
 212 }
 213
 214 LinkType* Container::getLink(std::string name)
 215 {
 216   LinkType* ret = dynamic_cast<LinkType*>(type_->byName(name));
 217   ret->setCallingContainer(this);
 218   return ret;
 219 }
 220
 221 VariableType* Container::getVariable(std::string name)
 222 {
 223   VariableType* ret = dynamic_cast<VariableType*>(type_->byName(name));
 224   ret->setCallingContainer(this);
 225   return ret;
 226 }
 227 }
 228 }