1 /* Copyright (c) 2010-2018. 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 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
12 extern FILE* tracing_file;
13 extern std::map<container_t, FILE*> tracing_files; // TI specific
14 double prefix = 0.0; // TI specific
16 static container_t rootContainer = nullptr; /* the root container */
17 static std::map<std::string, container_t> allContainers; /* all created containers indexed by name */
18 std::set<std::string> trivaNodeTypes; /* all host types defined */
19 std::set<std::string> trivaEdgeTypes; /* all link types defined */
21 long long int instr_new_paje_id ()
23 static long long int type_id = 0;
30 container_t Container::getRoot()
35 NetZoneContainer::NetZoneContainer(std::string name, unsigned int level, NetZoneContainer* father)
36 : Container::Container(name, "", father)
38 netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
39 xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
41 type_ = father_->type_->getOrCreateContainerType(std::string("L") + std::to_string(level));
42 father_->children_.insert({get_name(), this});
45 type_ = new ContainerType("0");
50 RouterContainer::RouterContainer(std::string name, Container* father) : Container::Container(name, "ROUTER", father)
52 xbt_assert(father, "Only the Root container has no father");
54 netpoint_ = simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name);
55 xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
57 trivaNodeTypes.insert(type_->get_name());
60 HostContainer::HostContainer(simgrid::s4u::Host& host, NetZoneContainer* father)
61 : Container::Container(host.get_cname(), "HOST", father)
63 xbt_assert(father, "Only the Root container has no father");
65 netpoint_ = host.pimpl_netpoint;
66 xbt_assert(netpoint_, "Element '%s' not found", host.get_cname());
68 trivaNodeTypes.insert(type_->get_name());
71 Container::Container(std::string name, std::string type_name, Container* father) : name_(name), father_(father)
73 static long long int container_id = 0;
74 id_ = container_id; // id (or alias) of the container
78 XBT_DEBUG("new container %s, child of %s", name.c_str(), father->name_.c_str());
80 if (not type_name.empty()) {
81 type_ = father_->type_->getOrCreateContainerType(type_name);
82 father_->children_.insert({name_, this});
87 //register all kinds by name
88 if (not allContainers.emplace(name_, this).second)
89 THROWF(tracing_error, 1, "container %s already present in allContainers data structure", name_.c_str());
91 XBT_DEBUG("Add container name '%s'", name_.c_str());
93 //register NODE types for triva configuration
94 if (type_name == "LINK")
95 trivaNodeTypes.insert(type_->get_name());
98 Container::~Container()
100 XBT_DEBUG("destroy container %s", name_.c_str());
101 // Begin with destroying my own children
102 for (auto child : children_)
105 // obligation to dump previous events because they might reference the container that is about to be destroyed
106 TRACE_last_timestamp_to_dump = SIMIX_get_clock();
107 TRACE_paje_dump_buffer(true);
109 // trace my destruction, but not if user requests so or if the container is root
110 if (not TRACE_disable_destroy() && this != Container::getRoot())
113 // remove me from the allContainers data structure
114 allContainers.erase(name_);
117 void Container::createChild(std::string name, std::string type_name)
119 new Container(name, type_name, this);
122 Container* Container::byNameOrNull(std::string name)
124 auto cont = allContainers.find(name);
125 return cont == allContainers.end() ? nullptr : cont->second;
128 Container* Container::byName(std::string name)
130 Container* ret = Container::byNameOrNull(name);
132 THROWF(tracing_error, 1, "container with name %s not found", name.c_str());
137 void Container::removeFromParent()
140 XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", get_cname(), father_->get_cname());
141 father_->children_.erase(name_);
146 void Container::logCreation()
148 double timestamp = SIMIX_get_clock();
149 std::stringstream stream;
151 XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_CreateContainer, timestamp);
153 if (trace_format == simgrid::instr::TraceFormat::Paje) {
154 stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_CreateContainer << " ";
155 stream << timestamp << " " << id_ << " " << type_->get_id() << " " << father_->id_ << " \"" << name_ << "\"";
156 XBT_DEBUG("Dump %s", stream.str().c_str());
157 fprintf(tracing_file, "%s\n", stream.str().c_str());
158 } else if (trace_format == simgrid::instr::TraceFormat::Ti) {
159 // if we are in the mode with only one file
160 static FILE* ti_unique_file = nullptr;
162 if (tracing_files.empty()) {
163 // generate unique run id with time
164 prefix = xbt_os_time();
167 if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
168 std::string folder_name = TRACE_get_filename() + "_files";
169 std::string filename = folder_name + "/" + std::to_string(prefix) + "_" + name_ + ".txt";
171 _mkdir(folder_name.c_str());
173 mkdir(folder_name.c_str(), S_IRWXU | S_IRWXG | S_IRWXO);
175 ti_unique_file = fopen(filename.c_str(), "w");
176 xbt_assert(ti_unique_file, "Tracefile %s could not be opened for writing: %s", filename.c_str(), strerror(errno));
177 fprintf(tracing_file, "%s\n", filename.c_str());
179 tracing_files.insert({this, ti_unique_file});
185 void Container::logDestruction()
187 std::stringstream stream;
188 double timestamp = SIMIX_get_clock();
190 XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_DestroyContainer, timestamp);
192 if (trace_format == simgrid::instr::TraceFormat::Paje) {
193 stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_DestroyContainer << " ";
194 stream << timestamp << " " << type_->get_id() << " " << id_;
195 XBT_DEBUG("Dump %s", stream.str().c_str());
196 fprintf(tracing_file, "%s\n", stream.str().c_str());
197 } else if (trace_format == simgrid::instr::TraceFormat::Ti) {
198 if (not xbt_cfg_get_boolean("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
199 fclose(tracing_files.at(this));
201 tracing_files.erase(this);
207 StateType* Container::getState(std::string name)
209 StateType* ret = dynamic_cast<StateType*>(type_->byName(name));
210 ret->setCallingContainer(this);
214 LinkType* Container::getLink(std::string name)
216 LinkType* ret = dynamic_cast<LinkType*>(type_->byName(name));
217 ret->setCallingContainer(this);
221 VariableType* Container::getVariable(std::string name)
223 VariableType* ret = dynamic_cast<VariableType*>(type_->byName(name));
224 ret->setCallingContainer(this);