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_.insert({alias, 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 Type::~Type()
  34 {
  35   for (auto elm : children_)
  36     delete elm.second;
  37 }
  38
  39 ValueType::~ValueType()
  40 {
  41   for (auto elm : values_)
  42     delete elm.second;
  43 }
  44
  45 ContainerType::ContainerType(const std::string& name, Type* father) : Type(name, name, "", father)
  46 {
  47   XBT_DEBUG("ContainerType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
  48   log_definition(PAJE_DefineContainerType);
  49 }
  50
  51 EventType::EventType(const std::string& name, Type* father) : ValueType(name, father)
  52 {
  53   XBT_DEBUG("EventType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
  54   log_definition(PAJE_DefineEventType);
  55 }
  56
  57 StateType::StateType(const std::string& name, Type* father) : ValueType(name, father)
  58 {
  59   XBT_DEBUG("StateType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
  60   log_definition(PAJE_DefineStateType);
  61 }
  62
  63 StateType::~StateType()
  64 {
  65   events_.clear();
  66 }
  67
  68 void StateType::set_event(const std::string& value_name)
  69 {
  70   events_.push_back(new StateEvent(issuer_, this, PAJE_SetState, get_entity_value(value_name), nullptr));
  71 }
  72
  73 void StateType::push_event(const std::string& value_name, TIData* extra)
  74 {
  75   events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), extra));
  76 }
  77
  78 void StateType::push_event(const std::string& value_name)
  79 {
  80   events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), nullptr));
  81 }
  82
  83 void StateType::pop_event()
  84 {
  85   pop_event(nullptr);
  86 }
  87
  88 void StateType::pop_event(TIData* extra)
  89 {
  90   events_.push_back(new StateEvent(issuer_, this, PAJE_PopState, nullptr, extra));
  91 }
  92
  93 VariableType::VariableType(const std::string& name, const std::string& color, Type* father)
  94     : Type(name, name, color, father)
  95 {
  96   XBT_DEBUG("VariableType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
  97   log_definition(PAJE_DefineVariableType);
  98 }
  99
 100 VariableType::~VariableType()
 101 {
 102   events_.clear();
 103 }
 104
 105 void VariableType::instr_event(double now, double delta, const char* resource, double value)
 106 {
 107   /* To trace resource utilization, we use AddEvent and SubEvent only. This implies to add a SetEvent first to set the
 108    * initial value of all variables for subsequent adds/subs. If we don't do so, the first AddEvent would be added to a
 109    * non-determined value, hence causing analysis problems.
 110    */
 111
 112   // create a key considering the resource and variable
 113   std::string key = std::string(resource) + get_name();
 114
 115   // check if key exists: if it doesn't, set the variable to zero and mark this in the global map.
 116   if (platform_variables.find(key) == platform_variables.end()) {
 117     set_event(now, 0);
 118     platform_variables.insert(key);
 119   }
 120
 121   add_event(now, value);
 122   sub_event(now + delta, value);
 123 }
 124
 125 void VariableType::set_event(double timestamp, double value)
 126 {
 127   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SetVariable, value));
 128 }
 129
 130 void VariableType::add_event(double timestamp, double value)
 131 {
 132   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_AddVariable, value));
 133 }
 134
 135 void VariableType::sub_event(double timestamp, double value)
 136 {
 137   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SubVariable, value));
 138 }
 139
 140 LinkType::LinkType(const std::string& name, const std::string& alias, Type* father) : ValueType(name, alias, father)
 141 {
 142 }
 143 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key)
 144 {
 145   start_event(startContainer, value, key, -1);
 146 }
 147
 148 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key, int size)
 149 {
 150   new LinkEvent(issuer_, this, PAJE_StartLink, startContainer, value, key, size);
 151 }
 152
 153 void LinkType::end_event(Container* endContainer, const std::string& value, const std::string& key)
 154 {
 155   new LinkEvent(issuer_, this, PAJE_EndLink, endContainer, value, key, -1);
 156 }
 157
 158 void Type::log_definition(e_event_type event_type)
 159 {
 160   if (trace_format != simgrid::instr::TraceFormat::Paje)
 161     return;
 162   XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, event_type, TRACE_precision(), 0.);
 163   stream_ << event_type << " " << get_id() << " " << father_->get_id() << " " << get_name();
 164   if (is_colored())
 165     stream_ << " \"" << color_ << "\"";
 166   XBT_DEBUG("Dump %s", stream_.str().c_str());
 167   tracing_file << stream_.str() << std::endl;
 168 }
 169
 170 void Type::log_definition(simgrid::instr::Type* source, simgrid::instr::Type* dest)
 171 {
 172   if (trace_format != simgrid::instr::TraceFormat::Paje)
 173     return;
 174   XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, PAJE_DefineLinkType, TRACE_precision(), 0.);
 175   stream_ << PAJE_DefineLinkType << " " << get_id() << " " << father_->get_id() << " " << source->get_id();
 176   stream_ << " " << dest->get_id() << " " << get_name();
 177   XBT_DEBUG("Dump %s", stream_.str().c_str());
 178   tracing_file << stream_.str() << std::endl;
 179 }
 180
 181 Type* Type::by_name(const std::string& name)
 182 {
 183   Type* ret = nullptr;
 184   for (auto elm : children_) {
 185     if (elm.second->name_ == name) {
 186       if (ret != nullptr) {
 187         THROWF (tracing_error, 0, "there are two children types with the same name?");
 188       } else {
 189         ret = elm.second;
 190       }
 191     }
 192   }
 193   if (ret == nullptr)
 194     THROWF(tracing_error, 2, "type with name (%s) not found in father type (%s)", name.c_str(), get_cname());
 195   return ret;
 196 }
 197
 198 void ValueType::add_entity_value(const std::string& name)
 199 {
 200   add_entity_value(name, "");
 201 }
 202
 203 void ValueType::add_entity_value(const std::string& name, const std::string& color)
 204 {
 205   if (name.empty())
 206     THROWF(tracing_error, 0, "can't get a value with no name");
 207
 208   auto it = values_.find(name);
 209   if (it == values_.end()) {
 210     EntityValue* new_val = new EntityValue(name, color, this);
 211     values_.insert({name, new_val});
 212     XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
 213     new_val->print();
 214   }
 215 }
 216
 217 EntityValue* ValueType::get_entity_value(const std::string& name)
 218 {
 219   auto ret = values_.find(name);
 220   if (ret == values_.end()) {
 221     THROWF(tracing_error, 2, "value with name (%s) not found in father type (%s)", name.c_str(), get_cname());
 222   }
 223   return ret->second;
 224 }
 225
 226 VariableType* Type::by_name_or_create(const std::string& name, const std::string& color)
 227 {
 228   auto cont = children_.find(name);
 229   std::string mycolor = color.empty() ? "1 1 1" : color;
 230   return cont == children_.end() ? new VariableType(name, mycolor, this) : static_cast<VariableType*>(cont->second);
 231 }
 232
 233 LinkType* Type::by_name_or_create(const std::string& name, Type* source, Type* dest)
 234 {
 235   std::string alias = name + "-" + std::to_string(source->id_) + "-" + std::to_string(dest->id_);
 236   auto it           = children_.find(alias);
 237   if (it == children_.end()) {
 238     LinkType* ret = new LinkType(name, alias, this);
 239     XBT_DEBUG("LinkType %s(%lld), child of %s(%lld)  %s(%lld)->%s(%lld)", ret->get_cname(), ret->get_id(), get_cname(),
 240               get_id(), source->get_cname(), source->get_id(), dest->get_cname(), dest->get_id());
 241     ret->log_definition(source, dest);
 242     return ret;
 243   } else
 244     return static_cast<LinkType*>(it->second);
 245 }
 246 }
 247 }