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 std::ofstream tracing_file;
13 std::map<container_t, std::ofstream*> 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::get_root()
35 NetZoneContainer::NetZoneContainer(std::string name, unsigned int level, NetZoneContainer* father)
36 : Container::Container(name, "", father)
38 netpoint_ = simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(name);
39 xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
41 std::string type_name = std::string("L") + std::to_string(level);
42 type_ = father_->type_->by_name_or_create<ContainerType>(type_name);
43 father_->children_.insert({get_name(), this});
46 type_ = new ContainerType("0");
51 RouterContainer::RouterContainer(std::string name, Container* father) : Container::Container(name, "ROUTER", father)
53 xbt_assert(father, "Only the Root container has no father");
55 netpoint_ = simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(name);
56 xbt_assert(netpoint_, "Element '%s' not found", name.c_str());
58 trivaNodeTypes.insert(type_->get_name());
61 HostContainer::HostContainer(simgrid::s4u::Host& host, NetZoneContainer* father)
62 : Container::Container(host.get_cname(), "HOST", father)
64 xbt_assert(father, "Only the Root container has no father");
66 netpoint_ = host.pimpl_netpoint;
67 xbt_assert(netpoint_, "Element '%s' not found", host.get_cname());
69 trivaNodeTypes.insert(type_->get_name());
72 Container::Container(std::string name, std::string type_name, Container* father) : name_(name), father_(father)
74 static long long int container_id = 0;
75 id_ = container_id; // id (or alias) of the container
79 XBT_DEBUG("new container %s, child of %s", name.c_str(), father->name_.c_str());
81 if (not type_name.empty()) {
82 type_ = father_->type_->by_name_or_create<ContainerType>(type_name);
83 father_->children_.insert({name_, this});
88 //register all kinds by name
89 if (not allContainers.emplace(name_, this).second)
90 THROWF(tracing_error, 1, "container %s already present in allContainers data structure", name_.c_str());
92 XBT_DEBUG("Add container name '%s'", name_.c_str());
94 //register NODE types for triva configuration
95 if (type_name == "LINK")
96 trivaNodeTypes.insert(type_->get_name());
99 Container::~Container()
101 XBT_DEBUG("destroy container %s", name_.c_str());
102 // Begin with destroying my own children
103 for (auto child : children_)
106 // obligation to dump previous events because they might reference the container that is about to be destroyed
107 TRACE_last_timestamp_to_dump = SIMIX_get_clock();
108 TRACE_paje_dump_buffer(true);
110 // trace my destruction, but not if user requests so or if the container is root
111 if (not TRACE_disable_destroy() && this != Container::get_root())
114 // remove me from the allContainers data structure
115 allContainers.erase(name_);
118 void Container::create_child(std::string name, std::string type_name)
120 new Container(name, type_name, this);
123 Container* Container::by_name_or_null(std::string name)
125 auto cont = allContainers.find(name);
126 return cont == allContainers.end() ? nullptr : cont->second;
129 Container* Container::by_name(std::string name)
131 Container* ret = Container::by_name_or_null(name);
133 THROWF(tracing_error, 1, "container with name %s not found", name.c_str());
138 void Container::remove_from_parent()
141 XBT_DEBUG("removeChildContainer (%s) FromContainer (%s) ", get_cname(), father_->get_cname());
142 father_->children_.erase(name_);
147 void Container::log_creation()
149 double timestamp = SIMIX_get_clock();
150 std::stringstream stream;
152 XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_CreateContainer, timestamp);
154 if (trace_format == simgrid::instr::TraceFormat::Paje) {
155 stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_CreateContainer << " ";
156 stream << timestamp << " " << id_ << " " << type_->get_id() << " " << father_->id_ << " \"" << name_ << "\"";
157 XBT_DEBUG("Dump %s", stream.str().c_str());
158 tracing_file << stream.str() << std::endl;
159 } else if (trace_format == simgrid::instr::TraceFormat::Ti) {
160 // if we are in the mode with only one file
161 static std::ofstream* ti_unique_file = nullptr;
163 if (tracing_files.empty()) {
164 // generate unique run id with time
165 prefix = xbt_os_time();
168 if (not simgrid::config::get_value<bool>("tracing/smpi/format/ti-one-file") || ti_unique_file == nullptr) {
169 std::string folder_name = TRACE_get_filename() + "_files";
170 std::string filename = folder_name + "/" + std::to_string(prefix) + "_" + name_ + ".txt";
172 _mkdir(folder_name.c_str());
174 mkdir(folder_name.c_str(), S_IRWXU | S_IRWXG | S_IRWXO);
176 ti_unique_file = new std::ofstream(filename.c_str(), std::ofstream::out);
177 xbt_assert(not ti_unique_file->fail(), "Tracefile %s could not be opened for writing", filename.c_str());
178 tracing_file << filename << std::endl;
180 tracing_files.insert({this, ti_unique_file});
186 void Container::log_destruction()
188 std::stringstream stream;
189 double timestamp = SIMIX_get_clock();
191 XBT_DEBUG("%s: event_type=%u, timestamp=%f", __func__, PAJE_DestroyContainer, timestamp);
193 if (trace_format == simgrid::instr::TraceFormat::Paje) {
194 stream << std::fixed << std::setprecision(TRACE_precision()) << PAJE_DestroyContainer << " ";
195 stream << timestamp << " " << type_->get_id() << " " << id_;
196 XBT_DEBUG("Dump %s", stream.str().c_str());
197 tracing_file << stream.str() << std::endl;
198 } else if (trace_format == simgrid::instr::TraceFormat::Ti) {
199 if (not simgrid::config::get_value<bool>("tracing/smpi/format/ti-one-file") || tracing_files.size() == 1) {
200 tracing_files.at(this)->close();
201 delete tracing_files.at(this);
203 tracing_files.erase(this);
209 StateType* Container::get_state(std::string name)
211 StateType* ret = dynamic_cast<StateType*>(type_->by_name(name));
212 ret->set_calling_container(this);
216 LinkType* Container::get_link(std::string name)
218 LinkType* ret = dynamic_cast<LinkType*>(type_->by_name(name));
219 ret->set_calling_container(this);
223 VariableType* Container::get_variable(std::string name)
225 VariableType* ret = dynamic_cast<VariableType*>(type_->by_name(name));
226 ret->set_calling_container(this);