-/* 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 "simgrid/Exception.hpp"
#include "src/instr/instr_private.hpp"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_types, instr, "Paje tracing event system (types)");
-static simgrid::instr::ContainerType* rootType = nullptr; /* the root type */
-extern FILE* tracing_file;
+namespace simgrid::instr {
-namespace simgrid {
-namespace instr {
-
-Type::Type(std::string name, std::string alias, std::string color, Type* father)
- : id_(instr_new_paje_id()), name_(name), color_(color), father_(father)
-{
- if (name.empty() || alias.empty())
- THROWF(tracing_error, 0, "can't create a new type with no name or alias");
-
- if (father != nullptr){
- father->children_.insert({alias, this});
- XBT_DEBUG("new type %s, child of %s", name_.c_str(), father->getCname());
- }
-}
-
-Type::~Type()
-{
- for (auto elm : children_)
- delete elm.second;
-}
-
-ValueType::~ValueType()
-{
- for (auto elm : values_)
- delete elm.second;
-}
-
-ContainerType::ContainerType(std::string name, Type* father) : Type(name, name, "", father)
+long long int new_paje_id()
{
- XBT_DEBUG("ContainerType %s(%lld), child of %s(%lld)", getCname(), getId(), father->getCname(), father->getId());
- logDefinition(PAJE_DefineContainerType);
+ static long long int type_id = 0;
+ return type_id++;
}
-EventType::EventType(std::string name, Type* father) : ValueType(name, father)
+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)
{
- XBT_DEBUG("EventType %s(%lld), child of %s(%lld)", getCname(), getId(), father->getCname(), father->getId());
- logDefinition(PAJE_DefineEventType);
-}
+ if (name_.empty() || alias.empty())
+ throw TracingError(XBT_THROW_POINT, "can't create a new type with no name or alias");
-StateType::StateType(std::string name, Type* father) : ValueType(name, father)
-{
- XBT_DEBUG("StateType %s(%lld), child of %s(%lld)", getCname(), getId(), father->getCname(), father->getId());
- logDefinition(PAJE_DefineStateType);
+ 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);
+ }
}
-StateType::~StateType()
+void StateType::set_event(const std::string& value_name)
{
- events_.clear();
+ events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::SetState, get_entity_value(value_name), nullptr));
}
-void StateType::setEvent(std::string value_name)
+void StateType::push_event(const std::string& value_name, TIData* extra)
{
- events_.push_back(new StateEvent(SIMIX_get_clock(), issuer_, this, PAJE_SetState, getEntityValue(value_name)));
+ events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::PushState, get_entity_value(value_name), extra));
}
-void StateType::pushEvent(std::string value_name, void* extra)
+void StateType::push_event(const std::string& value_name)
{
events_.push_back(
- new StateEvent(SIMIX_get_clock(), issuer_, this, PAJE_PushState, getEntityValue(value_name), extra));
-}
-
-void StateType::pushEvent(std::string value_name)
-{
- events_.push_back(new StateEvent(SIMIX_get_clock(), issuer_, this, PAJE_PushState, getEntityValue(value_name)));
+ new StateEvent(get_issuer(), this, PajeEventType::PushState, get_entity_value(value_name), nullptr));
}
-void StateType::popEvent()
+void StateType::pop_event()
{
- events_.push_back(new StateEvent(SIMIX_get_clock(), issuer_, this, PAJE_PopState, nullptr));
+ pop_event(nullptr);
}
-VariableType::VariableType(std::string name, std::string color, Type* father) : Type(name, name, color, father)
+void StateType::pop_event(TIData* extra)
{
- XBT_DEBUG("VariableType %s(%lld), child of %s(%lld)", getCname(), getId(), father->getCname(), father->getId());
- logDefinition(PAJE_DefineVariableType);
+ events_.push_back(new StateEvent(get_issuer(), this, PajeEventType::PopState, nullptr, extra));
}
-VariableType::~VariableType()
+void VariableType::instr_event(double now, double delta, const char* resource, double value)
{
- events_.clear();
-}
+ /* 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.
+ */
-void VariableType::setEvent(double timestamp, Container* container, double value)
-{
- events_.push_back(new VariableEvent(timestamp, container, this, PAJE_SetVariable, value));
-}
+ // 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);
-void VariableType::addEvent(double timestamp, Container* container, double value)
-{
- events_.push_back(new VariableEvent(timestamp, container, this, PAJE_AddVariable, value));
+ add_event(now, value);
+ sub_event(now + delta, value);
}
-void VariableType::subEvent(double timestamp, Container* container, double value)
+void VariableType::set_event(double timestamp, double value)
{
- events_.push_back(new VariableEvent(timestamp, container, this, PAJE_SubVariable, value));
+ events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::SetVariable, value));
}
-LinkType::LinkType(std::string name, std::string alias, Type* father) : ValueType(name, alias, father)
-{
-}
-void LinkType::startEvent(Container* container, container_t endpoint, std::string value, std::string key)
+void VariableType::add_event(double timestamp, double value)
{
- startEvent(container, endpoint, value, key, -1);
+ events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::AddVariable, value));
}
-void LinkType::startEvent(Container* container, container_t endpoint, std::string value, std::string key, int size)
+void VariableType::sub_event(double timestamp, double value)
{
- new LinkEvent(SIMIX_get_clock(), container, this, PAJE_StartLink, endpoint, value, key, size);
+ events_.push_back(new VariableEvent(timestamp, get_issuer(), this, PajeEventType::SubVariable, value));
}
-void LinkType::endEvent(Container* container, container_t endpoint, std::string value, std::string key)
+void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key, size_t size)
{
- new LinkEvent(SIMIX_get_clock(), container, this, PAJE_EndLink, endpoint, value, key);
+ new LinkEvent(get_issuer(), this, PajeEventType::StartLink, startContainer, value, key, size);
}
-void Type::logDefinition(e_event_type event_type)
+void LinkType::end_event(Container* endContainer, const std::string& value, const std::string& key)
{
- if (instr_fmt_type != instr_fmt_paje)
- return;
- std::stringstream stream;
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __FUNCTION__, event_type, TRACE_precision(), 0.);
- stream << std::fixed << std::setprecision(TRACE_precision()) << event_type << " " << getId();
- stream << " " << father_->getId() << " " << getName();
- if (isColored())
- stream << " \"" << color_ << "\"";
- XBT_DEBUG("Dump %s", stream.str().c_str());
- stream << std::endl;
- fprintf(tracing_file, "%s", stream.str().c_str());
+ new LinkEvent(get_issuer(), this, PajeEventType::EndLink, endContainer, value, key);
}
-void Type::logDefinition(simgrid::instr::Type* source, simgrid::instr::Type* dest)
-{
- if (instr_fmt_type != instr_fmt_paje)
- return;
- std::stringstream stream;
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __FUNCTION__, PAJE_DefineLinkType, TRACE_precision(), 0.);
- stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_DefineLinkType << " " << getId();
- stream << " " << father_->getId() << " " << source->getId() << " " << dest->getId() << " " << getName();
- XBT_DEBUG("Dump %s", stream.str().c_str());
- stream << std::endl;
- fprintf(tracing_file, "%s", stream.str().c_str());
-}
-
-Type* Type::byName(std::string name)
+Type* Type::by_name(const std::string& name)
{
Type* ret = nullptr;
- for (auto elm : children_) {
- if (elm.second->name_ == name) {
+ for (auto const& [_, child] : children_) {
+ if (child->name_ == name) {
if (ret != nullptr) {
- THROWF (tracing_error, 0, "there are two children types with the same name?");
+ throw TracingError(XBT_THROW_POINT, "there are two children types with the same name?");
} else {
- ret = elm.second;
+ ret = child.get();
}
}
}
if (ret == nullptr)
- THROWF(tracing_error, 2, "type with name (%s) not found in father type (%s)", name.c_str(), getCname());
+ 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;
}
-void ValueType::addEntityValue(std::string name)
+void ValueType::add_entity_value(const std::string& name)
{
- addEntityValue(name, "");
+ add_entity_value(name, "");
}
-void ValueType::addEntityValue(std::string name, std::string color)
+void ValueType::add_entity_value(const std::string& name, const std::string& color)
{
if (name.empty())
- THROWF(tracing_error, 0, "can't get a value with no name");
+ throw TracingError(XBT_THROW_POINT, "can't get a value with no name");
auto it = values_.find(name);
if (it == values_.end()) {
- EntityValue* new_val = new EntityValue(name, color, this);
- values_.insert({name, new_val});
- XBT_DEBUG("new value %s, child of %s", name.c_str(), getCname());
- new_val->print();
+ XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
+ values_.try_emplace(name, name, color, this);
}
}
-EntityValue* ValueType::getEntityValue(std::string name)
+EntityValue* ValueType::get_entity_value(const std::string& name)
{
auto ret = values_.find(name);
if (ret == values_.end()) {
- THROWF(tracing_error, 2, "value with name (%s) not found in father type (%s)", name.c_str(), getCname());
+ 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;
-}
-
-ContainerType* Type::createRootType()
-{
- rootType = new ContainerType("0");
- return rootType;
+ return &ret->second;
}
-ContainerType* Type::getRootType()
-{
- return rootType;
-}
-
-ContainerType* Type::getOrCreateContainerType(std::string name)
-{
- auto cont = children_.find(name);
- return cont == children_.end() ? new ContainerType(name, this) : static_cast<ContainerType*>(cont->second);
-}
-
-EventType* Type::getOrCreateEventType(std::string name)
-{
- auto cont = children_.find(name);
- return cont == children_.end() ? new EventType(name, this) : static_cast<EventType*>(cont->second);
-}
-
-StateType* Type::getOrCreateStateType(std::string name)
-{
- auto cont = children_.find(name);
- return cont == children_.end() ? new StateType(name, this) : static_cast<StateType*>(cont->second);
-}
-
-VariableType* Type::getOrCreateVariableType(std::string name, std::string color)
+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);
+ return cont == children_.end() ? new VariableType(name, mycolor, this)
+ : static_cast<VariableType*>(cont->second.get());
}
-LinkType* Type::getOrCreateLinkType(std::string name, Type* source, Type* dest)
+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()) {
- LinkType* ret = new LinkType(name, alias, this);
- XBT_DEBUG("LinkType %s(%lld), child of %s(%lld) %s(%lld)->%s(%lld)", ret->getCname(), ret->getId(), getCname(),
- getId(), source->getCname(), source->getId(), dest->getCname(), dest->getId());
- ret->logDefinition(source, dest);
- return ret;
+ return new LinkType(name, source, dest, alias, this);
} else
- return static_cast<LinkType*>(it->second);
-}
-}
+ return static_cast<LinkType*>(it->second.get());
}
+} // namespace simgrid::instr
