Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Define and throw simgrid::TracingError.
[simgrid.git] / src / instr / instr_paje_types.cpp
index 711a8a6..bc9f521 100644 (file)
-/* Copyright (c) 2012, 2014-2017. The SimGrid Team.
+/* Copyright (c) 2012-2019. 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::Type* rootType = nullptr; /* the root type */
+extern std::ofstream tracing_file;
+// to check if variables were previously set to 0, otherwise paje won't simulate them
+static std::set<std::string> platform_variables;
 
-simgrid::instr::Type* PJ_type_get_root()
+namespace simgrid {
+namespace instr {
+
+Type::Type(const std::string& name, const std::string& alias, const std::string& color, Type* father)
+    : id_(instr_new_paje_id()), name_(name), color_(color), father_(father)
 {
-  return rootType;
+  if (name_.empty() || alias.empty())
+    throw simgrid::TracingError(XBT_THROW_POINT, "can't create a new type with no name or alias");
+
+  if (father != nullptr){
+    father->children_[alias].reset(this);
+    XBT_DEBUG("new type %s, child of %s", get_cname(), father->get_cname());
+  }
+  if (trace_format == simgrid::instr::TraceFormat::Paje) {
+    stream_ << std::fixed << std::setprecision(TRACE_precision());
+  }
 }
 
-simgrid::instr::Type::Type(std::string name, const char* key, std::string color, e_entity_types kind, Type* father)
-    : name_(name), color_(color), kind_(kind), father_(father)
+ContainerType::ContainerType(const std::string& name, Type* father) : Type(name, name, "", father)
 {
-  if (name.empty() || key == nullptr) {
-    THROWF(tracing_error, 0, "can't create a new type with name or key equal nullptr");
-  }
+  XBT_DEBUG("ContainerType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
+  log_definition(PAJE_DefineContainerType);
+}
 
-  this->id_ = std::to_string(instr_new_paje_id());
+EventType::EventType(const std::string& name, Type* father) : ValueType(name, father)
+{
+  XBT_DEBUG("EventType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
+  log_definition(PAJE_DefineEventType);
+}
 
-  if (father != nullptr){
-    father->children_.insert({key, this});
-    XBT_DEBUG("new type %s, child of %s", name_.c_str(), father->getCname());
-  }
+StateType::StateType(const std::string& name, Type* father) : ValueType(name, father)
+{
+  XBT_DEBUG("StateType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
+  log_definition(PAJE_DefineStateType);
 }
 
-simgrid::instr::Type::~Type()
+void StateType::set_event(const std::string& value_name)
 {
-  for (auto elm : values_) {
-    XBT_DEBUG("free value %s, child of %s", elm.second->getCname(), elm.second->father_->getCname());
-    delete elm.second;
-  }
-  for (auto elm : children_) {
-    delete elm.second;
-  }
+  events_.push_back(new StateEvent(issuer_, this, PAJE_SetState, get_entity_value(value_name), nullptr));
 }
 
-simgrid::instr::Type* simgrid::instr::Type::getChild(std::string name)
+void StateType::push_event(const std::string& value_name, TIData* extra)
 {
-  simgrid::instr::Type* ret = this->getChildOrNull(name);
-  if (ret == nullptr)
-    THROWF(tracing_error, 2, "type with name (%s) not found in father type (%s)", name.c_str(), getCname());
-  return ret;
+  events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), extra));
 }
 
-simgrid::instr::Type* simgrid::instr::Type::getChildOrNull(std::string name)
+void StateType::push_event(const std::string& value_name)
 {
-  xbt_assert(not name.empty(), "can't get type with a nullptr name");
+  events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), nullptr));
+}
 
-  simgrid::instr::Type* ret = nullptr;
-  for (auto elm : children_) {
-    if (elm.second->name_ == name) {
-      if (ret != nullptr) {
-        THROWF (tracing_error, 0, "there are two children types with the same name?");
-      } else {
-        ret = elm.second;
-      }
-    }
-  }
-  return ret;
+void StateType::pop_event()
+{
+  pop_event(nullptr);
 }
 
