-/* Copyright (c) 2012, 2014-2017. The SimGrid Team.
+/* Copyright (c) 2012-2023. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
-#include "src/instr/instr_private.h"
+#include "simgrid/Exception.hpp"
+#include "src/instr/instr_private.hpp"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_types, instr, "Paje tracing event system (types)");
-static type_t rootType = nullptr; /* the root type */
+namespace simgrid::instr {
-void PJ_type_release ()
+long long int new_paje_id()
{
- rootType = nullptr;
+ static long long int type_id = 0;
+ return type_id++;
}
-type_t PJ_type_get_root ()
+Type::Type(PajeEventType event_type, const std::string& name, const std::string& alias, const std::string& color,
+ Type* parent)
+ : name_(name), color_(color), parent_(parent)
{
- return rootType;
-}
+ if (name_.empty() || alias.empty())
+ throw TracingError(XBT_THROW_POINT, "can't create a new type with no name or alias");
-s_type::s_type (const char *typeNameBuff, const char *key, const char *color, e_entity_types kind, type_t father)
-{
- if (typeNameBuff == nullptr || key == nullptr){
- THROWF(tracing_error, 0, "can't create a new type with name or key equal nullptr");
+ if (parent != nullptr) {
+ parent->children_[alias].reset(this);
+ XBT_DEBUG("new type %s, child of %s", get_cname(), parent->get_cname());
+ on_creation(*this, event_type);
}
+}
- this->name = xbt_strdup (typeNameBuff);
- this->father = father;
- this->kind = kind;
- this->children = xbt_dict_new_homogeneous(nullptr);
- this->values = xbt_dict_new_homogeneous(nullptr);
- this->color = xbt_strdup (color);
-
- char str_id[INSTR_DEFAULT_STR_SIZE];
- snprintf (str_id, INSTR_DEFAULT_STR_SIZE, "%lld", instr_new_paje_id());
- this->id = xbt_strdup (str_id);
-
- if (father != nullptr){
- xbt_dict_set (father->children, key, this, nullptr);
- XBT_DEBUG("new type %s, child of %s", typeNameBuff, father->name);
- }
+void StateType::set_event(const std::string& value_name)
+{
+ events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::SetState, get_entity_value(value_name), nullptr));
}
-void PJ_type_free (type_t type)
+void StateType::push_event(const std::string& value_name, TIData* extra)
{
- value* val;
- char *value_name;
- xbt_dict_cursor_t cursor = nullptr;
- xbt_dict_foreach (type->values, cursor, value_name, val) {
- XBT_DEBUG("free value %s, child of %s", val->name, val->father->name);
- xbt_free(val);
- }
- xbt_dict_free (&type->values);
- xbt_free (type->name);
- xbt_free (type->id);
- xbt_free (type->color);
- xbt_dict_free (&type->children);
- xbt_free (type);
- type = nullptr;
-}
-
-void recursiveDestroyType (type_t type)
-{
- XBT_DEBUG("recursiveDestroyType %s", type->name);
- xbt_dict_cursor_t cursor = nullptr;
- type_t child;
- char *child_name;
- xbt_dict_foreach(type->children, cursor, child_name, child) {
- recursiveDestroyType (child);
- }
- PJ_type_free(type);
+ events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::PushState, get_entity_value(value_name), extra));
}
-type_t PJ_type_get (const char *name, type_t father)
+void StateType::push_event(const std::string& value_name)
{
- type_t ret = s_type::s_type_get_or_null (name, father);
- if (ret == nullptr){
- THROWF (tracing_error, 2, "type with name (%s) not found in father type (%s)", name, father->name);
- }
- return ret;
+ events_.push_back(
+ new StateEvent(get_issuer(), this, PajeEventType::PushState, get_entity_value(value_name), nullptr));
}
-type_t s_type::s_type_get_or_null (const char *name, type_t father)
+void StateType::pop_event()
{
- if (name == nullptr || father == nullptr){
- THROWF (tracing_error, 0, "can't get type with a nullptr name or from a nullptr father");
- }
+ pop_event(nullptr);
+}
- type_t ret = nullptr;
- type_t child;
- char *child_name;
- xbt_dict_cursor_t cursor = nullptr;
- xbt_dict_foreach(father->children, cursor, child_name, child) {
- if (strcmp (child->name, name) == 0){
- if (ret != nullptr){
- THROWF (tracing_error, 0, "there are two children types with the same name?");
- }else{
- ret = child;
- }
- }
- }
- return ret;
+void StateType::pop_event(TIData* extra)
+{
+ events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::PopState, nullptr, extra));
}
-type_t s_type::s_type_container_new (const char *name, type_t father)
+void VariableType::instr_event(double now, double delta, const char* resource, double value)
{
- if (name == nullptr){
- THROWF (tracing_error, 0, "can't create a container type with a nullptr name");
- }
+ /* To trace resource utilization, we use AddEvent and SubEvent only. This implies to add a SetEvent first to set the
+ * initial value of all variables for subsequent adds/subs. If we don't do so, the first AddEvent would be added to a
+ * non-determined value, hence causing analysis problems.
+ */
+
+ // to check if variables were previously set to 0, otherwise paje won't simulate them
+ // create a key considering the resource and variable, and check if key exists in the global map:
+ // if it doesn't, set the variable to zero.
+ if (static std::set<std::string, std::less<>> platform_variables;
+ platform_variables.emplace(resource + get_name()).second)
+ set_event(now, 0);
+
+ add_event(now, value);
+ sub_event(now + delta, value);
+}
- type_t ret = new s_type (name, name, nullptr, TYPE_CONTAINER, father);
- if (father == nullptr) {
- rootType = ret;
- } else {
- XBT_DEBUG("ContainerType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
- DefineContainerEvent(ret);
- }
- return ret;
+void VariableType::set_event(double timestamp, double value)
+{
+ events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::SetVariable, value));
}
-type_t s_type::s_type_event_new (const char *name, type_t father)
+void VariableType::add_event(double timestamp, double value)
{
- if (name == nullptr){
- THROWF (tracing_error, 0, "can't create an event type with a nullptr name");
- }
+ events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::AddVariable, value));
+}
- type_t ret = new s_type (name, name, nullptr, TYPE_EVENT, father);
- XBT_DEBUG("EventType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
- LogDefineEventType(ret);
- return ret;
+void VariableType::sub_event(double timestamp, double value)
+{
+ events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::SubVariable, value));
}
-type_t s_type::s_type_variable_new (const char *name, const char *color, type_t father)
+void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key, size_t size)
{
- if (name == nullptr){
- THROWF (tracing_error, 0, "can't create a variable type with a nullptr name");
- }
+ new LinkEvent(get_issuer(), this, PajeEventType::StartLink, startContainer, value, key, size);
+}
- type_t ret = nullptr;
+void LinkType::end_event(Container* endContainer, const std::string& value, const std::string& key)
+{
+ new LinkEvent(get_issuer(), this, PajeEventType::EndLink, endContainer, value, key);
+}
- if (not color) {
- char white[INSTR_DEFAULT_STR_SIZE] = "1 1 1";
- ret = new s_type (name, name, white, TYPE_VARIABLE, father);
- }else{
- ret = new s_type (name, name, color, TYPE_VARIABLE, father);
+Type* Type::by_name(const std::string& name)
+{
+ Type* ret = nullptr;
+ for (auto const& [_, child] : children_) {
+ if (child->name_ == name) {
+ if (ret != nullptr) {
+ throw TracingError(XBT_THROW_POINT, "there are two children types with the same name?");
+ } else {
+ ret = child.get();
+ }
+ }
}
- XBT_DEBUG("VariableType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
- LogVariableTypeDefinition (ret);
+ if (ret == nullptr)
+ throw TracingError(XBT_THROW_POINT, xbt::string_printf("type with name (%s) not found in parent type (%s)",
+ name.c_str(), get_cname()));
return ret;
}
-type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest)
+void ValueType::add_entity_value(const std::string& name)
{
- if (name == nullptr){
- THROWF (tracing_error, 0, "can't create a link type with a nullptr name");
- }
+ add_entity_value(name, "");
+}
- type_t ret = nullptr;
+void ValueType::add_entity_value(const std::string& name, const std::string& color)
+{
+ if (name.empty())
+ throw TracingError(XBT_THROW_POINT, "can't get a value with no name");
- char key[INSTR_DEFAULT_STR_SIZE];
- snprintf (key, INSTR_DEFAULT_STR_SIZE, "%s-%s-%s", name, source->id, dest->id);
- ret = new s_type (name, key, nullptr, TYPE_LINK, father);
- XBT_DEBUG("LinkType %s(%s), child of %s(%s) %s(%s)->%s(%s)", ret->name, ret->id, father->name, father->id,
- source->name, source->id, dest->name, dest->id);
- LogLinkTypeDefinition(ret, source, dest);
- return ret;
+ auto it = values_.find(name);
+ if (it == values_.end()) {
+ XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
+ values_.try_emplace(name, name, color, this);
+ }
}
-type_t PJ_type_state_new (const char *name, type_t father)
+EntityValue* ValueType::get_entity_value(const std::string& name)
{
- if (name == nullptr){
- THROWF (tracing_error, 0, "can't create a state type with a nullptr name");
+ auto ret = values_.find(name);
+ if (ret == values_.end()) {
+ throw TracingError(XBT_THROW_POINT, xbt::string_printf("value with name (%s) not found in parent type (%s)",
+ name.c_str(), get_cname()));
}
+ return &ret->second;
+}
- type_t ret = nullptr;
+VariableType* Type::by_name_or_create(const std::string& name, const std::string& color)
+{
+ auto cont = children_.find(name);
+ std::string mycolor = color.empty() ? "1 1 1" : color;
+ return cont == children_.end() ? new VariableType(name, mycolor, this)
+ : static_cast<VariableType*>(cont->second.get());
+}
- ret = new s_type (name, name, nullptr, TYPE_STATE, father);
- XBT_DEBUG("StateType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
- LogStateTypeDefinition(ret);
- return ret;
+LinkType* Type::by_name_or_create(const std::string& name, const Type* source, const Type* dest)
+{
+ std::string alias = name + "-" + std::to_string(source->id_) + "-" + std::to_string(dest->id_);
+ auto it = children_.find(alias);
+ if (it == children_.end()) {
+ return new LinkType(name, source, dest, alias, this);
+ } else
+ return static_cast<LinkType*>(it->second.get());
}
+} // namespace simgrid::instr
