1 /* Copyright (c) 2010-2019. 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"
11 #include <direct.h> // _mkdir
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_containers, instr, "Paje tracing event system (containers)");
16 extern std::ofstream tracing_file;
17 std::map<container_t, std::ofstream*> tracing_files; // TI specific
18 double prefix = 0.0; // TI specific
20 static container_t rootContainer = nullptr; /* the root container */
21 static std::map<std::string, container_t> allContainers; /* all created containers indexed by name */
22 std::set<std::string> trivaNodeTypes; /* all host types defined */
23 std::set<std::string> trivaEdgeTypes; /* all link types defined */
25 long long int instr_new_paje_id ()
27 static long long int type_id = 0;
34 container_t Container::get_root()
39 NetZoneContainer::NetZoneContainer(const std::string& name, unsigned int level, NetZoneContainer* father)
40 : Container::Container(name, "", father)
42 netpoint_ = simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(get_name());
43 xbt_assert(netpoint_, "Element '%s' not found", get_cname());
45 std::string type_name = std::string("L") + std::to_string(level);
46 type_ = father_->type_->by_name_or_create<ContainerType>(type_name);
47 father_->children_.insert({get_name(), this});
50 type_ = new ContainerType("0");
55 RouterContainer::RouterContainer(const std::string& name, Container* father)
56 : Container::Container(name, "ROUTER", father)
58 xbt_assert(father, "Only the Root container has no father");
60 netpoint_ = simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(get_name());
61 xbt_assert(netpoint_, "Element '%s' not found", get_cname());
63 trivaNodeTypes.insert(type_->get_name());
66 HostContainer::HostContainer(simgrid::s4u::Host const& host, NetZoneContainer* father)
67 : Container::Container(host.get_name(), "HOST", father)
69 xbt_assert(father, "Only the Root container has no father");
71 netpoint_ = host.pimpl_netpoint;
72 xbt_assert(netpoint_, "Element '%s' not found", host.get_cname());
74 trivaNodeTypes.insert(type_->get_name());
77 Container::Container(const std::string& name, const std::string& type_name, Container* father)
78 : name_(name), father_(father)
80 static long long int container_id = 0;
81 id_ = container_id; // id (or alias) of the container
85 XBT_DEBUG("new container %s, child of %s", get_cname(), father->get_cname());
87 if (not type_name.empty()) {
88 type_ = father_->type_->by_name_or_create<ContainerType>(type_name);
89 father_->children_.insert({name_, this});
94 //register all kinds by name
95 if (not allContainers.emplace(name_, this).second)
96 THROWF(tracing_error, 1, "container %s already present in allContainers data structure", get_cname());
98 XBT_DEBUG("Add container name '%s'", get_cname());
100 //register NODE types for triva configuration
101 if (type_name == "LINK")
102 trivaNodeTypes.insert(type_->get_name());
105 Container::~Container()
107 XBT_DEBUG("destroy container %s", get_cname());
108 // Begin with destroying my own children
109 for (auto child : children_)
112 // obligation to dump previous events because they might reference the container that is about to be destroyed
113 TRACE_last_timestamp_to_dump = SIMIX_get_clock();
114 TRACE_paje_dump_buffer(true);
116 // trace my destruction, but not if user requests so or if the container is root
117 if (not TRACE_disable_destroy() && this != Container::get_root())
120 // remove me from the allContainers data structure
121 allContainers.erase(name_);
124 void Container::create_child(const std::string& name, const std::string& type_name)
126 new Container(name, type_name, this);
129 Container* Container::by_name_or_null(const std::string& name)
131 auto cont = allContainers.find(name);
132 return cont == allContainers.end() ? nullptr : cont->second;
135 Container* Container::by_name(const std::string& name)
137 Container* ret = Container::by_name_or_null(name);
138 xbt_assert(ret != nullptr, "container with name %s not found", name.c_str());
143 void Container::remove_from_parent()
146 XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", get_cname(), father_->get_cname());
147 father_->children_.erase(name_);
152 void Container::log_creation()
154 double timestamp = SIMIX_get_clock();
155 std::stringstream stream;
157 XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_CreateContainer, timestamp);
159 if (trace_format == simgrid::instr::TraceFormat::Paje) {
160 stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_CreateContainer << " ";
161 stream << timestamp << " " << id_ << " " << type_->get_id() << " " << father_->id_ << " \"";
162 if (name_.find("rank-") != 0)
163 stream << name_ << "\"";
165 /* Subtract -1 because this is the process id and we transform it to the rank id */
166 stream << "rank-" << stoi(name_.substr(5)) - 1 << "\"";
168 XBT_DEBUG("Dump %s", stream.str().c_str());
169 tracing_file << stream.str() << std::endl;
170 } else if (trace_format == simgrid::instr::TraceFormat::Ti) {
171 // if we are in the mode with only one file
172 static std::ofstream* ti_unique_file = nullptr;
174 if (tracing_files.empty()) {
175 // generate unique run id with time
176 prefix = xbt_os_time();
179 if (not simgrid::config::get_value<bool>("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
180 std::string folder_name = TRACE_get_filename() + "_files";
181 std::string filename = folder_name + "/" + std::to_string(prefix) + "_" + name_ + ".txt";
183 _mkdir(folder_name.c_str());
185 mkdir(folder_name.c_str(), S_IRWXU | S_IRWXG | S_IRWXO);
187 ti_unique_file = new std::ofstream(filename.c_str(), std::ofstream::out);
188 xbt_assert(not ti_unique_file->fail(), "Tracefile %s could not be opened for writing", filename.c_str());
189 tracing_file << filename << std::endl;
191 tracing_files.insert({this, ti_unique_file});
197 void Container::log_destruction()
199 std::stringstream stream;
200 double timestamp = SIMIX_get_clock();
202 XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_DestroyContainer, timestamp);
204 if (trace_format == simgrid::instr::TraceFormat::Paje) {
205 stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_DestroyContainer << " ";
206 stream << timestamp << " " << type_->get_id() << " " << id_;
207 XBT_DEBUG("Dump %s", stream.str().c_str());
208 tracing_file << stream.str() << std::endl;
209 } else if (trace_format == simgrid::instr::TraceFormat::Ti) {
210 if (not simgrid::config::get_value<bool>("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
211 tracing_files.at(this)->close();
212 delete tracing_files.at(this);
214 tracing_files.erase(this);
220 StateType* Container::get_state(const std::string& name)
222 StateType* ret = static_cast<StateType*>(type_->by_name(name));
223 ret->set_calling_container(this);
227 LinkType* Container::get_link(const std::string& name)
229 LinkType* ret = static_cast<LinkType*>(type_->by_name(name));
230 ret->set_calling_container(this);
234 VariableType* Container::get_variable(const std::string& name)
236 VariableType* ret = static_cast<VariableType*>(type_->by_name(name));
237 ret->set_calling_container(this);