-simgrid::instr::Type* simgrid::instr::Type::containerNew(const char* name, simgrid::instr::Type* father)
+void StateType::pop_event(TIData* extra)
 {
-  if (name == nullptr){
-    THROWF (tracing_error, 0, "can't create a container type with a nullptr name");
-  }
+  events_.push_back(new StateEvent(issuer_, this, PAJE_PopState, nullptr, extra));
+}
 
-  simgrid::instr::Type* ret = new simgrid::instr::Type(name, name, "", TYPE_CONTAINER, father);
-  if (father == nullptr) {
-    rootType = ret;
-  } else {
-    XBT_DEBUG("ContainerType %s(%s), child of %s(%s)", ret->getCname(), ret->getId(), father->getCname(),
-              father->getId());
-    LogContainerTypeDefinition(ret);
-  }
-  return ret;
+VariableType::VariableType(const std::string& name, const std::string& color, Type* father)
+    : Type(name, name, color, father)
+{
+  XBT_DEBUG("VariableType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
+  log_definition(PAJE_DefineVariableType);
 }
 
-simgrid::instr::Type* simgrid::instr::Type::eventNew(const char* name, simgrid::instr::Type* father)
+void VariableType::instr_event(double now, double delta, const char* resource, double value)
 {
-  if (name == nullptr){
-    THROWF (tracing_error, 0, "can't create an event 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.
+   */
+
+  // create a key considering the resource and variable
+  std::string key = std::string(resource) + get_name();
+
+  // check if key exists: if it doesn't, set the variable to zero and mark this in the global map.
+  if (platform_variables.find(key) == platform_variables.end()) {
+    set_event(now, 0);
+    platform_variables.insert(key);
   }
 
-  Type* ret = new Type(name, name, "", TYPE_EVENT, father);
-  XBT_DEBUG("EventType %s(%s), child of %s(%s)", ret->getCname(), ret->getId(), father->getCname(), father->getId());
-  LogDefineEventType(ret);
-  return ret;
+  add_event(now, value);
+  sub_event(now + delta, value);
 }
 
-simgrid::instr::Type* simgrid::instr::Type::variableNew(const char* name, std::string color,
-                                                        simgrid::instr::Type* father)
+void VariableType::set_event(double timestamp, double value)
 {
-  if (name == nullptr){
-    THROWF (tracing_error, 0, "can't create a variable type with a nullptr name");
-  }
+  events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SetVariable, value));
+}
 
-  Type* ret = nullptr;
+void VariableType::add_event(double timestamp, double value)
+{
+  events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_AddVariable, value));
+}
+
+void VariableType::sub_event(double timestamp, double value)
+{
+  events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SubVariable, value));
+}
 
