-/* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2010-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 "simgrid/s4u/Engine.hpp"
#include "simgrid/s4u/Host.hpp"
#include "src/instr/instr_private.hpp"
-#include "surf/surf.h"
-#include <unordered_map>
XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
-extern FILE* tracing_file;
-extern std::map<container_t, FILE*> tracing_files; // TI specific
-double prefix = 0.0; // TI specific
+namespace simgrid::instr {
-static container_t rootContainer = nullptr; /* the root container */
-static std::unordered_map<std::string, container_t> allContainers; /* all created containers indexed by name */
-std::set<std::string> trivaNodeTypes; /* all host types defined */
-std::set<std::string> trivaEdgeTypes; /* all link types defined */
+Container* Container::root_container_ = nullptr; /* the root container */
+std::map<std::string, Container*, std::less<>> Container::all_containers_; /* all created containers indexed by name */
-long long int instr_new_paje_id ()
+NetZoneContainer::NetZoneContainer(const std::string& name, unsigned int level, NetZoneContainer* parent)
+ : Container::Container(name, "", parent)
{
- static long long int type_id = 0;
- return type_id++;
+ xbt_assert(s4u::Engine::get_instance()->netpoint_by_name_or_null(get_name()), "Element '%s' not found", get_cname());
+ if (parent_) {
+ std::string type_name = "L" + std::to_string(level);
+ type_ = parent_->type_->by_name_or_create<ContainerType>(type_name);
+ parent_->children_.try_emplace(get_name(), this);
+ on_creation(*this);
+ } else {
+ type_ = new ContainerType("0");
+ set_root(this);
+ }
}
-container_t PJ_container_get_root()
+RouterContainer::RouterContainer(const std::string& name, Container* parent)
+ : Container::Container(name, "ROUTER", parent)
{
- return rootContainer;
+ xbt_assert(parent, "Only the Root container has no parent");
+ xbt_assert(s4u::Engine::get_instance()->netpoint_by_name_or_null(get_name()), "Element '%s' not found", get_cname());
}
-void PJ_container_set_root (container_t root)
+HostContainer::HostContainer(s4u::Host const& host, NetZoneContainer* parent)
+ : Container::Container(host.get_name(), "HOST", parent)
{
- rootContainer = root;
+ xbt_assert(parent, "Only the Root container has no parent");
+ xbt_assert(host.get_netpoint(), "Element '%s' not found", host.get_cname());
}
-namespace simgrid {
-namespace instr {
-
-Container::Container(std::string name, e_container_types kind, Container* father)
- : kind_(kind), name_(name), father_(father)
+Container::Container(const std::string& name, const std::string& type_name, Container* parent)
+ : name_(name), parent_(parent)
{
static long long int container_id = 0;
- id_ = std::to_string(container_id); // id (or alias) of the container
+ id_ = container_id; // id (or alias) of the container
container_id++;
- if (father_) {
- level_ = father_->level_ + 1;
- XBT_DEBUG("new container %s, child of %s", name.c_str(), father->name_.c_str());
- }
+ if (parent_) {
+ XBT_DEBUG("new container %s, child of %s", get_cname(), parent->get_cname());
- // Search for network_element_t for AS, ROUTER and HOST
- // Name the kind of container. For AS otherwise, the name depends on its level
- std::string typeNameBuff;
- switch (kind_) {
- case INSTR_AS:
- netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
- xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
- typeNameBuff = std::string("L") + std::to_string(level_);
- break;
- case INSTR_ROUTER:
- netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
- xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
- typeNameBuff = std::string("ROUTER");
- break;
- case INSTR_HOST:
- netpoint_ = sg_host_by_name(name.c_str())->pimpl_netpoint;
- xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
- typeNameBuff = std::string("HOST");
- break;
- case INSTR_LINK:
- typeNameBuff = std::string("LINK");
- break;
- case INSTR_SMPI:
- typeNameBuff = std::string("MPI");
- break;
- case INSTR_MSG_PROCESS:
- typeNameBuff = std::string("MSG_PROCESS");
- break;
- case INSTR_MSG_VM:
- typeNameBuff = std::string("MSG_VM");
- break;
- case INSTR_MSG_TASK:
- typeNameBuff = std::string("MSG_TASK");
- break;
- default:
- THROWF(tracing_error, 0, "new container kind is unknown.");
- break;
- }
-
- if (father_) {
- type_ = father_->type_->getOrCreateContainerType(typeNameBuff);
- father_->children_.insert({name_, this});
- logCreation();
- } else if (kind_ == INSTR_AS) {
- type_ = Type::createRootType();
+ if (not type_name.empty()) {
+ type_ = parent_->type_->by_name_or_create<ContainerType>(type_name);
+ parent_->children_.try_emplace(name_, this);
+ on_creation(*this);
+ }
}
//register all kinds by name
- if (not allContainers.emplace(name_, this).second) {
- THROWF(tracing_error, 1, "container %s already present in allContainers data structure", name_.c_str());
- }
-
- XBT_DEBUG("Add container name '%s'", name_.c_str());
+ if (not all_containers_.try_emplace(name_, this).second)
+ throw TracingError(XBT_THROW_POINT,
+ xbt::string_printf("container %s already present in all_containers_", get_cname()));
- //register NODE types for triva configuration
- if (kind_ == INSTR_HOST || kind_ == INSTR_LINK || kind_ == INSTR_ROUTER)
- trivaNodeTypes.insert(type_->getName());
+ XBT_DEBUG("Add container name '%s'", get_cname());
}
Container::~Container()
{
- XBT_DEBUG("destroy container %s", name_.c_str());
+ XBT_DEBUG("destroy container %s", get_cname());
// Begin with destroying my own children
- for (auto child : children_) {
- delete child.second;
- }
+ for (auto const& [_, child] : children_)
+ delete child;
+
+ // remove me from the all_containers_ data structure
+ all_containers_.erase(name_);
// obligation to dump previous events because they might reference the container that is about to be destroyed
- TRACE_last_timestamp_to_dump = surf_get_clock();
- TRACE_paje_dump_buffer(true);
+ last_timestamp_to_dump = simgrid_get_clock();
+ dump_buffer(true);
- // trace my destruction
- if (not TRACE_disable_destroy() && this != PJ_container_get_root()) {
- // do not trace the container destruction if user requests or if the container is root
- logDestruction();
- }
+ on_destruction(*this);
+}
- // remove me from the allContainers data structure
- allContainers.erase(name_);
+void Container::create_child(const std::string& name, const std::string& type_name)
+{
+ new Container(name, type_name, this);
}
-Container* Container::byNameOrNull(std::string name)
+Container* Container::by_name_or_null(const std::string& name)
{
- auto cont = allContainers.find(name);
- return cont == allContainers.end() ? nullptr : cont->second;
+ auto cont = all_containers_.find(name);
+ return cont == all_containers_.end() ? nullptr : cont->second;
}
-Container* Container::byName(std::string name)
+Container* Container::by_name(const std::string& name)
{
- Container* ret = Container::byNameOrNull(name);
- if (ret == nullptr)
- THROWF(tracing_error, 1, "container with name %s not found", name.c_str());
+ Container* ret = Container::by_name_or_null(name);
+ xbt_assert(ret != nullptr, "container with name %s not found", name.c_str());
return ret;
}
-void Container::removeFromParent()
+void Container::remove_from_parent()
{
- if (father_) {
- XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", name_.c_str(), father_->name_.c_str());
- father_->children_.erase(name_);
+ if (parent_) {
+ XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", get_cname(), parent_->get_cname());
+ parent_->children_.erase(name_);
}
+ delete this;
}
-void Container::logCreation()
+StateType* Container::get_state(const std::string& name)
{
- double timestamp = SIMIX_get_clock();
- std::stringstream stream;
-
- XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, simgrid::instr::PAJE_CreateContainer, timestamp);
-
- if (instr_fmt_type == instr_fmt_paje) {
- stream << std::fixed << std::setprecision(TRACE_precision());
- stream << simgrid::instr::PAJE_CreateContainer;
- stream << " ";
- /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
- if (timestamp < 1e-12)
- stream << 0;
- else
- stream << timestamp;
- stream << " " << id_ << " " << type_->getId() << " " << father_->id_ << " \"" << name_ << "\"" << std::endl;
- fprintf(tracing_file, "%s", stream.str().c_str());
- XBT_DEBUG("Dump %s", stream.str().c_str());
- stream.str("");
- stream.clear();
- } else if (instr_fmt_type == instr_fmt_TI) {
- // if we are in the mode with only one file
- static FILE* ti_unique_file = nullptr;
-
- if (tracing_files.empty()) {
- // generate unique run id with time
- prefix = xbt_os_time();
- }
-
- if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
- char* folder_name = bprintf("%s_files", TRACE_get_filename());
- char* filename = bprintf("%s/%f_%s.txt", folder_name, prefix, name_.c_str());
-#ifdef WIN32
- _mkdir(folder_name);
-#else
- mkdir(folder_name, S_IRWXU | S_IRWXG | S_IRWXO);
-#endif
- ti_unique_file = fopen(filename, "w");
- xbt_assert(ti_unique_file, "Tracefile %s could not be opened for writing: %s", filename, strerror(errno));
- fprintf(tracing_file, "%s\n", filename);
-
- xbt_free(folder_name);
- xbt_free(filename);
- }
-
- tracing_files.insert({this, ti_unique_file});
- } else {
- THROW_IMPOSSIBLE;
- }
+ return static_cast<StateType*>(type_->by_name(name)->set_calling_container(this));
}
-void Container::logDestruction()
+LinkType* Container::get_link(const std::string& name)
{
- std::stringstream stream;
- double timestamp = SIMIX_get_clock();
-
- XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, simgrid::instr::PAJE_DestroyContainer, timestamp);
-
- if (instr_fmt_type == instr_fmt_paje) {
- stream << std::fixed << std::setprecision(TRACE_precision());
- stream << simgrid::instr::PAJE_DestroyContainer;
- stream << " ";
- /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
- if (timestamp < 1e-12)
- stream << 0;
- else
- stream << timestamp;
- stream << " " << type_->getId() << " " << id_ << std::endl;
- fprintf(tracing_file, "%s", stream.str().c_str());
- XBT_DEBUG("Dump %s", stream.str().c_str());
- stream.str("");
- stream.clear();
- } else if (instr_fmt_type == instr_fmt_TI) {
- if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
- FILE* f = tracing_files.at(this);
- fclose(f);
- }
- tracing_files.erase(this);
- } else {
- THROW_IMPOSSIBLE;
- }
+ return static_cast<LinkType*>(type_->by_name(name)->set_calling_container(this));
}
+
+VariableType* Container::get_variable(const std::string& name)
+{
+ return static_cast<VariableType*>(type_->by_name(name)->set_calling_container(this));
}
+
+EntityValue::EntityValue(const std::string& name, const std::string& color, Type* parent)
+ : name_(name), color_(color), parent_(parent)
+{
+ on_creation(*this);
}
+
+} // namespace simgrid::instr