1 /* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "simgrid/s4u/Engine.hpp"
7 #include "simgrid/s4u/Host.hpp"
11 #include "src/instr/instr_private.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
15 static container_t rootContainer = nullptr; /* the root container */
16 static xbt_dict_t allContainers = nullptr; /* all created containers indexed by name */
17 std::set<std::string> trivaNodeTypes; /* all host types defined */
18 std::set<std::string> trivaEdgeTypes; /* all link types defined */
20 long long int instr_new_paje_id ()
22 static long long int type_id = 0;
26 void PJ_container_alloc ()
28 allContainers = xbt_dict_new_homogeneous(nullptr);
31 void PJ_container_release ()
33 xbt_dict_free (&allContainers);
36 void PJ_container_set_root (container_t root)
41 container_t PJ_container_new(const char* name, simgrid::instr::e_container_types kind, container_t father)
44 THROWF (tracing_error, 0, "can't create a container with a nullptr name");
47 static long long int container_id = 0;
48 char id_str[INSTR_DEFAULT_STR_SIZE];
49 snprintf (id_str, INSTR_DEFAULT_STR_SIZE, "%lld", container_id);
52 container_t newContainer = xbt_new0(simgrid::instr::Container, 1);
53 newContainer->name_ = xbt_strdup(name); // name of the container
54 newContainer->id_ = xbt_strdup(id_str); // id (or alias) of the container
55 newContainer->father_ = father;
56 sg_host_t sg_host = sg_host_by_name(name);
58 //Search for network_element_t
60 case simgrid::instr::INSTR_HOST:
61 newContainer->netpoint_ = sg_host->pimpl_netpoint;
62 xbt_assert(newContainer->netpoint_, "Element '%s' not found", name);
64 case simgrid::instr::INSTR_ROUTER:
65 newContainer->netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
66 xbt_assert(newContainer->netpoint_, "Element '%s' not found", name);
68 case simgrid::instr::INSTR_AS:
69 newContainer->netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
70 xbt_assert(newContainer->netpoint_, "Element '%s' not found", name);
73 newContainer->netpoint_ = nullptr;
77 // level depends on level of father
78 if (newContainer->father_) {
79 newContainer->level_ = newContainer->father_->level_ + 1;
80 XBT_DEBUG("new container %s, child of %s", name, father->name_);
82 newContainer->level_ = 0;
84 // type definition (method depends on kind of this new container)
85 newContainer->kind_ = kind;
86 if (newContainer->kind_ == simgrid::instr::INSTR_AS) {
87 //if this container is of an AS, its type name depends on its level
88 char as_typename[INSTR_DEFAULT_STR_SIZE];
89 snprintf(as_typename, INSTR_DEFAULT_STR_SIZE, "L%d", newContainer->level_);
90 if (newContainer->father_) {
91 newContainer->type_ = simgrid::instr::Type::getOrNull(as_typename, newContainer->father_->type_);
92 if (newContainer->type_ == nullptr) {
93 newContainer->type_ = simgrid::instr::Type::containerNew(as_typename, newContainer->father_->type_);
96 newContainer->type_ = simgrid::instr::Type::containerNew("0", nullptr);
99 //otherwise, the name is its kind
100 char typeNameBuff[INSTR_DEFAULT_STR_SIZE];
101 switch (newContainer->kind_) {
102 case simgrid::instr::INSTR_HOST:
103 snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "HOST");
105 case simgrid::instr::INSTR_LINK:
106 snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "LINK");
108 case simgrid::instr::INSTR_ROUTER:
109 snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "ROUTER");
111 case simgrid::instr::INSTR_SMPI:
112 snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MPI");
114 case simgrid::instr::INSTR_MSG_PROCESS:
115 snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_PROCESS");
117 case simgrid::instr::INSTR_MSG_VM:
118 snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_VM");
120 case simgrid::instr::INSTR_MSG_TASK:
121 snprintf (typeNameBuff, INSTR_DEFAULT_STR_SIZE, "MSG_TASK");
124 THROWF (tracing_error, 0, "new container kind is unknown.");
127 simgrid::instr::Type* type = simgrid::instr::Type::getOrNull(typeNameBuff, newContainer->father_->type_);
128 if (type == nullptr){
129 newContainer->type_ = simgrid::instr::Type::containerNew(typeNameBuff, newContainer->father_->type_);
131 newContainer->type_ = type;
134 newContainer->children_ = xbt_dict_new_homogeneous(nullptr);
135 if (newContainer->father_) {
136 xbt_dict_set(newContainer->father_->children_, newContainer->name_, newContainer, nullptr);
137 LogContainerCreation(newContainer);
140 //register all kinds by name
141 if (xbt_dict_get_or_null(allContainers, newContainer->name_) != nullptr) {
142 THROWF(tracing_error, 1, "container %s already present in allContainers data structure", newContainer->name_);
145 xbt_dict_set(allContainers, newContainer->name_, newContainer, nullptr);
146 XBT_DEBUG("Add container name '%s'", newContainer->name_);
148 //register NODE types for triva configuration
149 if (newContainer->kind_ == simgrid::instr::INSTR_HOST || newContainer->kind_ == simgrid::instr::INSTR_LINK ||
150 newContainer->kind_ == simgrid::instr::INSTR_ROUTER) {
151 trivaNodeTypes.insert(newContainer->type_->name_);
156 container_t PJ_container_get (const char *name)
158 container_t ret = PJ_container_get_or_null (name);
160 THROWF(tracing_error, 1, "container with name %s not found", name);
165 container_t PJ_container_get_or_null (const char *name)
167 return static_cast<container_t>(name != nullptr ? xbt_dict_get_or_null(allContainers, name) : nullptr);
170 container_t PJ_container_get_root ()
172 return rootContainer;
175 void PJ_container_remove_from_parent (container_t child)
177 if (child == nullptr){
178 THROWF (tracing_error, 0, "can't remove from parent with a nullptr child");
181 container_t parent = child->father_;
183 XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", child->name_, parent->name_);
184 xbt_dict_remove(parent->children_, child->name_);
188 void PJ_container_free (container_t container)
190 if (container == nullptr){
191 THROWF (tracing_error, 0, "trying to free a nullptr container");
193 XBT_DEBUG("destroy container %s", container->name_);
195 //obligation to dump previous events because they might
196 //reference the container that is about to be destroyed
197 TRACE_last_timestamp_to_dump = surf_get_clock();
198 TRACE_paje_dump_buffer(1);
200 //trace my destruction
201 if (not TRACE_disable_destroy() && container != PJ_container_get_root()) {
202 //do not trace the container destruction if user requests
203 //or if the container is root
204 LogContainerDestruction(container);
207 //remove it from allContainers data structure
208 xbt_dict_remove(allContainers, container->name_);
211 xbt_free(container->name_);
212 xbt_free(container->id_);
213 xbt_dict_free(&container->children_);
214 xbt_free (container);
218 static void recursiveDestroyContainer (container_t container)
220 if (container == nullptr){
221 THROWF (tracing_error, 0, "trying to recursively destroy a nullptr container");
223 XBT_DEBUG("recursiveDestroyContainer %s", container->name_);
224 xbt_dict_cursor_t cursor = nullptr;
227 xbt_dict_foreach (container->children_, cursor, child_name, child) {
228 recursiveDestroyContainer (child);
230 PJ_container_free (container);
233 void PJ_container_free_all ()
235 container_t root = PJ_container_get_root();
236 if (root == nullptr){
237 THROWF (tracing_error, 0, "trying to free all containers, but root is nullptr");
239 recursiveDestroyContainer (root);
240 rootContainer = nullptr;
243 if (not xbt_dict_is_empty(allContainers)) {
244 THROWF(tracing_error, 0, "some containers still present even after destroying all of them");