-/* 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 "surf/surf.h"
-
-#include "src/instr/instr_private.h"
+#include "src/instr/instr_private.hpp"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
-static container_t rootContainer = nullptr; /* the root container */
-static xbt_dict_t allContainers = nullptr; /* all created containers indexed by name */
-std::set<std::string> trivaNodeTypes; /* all host types defined */
-std::set<std::string> trivaEdgeTypes; /* all link types defined */
+namespace simgrid::instr {
-long long int instr_new_paje_id ()
-{
- static long long int type_id = 0;
- return type_id++;
-}
+Container* Container::root_container_ = nullptr; /* the root container */
+std::map<std::string, Container*, std::less<>> Container::all_containers_; /* all created containers indexed by name */
-void PJ_container_alloc ()
+NetZoneContainer::NetZoneContainer(const std::string& name, unsigned int level, NetZoneContainer* parent)
+ : Container::Container(name, "", parent)
{
- allContainers = xbt_dict_new_homogeneous(nullptr);
+ 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);
+ }
}
-void PJ_container_release ()
+RouterContainer::RouterContainer(const std::string& name, Container* parent)
+ : Container::Container(name, "ROUTER", parent)
{
- xbt_dict_free (&allContainers);
+ 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());
}
-container_t PJ_container_new(const char* name, simgrid::instr::e_container_types kind, container_t father)
+Container::Container(const std::string& name, const std::string& type_name, Container* parent)
+ : name_(name), parent_(parent)
{
- if (name == nullptr){
- THROWF (tracing_error, 0, "can't create a container with a nullptr name");
- }
-
static long long int container_id = 0;
- char id_str[INSTR_DEFAULT_STR_SIZE];
- snprintf (id_str, INSTR_DEFAULT_STR_SIZE, "%lld", container_id);
+ id_ = container_id; // id (or alias) of the container
container_id++;
- container_t newContainer = xbt_new0(simgrid::instr::s_container, 1);
- newContainer->name_ = xbt_strdup(name); // name of the container
- newContainer->id_ = xbt_strdup(id_str); // id (or alias) of the container
- newContainer->father_ = father;
- sg_host_t sg_host = sg_host_by_name(name);
-
- //Search for network_element_t
- switch (kind){
- case simgrid::instr::INSTR_HOST:
- newContainer->netpoint_ = sg_host->pimpl_netpoint;
- xbt_assert(newContainer->netpoint_, "Element '%s' not found", name);
- break;
- case simgrid::instr::INSTR_ROUTER:
- newContainer->netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
- xbt_assert(newContainer->netpoint_, "Element '%s' not found", name);
- break;
- case simgrid::instr::INSTR_AS:
- newContainer->netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
- xbt_assert(newContainer->netpoint_, "Element '%s' not found", name);
- break;
- default:
- newContainer->netpoint_ = nullptr;
- break;
- }
+ if (parent_) {
+ XBT_DEBUG("new container %s, child of %s", get_cname(), parent->get_cname());
- // level depends on level of father
- if (newContainer->father_) {
- newContainer->level_ = newContainer->father_->level_ + 1;
- XBT_DEBUG("new container %s, child of %s", name, father->name_);
- }else{
- newContainer->level_ = 0;
- }
- // type definition (method depends on kind of this new container)
- newContainer->kind_ = kind;
- if (newContainer->kind_ == simgrid::instr::INSTR_AS) {
- //if this container is of an AS, its type name depends on its level
- char as_typename[INSTR_DEFAULT_STR_SIZE];
- snprintf(as_typename, INSTR_DEFAULT_STR_SIZE, "L%d", newContainer->level_);
- if (newContainer->father_) {
- newContainer->type_ = simgrid::instr::Type::getOrNull(as_typename, newContainer->father_->type_);
- if (newContainer->type_ == nullptr) {
- newContainer->type_ = simgrid::instr::Type::containerNew(as_typename, newContainer->father_->type_);
- }
- }else{
- newContainer->type_ = simgrid::instr::Type::containerNew("0", nullptr);
- }
- }else{
- //otherwise, the name is its kind
- char typeNameBuff[INSTR_DEFAULT_STR_SIZE];
- switch (newContainer->kind_) {
- case simgrid::instr::INSTR_HOST:
- snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "HOST");
- break;
- case simgrid::instr::INSTR_LINK:
- snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "LINK");
- break;
- case simgrid::instr::INSTR_ROUTER:
- snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "ROUTER");
- break;
- case simgrid::instr::INSTR_SMPI:
- snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MPI");
- break;
- case simgrid::instr::INSTR_MSG_PROCESS:
- snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_PROCESS");
- break;
- case simgrid::instr::INSTR_MSG_VM:
- snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_VM");
- break;
- case simgrid::instr::INSTR_MSG_TASK:
- snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_TASK");
- break;
- default:
- THROWF (tracing_error, 0, "new container kind is unknown.");
- break;
- }
- simgrid::instr::Type* type = simgrid::instr::Type::getOrNull(typeNameBuff, newContainer->father_->type_);
- if (type == nullptr){
- newContainer->type_ = simgrid::instr::Type::containerNew(typeNameBuff, newContainer->father_->type_);
- }else{
- newContainer->type_ = type;
+ if (not type_name.empty()) {
+ type_ = parent_->type_->by_name_or_create<ContainerType>(type_name);
+ parent_->children_.try_emplace(name_, this);
+ on_creation(*this);
}
}
- newContainer->children_ = xbt_dict_new_homogeneous(nullptr);
- if (newContainer->father_) {
- xbt_dict_set(newContainer->father_->children_, newContainer->name_, newContainer, nullptr);
- LogContainerCreation(newContainer);
- }
//register all kinds by name
- if (xbt_dict_get_or_null(allContainers, newContainer->name_) != nullptr) {
- THROWF(tracing_error, 1, "container %s already present in allContainers data structure", newContainer->name_);
- }
+ 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()));
- xbt_dict_set(allContainers, newContainer->name_, newContainer, nullptr);
- XBT_DEBUG("Add container name '%s'", newContainer->name_);
-
- //register NODE types for triva configuration
- if (newContainer->kind_ == simgrid::instr::INSTR_HOST || newContainer->kind_ == simgrid::instr::INSTR_LINK ||
- newContainer->kind_ == simgrid::instr::INSTR_ROUTER) {
- trivaNodeTypes.insert(newContainer->type_->name_);
- }
- return newContainer;
+ XBT_DEBUG("Add container name '%s'", get_cname());
}
-container_t PJ_container_get (const char *name)
+Container::~Container()
{
- container_t ret = PJ_container_get_or_null (name);
- if (ret == nullptr){
- THROWF(tracing_error, 1, "container with name %s not found", name);
- }
- return ret;
+ XBT_DEBUG("destroy container %s", get_cname());
+ // Begin with destroying my own children
+ 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
+ last_timestamp_to_dump = simgrid_get_clock();
+ dump_buffer(true);
+
+ on_destruction(*this);
}
-container_t PJ_container_get_or_null (const char *name)
+void Container::create_child(const std::string& name, const std::string& type_name)
{
- return static_cast<container_t>(name != nullptr ? xbt_dict_get_or_null(allContainers, name) : nullptr);
+ new Container(name, type_name, this);
}
-container_t PJ_container_get_root ()
+Container* Container::by_name_or_null(const std::string& name)
{
- return rootContainer;
+ auto cont = all_containers_.find(name);
+ return cont == all_containers_.end() ? nullptr : cont->second;
}
-void PJ_container_remove_from_parent (container_t child)
+Container* Container::by_name(const std::string& name)
{
- if (child == nullptr){
- THROWF (tracing_error, 0, "can't remove from parent with a nullptr child");
- }
+ Container* ret = Container::by_name_or_null(name);
+ xbt_assert(ret != nullptr, "container with name %s not found", name.c_str());
- container_t parent = child->father_;
- if (parent){
- XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", child->name_, parent->name_);
- xbt_dict_remove(parent->children_, child->name_);
- }
+ return ret;
}
-void PJ_container_free (container_t container)
+void Container::remove_from_parent()
{
- if (container == nullptr){
- THROWF (tracing_error, 0, "trying to free a nullptr container");
- }
- XBT_DEBUG("destroy container %s", container->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(1);
-
- //trace my destruction
- if (not TRACE_disable_destroy() && container != PJ_container_get_root()) {
- //do not trace the container destruction if user requests
- //or if the container is root
- LogContainerDestruction(container);
+ if (parent_) {
+ XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", get_cname(), parent_->get_cname());
+ parent_->children_.erase(name_);
}
+ delete this;
+}
- //remove it from allContainers data structure
- xbt_dict_remove(allContainers, container->name_);
-
- //free
- xbt_free(container->name_);
- xbt_free(container->id_);
- xbt_dict_free(&container->children_);
- xbt_free (container);
- container = nullptr;
+StateType* Container::get_state(const std::string& name)
+{
+ return static_cast<StateType*>(type_->by_name(name)->set_calling_container(this));
}
-static void recursiveDestroyContainer (container_t container)
+LinkType* Container::get_link(const std::string& name)
{
- if (container == nullptr){
- THROWF (tracing_error, 0, "trying to recursively destroy a nullptr container");
- }
- XBT_DEBUG("recursiveDestroyContainer %s", container->name_);
- xbt_dict_cursor_t cursor = nullptr;
- container_t child;
- char *child_name;
- xbt_dict_foreach (container->children_, cursor, child_name, child) {
- recursiveDestroyContainer (child);
- }
- PJ_container_free (container);
+ return static_cast<LinkType*>(type_->by_name(name)->set_calling_container(this));
}
-void PJ_container_free_all ()
+VariableType* Container::get_variable(const std::string& name)
{
- container_t root = PJ_container_get_root();
- if (root == nullptr){
- THROWF (tracing_error, 0, "trying to free all containers, but root is nullptr");
- }
- recursiveDestroyContainer (root);
- rootContainer = nullptr;
+ return static_cast<VariableType*>(type_->by_name(name)->set_calling_container(this));
+}
- //checks
- if (not xbt_dict_is_empty(allContainers)) {
- THROWF(tracing_error, 0, "some containers still present even after destroying all of them");
- }
+EntityValue::EntityValue(const std::string& name, const std::string& color, Type* parent)
+ : name_(name), color_(color), parent_(parent)
+{
+ on_creation(*this);
}
+
+} // namespace simgrid::instr
