src/instr/instr_paje_types.cpp

   1 /* Copyright (c) 2012-2022. 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 "simgrid/Exception.hpp"
   8 #include "src/instr/instr_private.hpp"
   9
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_types, instr, "Paje tracing event system (types)");
  11
  12 namespace simgrid {
  13 namespace instr {
  14
  15 long long int new_paje_id()
  16 {
  17   static long long int type_id = 0;
  18   return type_id++;
  19 }
  20
  21 Type::Type(PajeEventType event_type, const std::string& name, const std::string& alias, const std::string& color,
  22            Type* parent)
  23     : name_(name), color_(color), parent_(parent)
  24 {
  25   if (name_.empty() || alias.empty())
  26     throw TracingError(XBT_THROW_POINT, "can't create a new type with no name or alias");
  27
  28   if (parent != nullptr) {
  29     parent->children_[alias].reset(this);
  30     XBT_DEBUG("new type %s, child of %s", get_cname(), parent->get_cname());
  31     on_creation(*this, event_type);
  32   }
  33 }
  34
  35 void StateType::set_event(const std::string& value_name)
  36 {
  37   events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::SetState, get_entity_value(value_name), nullptr));
  38 }
  39
  40 void StateType::push_event(const std::string& value_name, TIData* extra)
  41 {
  42   events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::PushState, get_entity_value(value_name), extra));
  43 }
  44
  45 void StateType::push_event(const std::string& value_name)
  46 {
  47   events_.push_back(
  48       new StateEvent(get_issuer(), this, PajeEventType::PushState, get_entity_value(value_name), nullptr));
  49 }
  50
  51 void StateType::pop_event()
  52 {
  53   pop_event(nullptr);
  54 }
  55
  56 void StateType::pop_event(TIData* extra)
  57 {
  58   events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::PopState, nullptr, extra));
  59 }
  60
  61 void VariableType::instr_event(double now, double delta, const char* resource, double value)
  62 {
  63   /* To trace resource utilization, we use AddEvent and SubEvent only. This implies to add a SetEvent first to set the
  64    * initial value of all variables for subsequent adds/subs. If we don't do so, the first AddEvent would be added to a
  65    * non-determined value, hence causing analysis problems.
  66    */
  67
  68   // to check if variables were previously set to 0, otherwise paje won't simulate them
  69   static std::set<std::string, std::less<>> platform_variables;
  70
  71   // create a key considering the resource and variable
  72   std::string key = std::string(resource) + get_name();
  73
  74   // check if key exists: if it doesn't, set the variable to zero and mark this in the global map.
  75   if (platform_variables.find(key) == platform_variables.end()) {
  76     set_event(now, 0);
  77     platform_variables.insert(key);
  78   }
  79
  80   add_event(now, value);
  81   sub_event(now + delta, value);
  82 }
  83
  84 void VariableType::set_event(double timestamp, double value)
  85 {
  86   events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::SetVariable, value));
  87 }
  88
  89 void VariableType::add_event(double timestamp, double value)
  90 {
  91   events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::AddVariable, value));
  92 }
  93
  94 void VariableType::sub_event(double timestamp, double value)
  95 {
  96   events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::SubVariable, value));
  97 }
  98
  99 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key, size_t size)
 100 {
 101   new LinkEvent(get_issuer(), this, PajeEventType::StartLink, startContainer, value, key, size);
 102 }
 103
 104 void LinkType::end_event(Container* endContainer, const std::string& value, const std::string& key)
 105 {
 106   new LinkEvent(get_issuer(), this, PajeEventType::EndLink, endContainer, value, key);
 107 }
 108
 109 Type* Type::by_name(const std::string& name)
 110 {
 111   Type* ret = nullptr;
 112   for (auto const& [_, child] : children_) {
 113     if (child->name_ == name) {
 114       if (ret != nullptr) {
 115         throw TracingError(XBT_THROW_POINT, "there are two children types with the same name?");
 116       } else {
 117         ret = child.get();
 118       }
 119     }
 120   }
 121   if (ret == nullptr)
 122     throw TracingError(XBT_THROW_POINT, xbt::string_printf("type with name (%s) not found in parent type (%s)",
 123                                                            name.c_str(), get_cname()));
 124   return ret;
 125 }
 126
 127 void ValueType::add_entity_value(const std::string& name)
 128 {
 129   add_entity_value(name, "");
 130 }
 131
 132 void ValueType::add_entity_value(const std::string& name, const std::string& color)
 133 {
 134   if (name.empty())
 135     throw TracingError(XBT_THROW_POINT, "can't get a value with no name");
 136
 137   auto it = values_.find(name);
 138   if (it == values_.end()) {
 139     XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
 140     values_.try_emplace(name, name, color, this);
 141   }
 142 }
 143
 144 EntityValue* ValueType::get_entity_value(const std::string& name)
 145 {
 146   auto ret = values_.find(name);
 147   if (ret == values_.end()) {
 148     throw TracingError(XBT_THROW_POINT, xbt::string_printf("value with name (%s) not found in parent type (%s)",
 149                                                            name.c_str(), get_cname()));
 150   }
 151   return &ret->second;
 152 }
 153
 154 VariableType* Type::by_name_or_create(const std::string& name, const std::string& color)
 155 {
 156   auto cont = children_.find(name);
 157   std::string mycolor = color.empty() ? "1 1 1" : color;
 158   return cont == children_.end() ? new VariableType(name, mycolor, this)
 159                                  : static_cast<VariableType*>(cont->second.get());
 160 }
 161
 162 LinkType* Type::by_name_or_create(const std::string& name, const Type* source, const Type* dest)
 163 {
 164   std::string alias = name + "-" + std::to_string(source->id_) + "-" + std::to_string(dest->id_);
 165   auto it           = children_.find(alias);
 166   if (it == children_.end()) {
 167     return new LinkType(name, source, dest, alias, this);
 168   } else
 169     return static_cast<LinkType*>(it->second.get());
 170 }
 171 } // namespace instr
 172 } // namespace simgrid