1 /* Copyright (c) 2012-2019. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "simgrid/Exception.hpp"
8 #include "src/instr/instr_private.hpp"
10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_types, instr, "Paje tracing event system (types)");
12 extern std::ofstream tracing_file;
13 // to check if variables were previously set to 0, otherwise paje won't simulate them
14 static std::set<std::string> platform_variables;
19 Type::Type(const std::string& name, const std::string& alias, const std::string& color, Type* father)
20 : id_(instr_new_paje_id()), name_(name), color_(color), father_(father)
22 if (name_.empty() || alias.empty())
23 throw simgrid::TracingError(XBT_THROW_POINT, "can't create a new type with no name or alias");
25 if (father != nullptr){
26 father->children_[alias].reset(this);
27 XBT_DEBUG("new type %s, child of %s", get_cname(), father->get_cname());
29 if (trace_format == simgrid::instr::TraceFormat::Paje) {
30 stream_ << std::fixed << std::setprecision(TRACE_precision());
34 ContainerType::ContainerType(const std::string& name, Type* father) : Type(name, name, "", father)
36 XBT_DEBUG("ContainerType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
37 log_definition(PAJE_DefineContainerType);
40 EventType::EventType(const std::string& name, Type* father) : ValueType(name, father)
42 XBT_DEBUG("EventType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
43 log_definition(PAJE_DefineEventType);
46 StateType::StateType(const std::string& name, Type* father) : ValueType(name, father)
48 XBT_DEBUG("StateType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
49 log_definition(PAJE_DefineStateType);
52 void StateType::set_event(const std::string& value_name)
54 events_.push_back(new StateEvent(issuer_, this, PAJE_SetState, get_entity_value(value_name), nullptr));
57 void StateType::push_event(const std::string& value_name, TIData* extra)
59 events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), extra));
62 void StateType::push_event(const std::string& value_name)
64 events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), nullptr));
67 void StateType::pop_event()
72 void StateType::pop_event(TIData* extra)
74 events_.push_back(new StateEvent(issuer_, this, PAJE_PopState, nullptr, extra));
77 VariableType::VariableType(const std::string& name, const std::string& color, Type* father)
78 : Type(name, name, color, father)
80 XBT_DEBUG("VariableType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
81 log_definition(PAJE_DefineVariableType);
84 void VariableType::instr_event(double now, double delta, const char* resource, double value)
86 /* To trace resource utilization, we use AddEvent and SubEvent only. This implies to add a SetEvent first to set the
87 * initial value of all variables for subsequent adds/subs. If we don't do so, the first AddEvent would be added to a
88 * non-determined value, hence causing analysis problems.
91 // create a key considering the resource and variable
92 std::string key = std::string(resource) + get_name();
94 // check if key exists: if it doesn't, set the variable to zero and mark this in the global map.
95 if (platform_variables.find(key) == platform_variables.end()) {
97 platform_variables.insert(key);
100 add_event(now, value);
101 sub_event(now + delta, value);
104 void VariableType::set_event(double timestamp, double value)
106 events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SetVariable, value));
109 void VariableType::add_event(double timestamp, double value)
111 events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_AddVariable, value));
114 void VariableType::sub_event(double timestamp, double value)
116 events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SubVariable, value));
119 LinkType::LinkType(const std::string& name, const std::string& alias, Type* father) : ValueType(name, alias, father)
122 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key)
124 start_event(startContainer, value, key, -1);
127 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key, int size)
129 new LinkEvent(issuer_, this, PAJE_StartLink, startContainer, value, key, size);
132 void LinkType::end_event(Container* endContainer, const std::string& value, const std::string& key)
134 new LinkEvent(issuer_, this, PAJE_EndLink, endContainer, value, key, -1);
137 void Type::log_definition(e_event_type event_type)
139 if (trace_format != simgrid::instr::TraceFormat::Paje)
141 XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, event_type, TRACE_precision(), 0.);
142 stream_ << event_type << " " << get_id() << " " << father_->get_id() << " " << get_name();
144 stream_ << " \"" << color_ << "\"";
145 XBT_DEBUG("Dump %s", stream_.str().c_str());
146 tracing_file << stream_.str() << std::endl;
149 void Type::log_definition(simgrid::instr::Type* source, simgrid::instr::Type* dest)
151 if (trace_format != simgrid::instr::TraceFormat::Paje)
153 XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, PAJE_DefineLinkType, TRACE_precision(), 0.);
154 stream_ << PAJE_DefineLinkType << " " << get_id() << " " << father_->get_id() << " " << source->get_id();
155 stream_ << " " << dest->get_id() << " " << get_name();
156 XBT_DEBUG("Dump %s", stream_.str().c_str());
157 tracing_file << stream_.str() << std::endl;
160 Type* Type::by_name(const std::string& name)
163 for (auto const& elm : children_) {
164 if (elm.second->name_ == name) {
165 if (ret != nullptr) {
166 throw simgrid::TracingError(XBT_THROW_POINT, "there are two children types with the same name?");
168 ret = elm.second.get();
173 throw simgrid::TracingError(
175 simgrid::xbt::string_printf("type with name (%s) not found in father type (%s)", name.c_str(), get_cname()));
179 void ValueType::add_entity_value(const std::string& name)
181 add_entity_value(name, "");
184 void ValueType::add_entity_value(const std::string& name, const std::string& color)
187 throw simgrid::TracingError(XBT_THROW_POINT, "can't get a value with no name");
189 auto it = values_.find(name);
190 if (it == values_.end()) {
191 auto res = values_.emplace(name, EntityValue(name, color, this));
192 XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
193 res.first->second.print();
197 EntityValue* ValueType::get_entity_value(const std::string& name)
199 auto ret = values_.find(name);
200 if (ret == values_.end()) {
201 throw simgrid::TracingError(
203 simgrid::xbt::string_printf("value with name (%s) not found in father type (%s)", name.c_str(), get_cname()));
208 VariableType* Type::by_name_or_create(const std::string& name, const std::string& color)
210 auto cont = children_.find(name);
211 std::string mycolor = color.empty() ? "1 1 1" : color;
212 return cont == children_.end() ? new VariableType(name, mycolor, this)
213 : static_cast<VariableType*>(cont->second.get());
216 LinkType* Type::by_name_or_create(const std::string& name, Type* source, Type* dest)
218 std::string alias = name + "-" + std::to_string(source->id_) + "-" + std::to_string(dest->id_);
219 auto it = children_.find(alias);
220 if (it == children_.end()) {
221 LinkType* ret = new LinkType(name, alias, this);
222 XBT_DEBUG("LinkType %s(%lld), child of %s(%lld) %s(%lld)->%s(%lld)", ret->get_cname(), ret->get_id(), get_cname(),
223 get_id(), source->get_cname(), source->get_id(), dest->get_cname(), dest->get_id());
224 ret->log_definition(source, dest);
227 return static_cast<LinkType*>(it->second.get());