src/instr/instr_paje_types.cpp

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