src/instr/instr_paje_types.cpp

   1 /* Copyright (c) 2012-2019. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "src/instr/instr_private.hpp"
   8
   9 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_types, instr, "Paje tracing event system (types)");
  10
  11 extern std::ofstream tracing_file;
  12 // to check if variables were previously set to 0, otherwise paje won't simulate them
  13 static std::set<std::string> platform_variables;
  14
  15 namespace simgrid {
  16 namespace instr {
  17
  18 Type::Type(const std::string& name, const std::string& alias, const std::string& color, Type* father)
  19     : id_(instr_new_paje_id()), name_(name), color_(color), father_(father)
  20 {
  21   if (name_.empty() || alias.empty())
  22     THROWF(tracing_error, 0, "can't create a new type with no name or alias");
  23
  24   if (father != nullptr){
  25     father->children_[alias].reset(this);
  26     XBT_DEBUG("new type %s, child of %s", get_cname(), father->get_cname());
  27   }
  28   if (trace_format == simgrid::instr::TraceFormat::Paje) {
  29     stream_ << std::fixed << std::setprecision(TRACE_precision());
  30   }
  31 }
  32
  33 ContainerType::ContainerType(const std::string& name, Type* father) : Type(name, name, "", father)
  34 {
  35   XBT_DEBUG("ContainerType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
  36   log_definition(PAJE_DefineContainerType);
  37 }
  38
  39 EventType::EventType(const std::string& name, Type* father) : ValueType(name, father)
  40 {
  41   XBT_DEBUG("EventType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
  42   log_definition(PAJE_DefineEventType);
  43 }
  44
  45 StateType::StateType(const std::string& name, Type* father) : ValueType(name, father)
  46 {
  47   XBT_DEBUG("StateType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
  48   log_definition(PAJE_DefineStateType);
  49 }
  50
  51 void StateType::set_event(const std::string& value_name)
  52 {
  53   events_.push_back(new StateEvent(issuer_, this, PAJE_SetState, get_entity_value(value_name), nullptr));
  54 }
  55
  56 void StateType::push_event(const std::string& value_name, TIData* extra)
  57 {
  58   events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), extra));
  59 }
  60
  61 void StateType::push_event(const std::string& value_name)
  62 {
  63   events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), nullptr));
  64 }
  65
  66 void StateType::pop_event()
  67 {
  68   pop_event(nullptr);
  69 }
  70
  71 void StateType::pop_event(TIData* extra)
  72 {
  73   events_.push_back(new StateEvent(issuer_, this, PAJE_PopState, nullptr, extra));
  74 }
  75
  76 VariableType::VariableType(const std::string& name, const std::string& color, Type* father)
  77     : Type(name, name, color, father)
  78 {
  79   XBT_DEBUG("VariableType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
  80   log_definition(PAJE_DefineVariableType);
  81 }
  82
  83 void VariableType::instr_event(double now, double delta, const char* resource, double value)
  84 {
  85   /* To trace resource utilization, we use AddEvent and SubEvent only. This implies to add a SetEvent first to set the
  86    * initial value of all variables for subsequent adds/subs. If we don't do so, the first AddEvent would be added to a
  87    * non-determined value, hence causing analysis problems.
  88    */
  89
  90   // create a key considering the resource and variable
  91   std::string key = std::string(resource) + get_name();
  92
  93   // check if key exists: if it doesn't, set the variable to zero and mark this in the global map.
  94   if (platform_variables.find(key) == platform_variables.end()) {
  95     set_event(now, 0);
  96     platform_variables.insert(key);
  97   }
  98
  99   add_event(now, value);
 100   sub_event(now + delta, value);
 101 }
 102
 103 void VariableType::set_event(double timestamp, double value)
 104 {
 105   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SetVariable, value));
 106 }
 107
 108 void VariableType::add_event(double timestamp, double value)
 109 {
 110   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_AddVariable, value));
 111 }
 112
 113 void VariableType::sub_event(double timestamp, double value)
 114 {
 115   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SubVariable, value));
 116 }
 117
 118 LinkType::LinkType(const std::string& name, const std::string& alias, Type* father) : ValueType(name, alias, father)
 119 {
 120 }
 121 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key)
 122 {
 123   start_event(startContainer, value, key, -1);
 124 }
 125
 126 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key, int size)
 127 {
 128   new LinkEvent(issuer_, this, PAJE_StartLink, startContainer, value, key, size);
 129 }
 130
 131 void LinkType::end_event(Container* endContainer, const std::string& value, const std::string& key)
 132 {
 133   new LinkEvent(issuer_, this, PAJE_EndLink, endContainer, value, key, -1);
 134 }
 135
 136 void Type::log_definition(e_event_type event_type)
 137 {
 138   if (trace_format != simgrid::instr::TraceFormat::Paje)
 139     return;
 140   XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, event_type, TRACE_precision(), 0.);
 141   stream_ << event_type << " " << get_id() << " " << father_->get_id() << " " << get_name();
 142   if (is_colored())
 143     stream_ << " \"" << color_ << "\"";
 144   XBT_DEBUG("Dump %s", stream_.str().c_str());
 145   tracing_file << stream_.str() << std::endl;
 146 }
 147
 148 void Type::log_definition(simgrid::instr::Type* source, simgrid::instr::Type* dest)
 149 {
 150   if (trace_format != simgrid::instr::TraceFormat::Paje)
 151     return;
 152   XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, PAJE_DefineLinkType, TRACE_precision(), 0.);
 153   stream_ << PAJE_DefineLinkType << " " << get_id() << " " << father_->get_id() << " " << source->get_id();
 154   stream_ << " " << dest->get_id() << " " << get_name();
 155   XBT_DEBUG("Dump %s", stream_.str().c_str());
 156   tracing_file << stream_.str() << std::endl;
 157 }
 158
 159 Type* Type::by_name(const std::string& name)
 160 {
 161   Type* ret = nullptr;
 162   for (auto const& elm : children_) {
 163     if (elm.second->name_ == name) {
 164       if (ret != nullptr) {
 165         THROWF (tracing_error, 0, "there are two children types with the same name?");
 166       } else {
 167         ret = elm.second.get();
 168       }
 169     }
 170   }
 171   if (ret == nullptr)
 172     THROWF(tracing_error, 2, "type with name (%s) not found in father type (%s)", name.c_str(), get_cname());
 173   return ret;
 174 }
 175
 176 void ValueType::add_entity_value(const std::string& name)
 177 {
 178   add_entity_value(name, "");
 179 }
 180
 181 void ValueType::add_entity_value(const std::string& name, const std::string& color)
 182 {
 183   if (name.empty())
 184     THROWF(tracing_error, 0, "can't get a value with no name");
 185
 186   auto it = values_.find(name);
 187   if (it == values_.end()) {
 188     auto res = values_.emplace(name, EntityValue(name, color, this));
 189     XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
 190     res.first->second.print();
 191   }
 192 }
 193
 194 EntityValue* ValueType::get_entity_value(const std::string& name)
 195 {
 196   auto ret = values_.find(name);
 197   if (ret == values_.end()) {
 198     THROWF(tracing_error, 2, "value with name (%s) not found in father type (%s)", name.c_str(), get_cname());
 199   }
 200   return &ret->second;
 201 }
 202
 203 VariableType* Type::by_name_or_create(const std::string& name, const std::string& color)
 204 {
 205   auto cont = children_.find(name);
 206   std::string mycolor = color.empty() ? "1 1 1" : color;
 207   return cont == children_.end() ? new VariableType(name, mycolor, this)
 208                                  : static_cast<VariableType*>(cont->second.get());
 209 }
 210
 211 LinkType* Type::by_name_or_create(const std::string& name, Type* source, Type* dest)
 212 {
 213   std::string alias = name + "-" + std::to_string(source->id_) + "-" + std::to_string(dest->id_);
 214   auto it           = children_.find(alias);
 215   if (it == children_.end()) {
 216     LinkType* ret = new LinkType(name, alias, this);
 217     XBT_DEBUG("LinkType %s(%lld), child of %s(%lld)  %s(%lld)->%s(%lld)", ret->get_cname(), ret->get_id(), get_cname(),
 218               get_id(), source->get_cname(), source->get_id(), dest->get_cname(), dest->get_id());
 219     ret->log_definition(source, dest);
 220     return ret;
 221   } else
 222     return static_cast<LinkType*>(it->second.get());
 223 }
 224 }
 225 }