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 "src/instr/instr_private.hpp"
9 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_types, instr, "Paje tracing event system (types)");
11 extern std::ofstream tracing_file;
12 // to check if variables were previously set to 0, otherwise paje won't simulate them
13 static std::set<std::string> platform_variables;
18 Type::Type(std::string name, std::string alias, std::string color, Type* father)
19 : id_(instr_new_paje_id()), name_(std::move(name)), color_(std::move(color)), father_(father)
21 if (name_.empty() || alias.empty())
22 THROWF(tracing_error, 0, "can't create a new type with no name or alias");
24 if (father != nullptr){
25 father->children_.insert({std::move(alias), this});
26 XBT_DEBUG("new type %s, child of %s", get_cname(), father->get_cname());
28 if (trace_format == simgrid::instr::TraceFormat::Paje) {
29 stream_ << std::fixed << std::setprecision(TRACE_precision());
35 for (auto elm : children_)
39 ValueType::~ValueType()
41 for (auto elm : values_)
45 ContainerType::ContainerType(const std::string& name, Type* father) : Type(name, name, "", father)
47 XBT_DEBUG("ContainerType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
48 log_definition(PAJE_DefineContainerType);
51 EventType::EventType(std::string name, Type* father) : ValueType(std::move(name), father)
53 XBT_DEBUG("EventType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
54 log_definition(PAJE_DefineEventType);
57 StateType::StateType(std::string name, Type* father) : ValueType(std::move(name), father)
59 XBT_DEBUG("StateType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
60 log_definition(PAJE_DefineStateType);
63 StateType::~StateType()
68 void StateType::set_event(const std::string& value_name)
70 events_.push_back(new StateEvent(issuer_, this, PAJE_SetState, get_entity_value(value_name), nullptr));
73 void StateType::push_event(const std::string& value_name, TIData* extra)
75 events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), extra));
78 void StateType::push_event(const std::string& value_name)
80 events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), nullptr));
83 void StateType::pop_event()
88 void StateType::pop_event(TIData* extra)
90 events_.push_back(new StateEvent(issuer_, this, PAJE_PopState, nullptr, extra));
93 VariableType::VariableType(const std::string& name, std::string color, Type* father)
94 : Type(name, name, std::move(color), father)
96 XBT_DEBUG("VariableType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
97 log_definition(PAJE_DefineVariableType);
100 VariableType::~VariableType()
105 void VariableType::instr_event(double now, double delta, const char* resource, double value)
107 /* To trace resource utilization, we use AddEvent and SubEvent only. This implies to add a SetEvent first to set the
108 * initial value of all variables for subsequent adds/subs. If we don't do so, the first AddEvent would be added to a
109 * non-determined value, hence causing analysis problems.
112 // create a key considering the resource and variable
113 std::string key = std::string(resource) + get_name();
115 // check if key exists: if it doesn't, set the variable to zero and mark this in the global map.
116 if (platform_variables.find(key) == platform_variables.end()) {
118 platform_variables.insert(key);
121 add_event(now, value);
122 sub_event(now + delta, value);
125 void VariableType::set_event(double timestamp, double value)
127 events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SetVariable, value));
130 void VariableType::add_event(double timestamp, double value)
132 events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_AddVariable, value));
135 void VariableType::sub_event(double timestamp, double value)
137 events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SubVariable, value));
140 LinkType::LinkType(std::string name, std::string alias, Type* father)
141 : ValueType(std::move(name), std::move(alias), father)
144 void LinkType::start_event(Container* startContainer, std::string value, std::string key)
146 start_event(startContainer, value, std::move(key), -1);
149 void LinkType::start_event(Container* startContainer, std::string value, std::string key, int size)
151 new LinkEvent(issuer_, this, PAJE_StartLink, startContainer, value, std::move(key), size);
154 void LinkType::end_event(Container* endContainer, std::string value, std::string key)
156 new LinkEvent(issuer_, this, PAJE_EndLink, endContainer, value, std::move(key), -1);
159 void Type::log_definition(e_event_type event_type)
161 if (trace_format != simgrid::instr::TraceFormat::Paje)
163 XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, event_type, TRACE_precision(), 0.);
164 stream_ << event_type << " " << get_id() << " " << father_->get_id() << " " << get_name();
166 stream_ << " \"" << color_ << "\"";
167 XBT_DEBUG("Dump %s", stream_.str().c_str());
168 tracing_file << stream_.str() << std::endl;
171 void Type::log_definition(simgrid::instr::Type* source, simgrid::instr::Type* dest)
173 if (trace_format != simgrid::instr::TraceFormat::Paje)
175 XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, PAJE_DefineLinkType, TRACE_precision(), 0.);
176 stream_ << PAJE_DefineLinkType << " " << get_id() << " " << father_->get_id() << " " << source->get_id();
177 stream_ << " " << dest->get_id() << " " << get_name();
178 XBT_DEBUG("Dump %s", stream_.str().c_str());
179 tracing_file << stream_.str() << std::endl;
182 Type* Type::by_name(const std::string& name)
185 for (auto elm : children_) {
186 if (elm.second->name_ == name) {
187 if (ret != nullptr) {
188 THROWF (tracing_error, 0, "there are two children types with the same name?");
195 THROWF(tracing_error, 2, "type with name (%s) not found in father type (%s)", name.c_str(), get_cname());
199 void ValueType::add_entity_value(const std::string& name)
201 add_entity_value(name, "");
204 void ValueType::add_entity_value(const std::string& name, std::string color)
207 THROWF(tracing_error, 0, "can't get a value with no name");
209 auto it = values_.find(name);
210 if (it == values_.end()) {
211 EntityValue* new_val = new EntityValue(name, std::move(color), this);
212 values_.insert({name, new_val});
213 XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
218 EntityValue* ValueType::get_entity_value(const std::string& name)
220 auto ret = values_.find(name);
221 if (ret == values_.end()) {
222 THROWF(tracing_error, 2, "value with name (%s) not found in father type (%s)", name.c_str(), get_cname());
227 VariableType* Type::by_name_or_create(const std::string& name, std::string color)
229 auto cont = children_.find(name);
230 std::string mycolor = color.empty() ? "1 1 1" : std::move(color);
231 return cont == children_.end() ? new VariableType(name, std::move(mycolor), this)
232 : static_cast<VariableType*>(cont->second);
235 LinkType* Type::by_name_or_create(const std::string& name, Type* source, Type* dest)
237 std::string alias = name + "-" + std::to_string(source->id_) + "-" + std::to_string(dest->id_);
238 auto it = children_.find(alias);
239 if (it == children_.end()) {
240 LinkType* ret = new LinkType(name, alias, this);
241 XBT_DEBUG("LinkType %s(%lld), child of %s(%lld) %s(%lld)->%s(%lld)", ret->get_cname(), ret->get_id(), get_cname(),
242 get_id(), source->get_cname(), source->get_id(), dest->get_cname(), dest->get_id());
243 ret->log_definition(source, dest);
246 return static_cast<LinkType*>(it->second);