-  if (color.empty()) {
-    char white[INSTR_DEFAULT_STR_SIZE] = "1 1 1";
-    ret = new Type (name, name, white, TYPE_VARIABLE, father);
-  }else{
-    ret = new Type (name, name, color, TYPE_VARIABLE, father);
+LinkType::LinkType(const std::string& name, const std::string& alias, Type* father) : ValueType(name, alias, father)
+{
+}
+void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key)
+{
+  start_event(startContainer, value, key, -1);
+}
+
+void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key, int size)
+{
+  new LinkEvent(issuer_, this, PAJE_StartLink, startContainer, value, key, size);
+}
+
+void LinkType::end_event(Container* endContainer, const std::string& value, const std::string& key)
+{
+  new LinkEvent(issuer_, this, PAJE_EndLink, endContainer, value, key, -1);
+}
+
+void Type::log_definition(e_event_type event_type)
+{
+  if (trace_format != simgrid::instr::TraceFormat::Paje)
+    return;
+  XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, event_type, TRACE_precision(), 0.);
+  stream_ << event_type << " " << get_id() << " " << father_->get_id() << " " << get_name();
+  if (is_colored())
+    stream_ << " \"" << color_ << "\"";
+  XBT_DEBUG("Dump %s", stream_.str().c_str());
+  tracing_file << stream_.str() << std::endl;
+}
+
+void Type::log_definition(simgrid::instr::Type* source, simgrid::instr::Type* dest)
+{
+  if (trace_format != simgrid::instr::TraceFormat::Paje)
+    return;
+  XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, PAJE_DefineLinkType, TRACE_precision(), 0.);
+  stream_ << PAJE_DefineLinkType << " " << get_id() << " " << father_->get_id() << " " << source->get_id();
+  stream_ << " " << dest->get_id() << " " << get_name();
+  XBT_DEBUG("Dump %s", stream_.str().c_str());
+  tracing_file << stream_.str() << std::endl;
+}
+
+Type* Type::by_name(const std::string& name)
+{
+  Type* ret = nullptr;
+  for (auto const& elm : children_) {
+    if (elm.second->name_ == name) {
+      if (ret != nullptr) {
+        throw simgrid::TracingError(XBT_THROW_POINT, "there are two children types with the same name?");
+      } else {
+        ret = elm.second.get();
+      }
+    }
   }
-  XBT_DEBUG("VariableType %s(%s), child of %s(%s)", ret->getCname(), ret->getId(), father->getCname(), father->getId());
-  LogVariableTypeDefinition (ret);
+  if (ret == nullptr)
+    throw simgrid::TracingError(
+        XBT_THROW_POINT,
+        simgrid::xbt::string_printf("type with name (%s) not found in father type (%s)", name.c_str(), get_cname()));
   return ret;
 }
 
-simgrid::instr::Type* simgrid::instr::Type::linkNew(const char* name, Type* father, Type* source, Type* 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, "");
+}
 
-  char key[INSTR_DEFAULT_STR_SIZE];
-  snprintf(key, INSTR_DEFAULT_STR_SIZE, "%s-%s-%s", name, source->getId(), dest->getId());
-  Type* ret = new Type(name, key, "", TYPE_LINK, father);
-  XBT_DEBUG("LinkType %s(%s), child of %s(%s)  %s(%s)->%s(%s)", ret->getCname(), ret->getId(), father->getCname(),
-            father->getId(), source->getCname(), source->getId(), dest->getCname(), dest->getId());
-  LogLinkTypeDefinition(ret, source, dest);
-  return ret;
+void ValueType::add_entity_value(const std::string& name, const std::string& color)
+{
+  if (name.empty())
+    throw simgrid::TracingError(XBT_THROW_POINT, "can't get a value with no name");
+
+  auto it = values_.find(name);
+  if (it == values_.end()) {
+    auto res = values_.emplace(name, EntityValue(name, color, this));
+    XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
+    res.first->second.print();
+  }
 }
 
-simgrid::instr::Type* simgrid::instr::Type::stateNew(const char* name, Type* 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 simgrid::TracingError(
+        XBT_THROW_POINT,
+        simgrid::xbt::string_printf("value with name (%s) not found in father type (%s)", name.c_str(), get_cname()));
   }
+  return &ret->second;
+}
 
-  Type* ret = new Type(name, name, "", TYPE_STATE, father);
-  XBT_DEBUG("StateType %s(%s), child of %s(%s)", ret->getCname(), ret->getId(), father->getCname(), father->getId());
-  LogStateTypeDefinition(ret);
-  return ret;
+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());
+}
+
+LinkType* Type::by_name_or_create(const std::string& name, Type* source, 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->get_cname(), ret->get_id(), get_cname(),
+              get_id(), source->get_cname(), source->get_id(), dest->get_cname(), dest->get_id());
+    ret->log_definition(source, dest);
+    return ret;
+  } else
+    return static_cast<LinkType*>(it->second.get());
+}
+}
 }