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
   9 #include "surf/surf.h"
  10
  11 #include "src/instr/instr_private.h"
  12
  13 #include <unordered_map>
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
  16
  17 static container_t rootContainer = nullptr;    /* the root container */
  18 static std::unordered_map<std::string, simgrid::instr::Container*>
  19     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 void PJ_container_set_root (container_t root)
  30 {
  31   rootContainer = root;
  32 }
  33
  34 simgrid::instr::Container::Container(const char* name, simgrid::instr::e_container_types kind, Container* father)
  35     : name_(xbt_strdup(name)), father_(father)
  36 {
  37   xbt_assert(name != nullptr, "Container name cannot be nullptr");
  38
  39   static long long int container_id = 0;
  40   id_                               = bprintf("%lld", container_id); // id (or alias) of the container
  41   container_id++;
  42
  43   //Search for network_element_t
  44   switch (kind){
  45     case simgrid::instr::INSTR_HOST:
  46       this->netpoint_ = sg_host_by_name(name)->pimpl_netpoint;
  47       xbt_assert(this->netpoint_, "Element '%s' not found", name);
  48       break;
  49     case simgrid::instr::INSTR_ROUTER:
  50       this->netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
  51       xbt_assert(this->netpoint_, "Element '%s' not found", name);
  52       break;
  53     case simgrid::instr::INSTR_AS:
  54       this->netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
  55       xbt_assert(this->netpoint_, "Element '%s' not found", name);
  56       break;
  57     default:
  58       this->netpoint_ = nullptr;
  59       break;
  60   }
  61
  62   if (father_) {
  63     this->level_ = father_->level_ + 1;
  64     XBT_DEBUG("new container %s, child of %s", name, father->name_);
  65   }
  66
  67   // type definition (method depends on kind of this new container)
  68   this->kind_ = kind;
  69   if (this->kind_ == simgrid::instr::INSTR_AS) {
  70     //if this container is of an AS, its type name depends on its level
  71     char as_typename[INSTR_DEFAULT_STR_SIZE];
  72     snprintf(as_typename, INSTR_DEFAULT_STR_SIZE, "L%d", this->level_);
  73     if (this->father_) {
  74       this->type_ = this->father_->type_->getChildOrNull(as_typename);
  75       if (this->type_ == nullptr) {
  76         this->type_ = simgrid::instr::Type::containerNew(as_typename, this->father_->type_);
  77       }
  78     }else{
  79       this->type_ = simgrid::instr::Type::containerNew("0", nullptr);
  80     }
  81   }else{
  82     //otherwise, the name is its kind
  83     char typeNameBuff[INSTR_DEFAULT_STR_SIZE];
  84     switch (this->kind_) {
  85       case simgrid::instr::INSTR_HOST:
  86         snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "HOST");
  87         break;
  88       case simgrid::instr::INSTR_LINK:
  89         snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "LINK");
  90         break;
  91       case simgrid::instr::INSTR_ROUTER:
  92         snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "ROUTER");
  93         break;
  94       case simgrid::instr::INSTR_SMPI:
  95         snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MPI");
  96         break;
  97       case simgrid::instr::INSTR_MSG_PROCESS:
  98         snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_PROCESS");
  99         break;
 100       case simgrid::instr::INSTR_MSG_VM:
 101         snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_VM");
 102         break;
 103       case simgrid::instr::INSTR_MSG_TASK:
 104         snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_TASK");
 105         break;
 106       default:
 107         THROWF (tracing_error, 0, "new container kind is unknown.");
 108         break;
 109     }
 110     simgrid::instr::Type* type = this->father_->type_->getChildOrNull(typeNameBuff);
 111     if (type == nullptr){
 112       this->type_ = simgrid::instr::Type::containerNew(typeNameBuff, this->father_->type_);
 113     }else{
 114       this->type_ = type;
 115     }
 116   }
 117   this->children_ = xbt_dict_new_homogeneous(nullptr);
 118   if (this->father_) {
 119     xbt_dict_set(this->father_->children_, this->name_, this, nullptr);
 120     LogContainerCreation(this);
 121   }
 122
 123   //register all kinds by name
 124   if (not allContainers.emplace(this->name_, this).second) {
 125     THROWF(tracing_error, 1, "container %s already present in allContainers data structure", this->name_);
 126   }
 127
 128   XBT_DEBUG("Add container name '%s'", this->name_);
 129
 130   //register NODE types for triva configuration
 131   if (this->kind_ == simgrid::instr::INSTR_HOST || this->kind_ == simgrid::instr::INSTR_LINK ||
 132       this->kind_ == simgrid::instr::INSTR_ROUTER) {
 133     trivaNodeTypes.insert(this->type_->name_);
 134   }
 135 }
 136 simgrid::instr::Container::~Container()
 137 {
 138   XBT_DEBUG("destroy container %s", name_);
 139
 140   // obligation to dump previous events because they might
 141   // reference the container that is about to be destroyed
 142   TRACE_last_timestamp_to_dump = surf_get_clock();
 143   TRACE_paje_dump_buffer(1);
 144
 145   // trace my destruction
 146   if (not TRACE_disable_destroy() && this != PJ_container_get_root()) {
 147     // do not trace the container destruction if user requests
 148     // or if the container is root
 149     LogContainerDestruction(this);
 150   }
 151
 152   // remove it from allContainers data structure
 153   allContainers.erase(name_);
 154
 155   // free
 156   xbt_free(name_);
 157   xbt_free(id_);
 158   xbt_dict_free(&children_);
 159 }
 160
 161 simgrid::instr::Container* PJ_container_get(const char* name)
 162 {
 163   container_t ret = PJ_container_get_or_null (name);
 164   if (ret == nullptr){
 165     THROWF(tracing_error, 1, "container with name %s not found", name);
 166   }
 167   return ret;
 168 }
 169
 170 simgrid::instr::Container* PJ_container_get_or_null(const char* name)
 171 {
 172   auto cont = allContainers.find(name);
 173   return cont == allContainers.end() ? nullptr : cont->second;
 174 }
 175
 176 simgrid::instr::Container* PJ_container_get_root()
 177 {
 178   return rootContainer;
 179 }
 180
 181 void PJ_container_remove_from_parent (container_t child)
 182 {
 183   if (child == nullptr){
 184     THROWF (tracing_error, 0, "can't remove from parent with a nullptr child");
 185   }
 186
 187   container_t parent = child->father_;
 188   if (parent){
 189     XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", child->name_, parent->name_);
 190     xbt_dict_remove(parent->children_, child->name_);
 191   }
 192 }
 193
 194 static void recursiveDestroyContainer (container_t container)
 195 {
 196   if (container == nullptr){
 197     THROWF (tracing_error, 0, "trying to recursively destroy a nullptr container");
 198   }
 199   XBT_DEBUG("recursiveDestroyContainer %s", container->name_);
 200   xbt_dict_cursor_t cursor = nullptr;
 201   container_t child;
 202   char *child_name;
 203   xbt_dict_foreach (container->children_, cursor, child_name, child) {
 204     recursiveDestroyContainer (child);
 205   }
 206   delete container;
 207 }
 208
 209 void PJ_container_free_all ()
 210 {
 211   container_t root = PJ_container_get_root();
 212   if (root == nullptr){
 213     THROWF (tracing_error, 0, "trying to free all containers, but root is nullptr");
 214   }
 215   recursiveDestroyContainer (root);
 216   rootContainer = nullptr;
 217
 218   //checks
 219   if (not allContainers.empty()) {
 220     THROWF(tracing_error, 0, "some containers still present even after destroying all of them");
 221   }
 222 }