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"
8 #include "src/instr/instr_private.hpp"
10 #include <unordered_map>
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
14 extern FILE* tracing_file;
15 extern std::map<container_t, FILE*> tracing_files; // TI specific
16 double prefix = 0.0; // TI specific
18 static container_t rootContainer = nullptr; /* the root container */
19 static std::unordered_map<std::string, container_t> allContainers; /* all created containers indexed by name */
20 std::set<std::string> trivaNodeTypes; /* all host types defined */
21 std::set<std::string> trivaEdgeTypes; /* all link types defined */
23 long long int instr_new_paje_id ()
25 static long long int type_id = 0;
33 container_t Container::getRootContainer()
38 NetZoneContainer::NetZoneContainer(std::string name, unsigned int level, NetZoneContainer* father)
39 : Container::Container(name, "", father)
41 netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
42 xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
44 type_ = father_->type_->getOrCreateContainerType(std::string("L") + std::to_string(level));
45 father_->children_.insert({getName(), this});
48 type_ = Type::createRootType();
53 RouterContainer::RouterContainer(std::string name, Container* father) : Container::Container(name, "ROUTER", father)
55 xbt_assert(father, "Only the Root container has no father");
57 netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
58 xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
60 trivaNodeTypes.insert(type_->getName());
63 HostContainer::HostContainer(simgrid::s4u::Host& host, NetZoneContainer* father)
64 : Container::Container(host.getCname(), "HOST", father)
66 xbt_assert(father, "Only the Root container has no father");
68 netpoint_ = host.pimpl_netpoint;
69 xbt_assert(netpoint_, "Element '%s' not found", host.getCname());
71 trivaNodeTypes.insert(type_->getName());
74 Container::Container(std::string name, std::string type_name, Container* father) : name_(name), father_(father)
76 static long long int container_id = 0;
77 id_ = container_id; // id (or alias) of the container
81 XBT_DEBUG("new container %s, child of %s", name.c_str(), father->name_.c_str());
83 if (not type_name.empty()) {
84 type_ = father_->type_->getOrCreateContainerType(type_name);
85 father_->children_.insert({name_, this});
90 //register all kinds by name
91 if (not allContainers.emplace(name_, this).second) {
92 THROWF(tracing_error, 1, "container %s already present in allContainers data structure", name_.c_str());
95 XBT_DEBUG("Add container name '%s'", name_.c_str());
97 //register NODE types for triva configuration
98 if (type_name == "LINK")
99 trivaNodeTypes.insert(type_->getName());
102 Container::~Container()
104 XBT_DEBUG("destroy container %s", name_.c_str());
105 // Begin with destroying my own children
106 for (auto child : children_) {
110 // obligation to dump previous events because they might reference the container that is about to be destroyed
111 TRACE_last_timestamp_to_dump = surf_get_clock();
112 TRACE_paje_dump_buffer(true);
114 // trace my destruction
115 if (not TRACE_disable_destroy() && this != Container::getRootContainer()) {
116 // do not trace the container destruction if user requests or if the container is root
120 // remove me from the allContainers data structure
121 allContainers.erase(name_);
124 Container* Container::byNameOrNull(std::string name)
126 auto cont = allContainers.find(name);
127 return cont == allContainers.end() ? nullptr : cont->second;
130 Container* Container::byName(std::string name)
132 Container* ret = Container::byNameOrNull(name);
134 THROWF(tracing_error, 1, "container with name %s not found", name.c_str());
139 void Container::removeFromParent()
142 XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", name_.c_str(), father_->name_.c_str());
143 father_->children_.erase(name_);
147 void Container::logCreation()
149 double timestamp = SIMIX_get_clock();
150 std::stringstream stream;
152 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, simgrid::instr::PAJE_CreateContainer, timestamp);
154 if (instr_fmt_type == instr_fmt_paje) {
155 stream << std::fixed << std::setprecision(TRACE_precision());
156 stream << simgrid::instr::PAJE_CreateContainer;
158 /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
159 if (timestamp < 1e-12)
163 stream << " " << id_ << " " << type_->getId() << " " << father_->id_ << " \"" << name_ << "\"" << std::endl;
164 fprintf(tracing_file, "%s", stream.str().c_str());
165 XBT_DEBUG("Dump %s", stream.str().c_str());
168 } else if (instr_fmt_type == instr_fmt_TI) {
169 // if we are in the mode with only one file
170 static FILE* ti_unique_file = nullptr;
172 if (tracing_files.empty()) {
173 // generate unique run id with time
174 prefix = xbt_os_time();
177 if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
178 char* folder_name = bprintf("%s_files", TRACE_get_filename());
179 char* filename = bprintf("%s/%f_%s.txt", folder_name, prefix, name_.c_str());
183 mkdir(folder_name, S_IRWXU | S_IRWXG | S_IRWXO);
185 ti_unique_file = fopen(filename, "w");
186 xbt_assert(ti_unique_file, "Tracefile %s could not be opened for writing: %s", filename, strerror(errno));
187 fprintf(tracing_file, "%s\n", filename);
189 xbt_free(folder_name);
193 tracing_files.insert({this, ti_unique_file});
199 void Container::logDestruction()
201 std::stringstream stream;
202 double timestamp = SIMIX_get_clock();
204 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, simgrid::instr::PAJE_DestroyContainer, timestamp);
206 if (instr_fmt_type == instr_fmt_paje) {
207 stream << std::fixed << std::setprecision(TRACE_precision());
208 stream << simgrid::instr::PAJE_DestroyContainer;
210 /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
211 if (timestamp < 1e-12)
215 stream << " " << type_->getId() << " " << id_ << std::endl;
216 fprintf(tracing_file, "%s", stream.str().c_str());
217 XBT_DEBUG("Dump %s", stream.str().c_str());
220 } else if (instr_fmt_type == instr_fmt_TI) {
221 if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
222 FILE* f = tracing_files.at(this);
225 tracing_files.erase(this);