Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
77f7ae99dc96d707d634cbf91c9e7ea952c913c7
[simgrid.git] / src / instr / instr_paje_types.cpp
1 /* Copyright (c) 2012-2019. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "src/instr/instr_private.hpp"
8
9 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_paje_types, instr, "Paje tracing event system (types)");
10
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;
14
15 namespace simgrid {
16 namespace instr {
17
18 Type::Type(const std::string& name, const std::string& alias, const std::string& color, Type* father)
19     : id_(instr_new_paje_id()), name_(name), color_(color), father_(father)
20 {
21   if (name_.empty() || alias.empty())
22     THROWF(tracing_error, 0, "can't create a new type with no name or alias");
23
24   if (father != nullptr){
25     father->children_.insert({alias, this});
26     XBT_DEBUG("new type %s, child of %s", get_cname(), father->get_cname());
27   }
28   if (trace_format == simgrid::instr::TraceFormat::Paje) {
29     stream_ << std::fixed << std::setprecision(TRACE_precision());
30   }
31 }
32
33 Type::~Type()
34 {
35   for (auto elm : children_)
36     delete elm.second;
37 }
38
39 ContainerType::ContainerType(const std::string& name, Type* father) : Type(name, name, "", father)
40 {
41   XBT_DEBUG("ContainerType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
42   log_definition(PAJE_DefineContainerType);
43 }
44
45 EventType::EventType(const std::string& name, Type* father) : ValueType(name, father)
46 {
47   XBT_DEBUG("EventType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
48   log_definition(PAJE_DefineEventType);
49 }
50
51 StateType::StateType(const std::string& name, Type* father) : ValueType(name, father)
52 {
53   XBT_DEBUG("StateType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
54   log_definition(PAJE_DefineStateType);
55 }
56
57 void StateType::set_event(const std::string& value_name)
58 {
59   events_.push_back(new StateEvent(issuer_, this, PAJE_SetState, get_entity_value(value_name), nullptr));
60 }
61
62 void StateType::push_event(const std::string& value_name, TIData* extra)
63 {
64   events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), extra));
65 }
66
67 void StateType::push_event(const std::string& value_name)
68 {
69   events_.push_back(new StateEvent(issuer_, this, PAJE_PushState, get_entity_value(value_name), nullptr));
70 }
71
72 void StateType::pop_event()
73 {
74   pop_event(nullptr);
75 }
76
77 void StateType::pop_event(TIData* extra)
78 {
79   events_.push_back(new StateEvent(issuer_, this, PAJE_PopState, nullptr, extra));
80 }
81
82 VariableType::VariableType(const std::string& name, const std::string& color, Type* father)
83     : Type(name, name, color, father)
84 {
85   XBT_DEBUG("VariableType %s(%lld), child of %s(%lld)", get_cname(), get_id(), father->get_cname(), father->get_id());
86   log_definition(PAJE_DefineVariableType);
87 }
88
89 void VariableType::instr_event(double now, double delta, const char* resource, double value)
90 {
91   /* To trace resource utilization, we use AddEvent and SubEvent only. This implies to add a SetEvent first to set the
92    * initial value of all variables for subsequent adds/subs. If we don't do so, the first AddEvent would be added to a
93    * non-determined value, hence causing analysis problems.
94    */
95
96   // create a key considering the resource and variable
97   std::string key = std::string(resource) + get_name();
98
99   // check if key exists: if it doesn't, set the variable to zero and mark this in the global map.
100   if (platform_variables.find(key) == platform_variables.end()) {
101     set_event(now, 0);
102     platform_variables.insert(key);
103   }
104
105   add_event(now, value);
106   sub_event(now + delta, value);
107 }
108
109 void VariableType::set_event(double timestamp, double value)
110 {
111   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SetVariable, value));
112 }
113
114 void VariableType::add_event(double timestamp, double value)
115 {
116   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_AddVariable, value));
117 }
118
119 void VariableType::sub_event(double timestamp, double value)
120 {
121   events_.push_back(new VariableEvent(timestamp, issuer_, this, PAJE_SubVariable, value));
122 }
123
124 LinkType::LinkType(const std::string& name, const std::string& alias, Type* father) : ValueType(name, alias, father)
125 {
126 }
127 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key)
128 {
129   start_event(startContainer, value, key, -1);
130 }
131
132 void LinkType::start_event(Container* startContainer, const std::string& value, const std::string& key, int size)
133 {
134   new LinkEvent(issuer_, this, PAJE_StartLink, startContainer, value, key, size);
135 }
136
137 void LinkType::end_event(Container* endContainer, const std::string& value, const std::string& key)
138 {
139   new LinkEvent(issuer_, this, PAJE_EndLink, endContainer, value, key, -1);
140 }
141
142 void Type::log_definition(e_event_type event_type)
143 {
144   if (trace_format != simgrid::instr::TraceFormat::Paje)
145     return;
146   XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, event_type, TRACE_precision(), 0.);
147   stream_ << event_type << " " << get_id() << " " << father_->get_id() << " " << get_name();
148   if (is_colored())
149     stream_ << " \"" << color_ << "\"";
150   XBT_DEBUG("Dump %s", stream_.str().c_str());
151   tracing_file << stream_.str() << std::endl;
152 }
153
154 void Type::log_definition(simgrid::instr::Type* source, simgrid::instr::Type* dest)
155 {
156   if (trace_format != simgrid::instr::TraceFormat::Paje)
157     return;
158   XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __func__, PAJE_DefineLinkType, TRACE_precision(), 0.);
159   stream_ << PAJE_DefineLinkType << " " << get_id() << " " << father_->get_id() << " " << source->get_id();
160   stream_ << " " << dest->get_id() << " " << get_name();
161   XBT_DEBUG("Dump %s", stream_.str().c_str());
162   tracing_file << stream_.str() << std::endl;
163 }
164
165 Type* Type::by_name(const std::string& name)
166 {
167   Type* ret = nullptr;
168   for (auto elm : children_) {
169     if (elm.second->name_ == name) {
170       if (ret != nullptr) {
171         THROWF (tracing_error, 0, "there are two children types with the same name?");
172       } else {
173         ret = elm.second;
174       }
175     }
176   }
177   if (ret == nullptr)
178     THROWF(tracing_error, 2, "type with name (%s) not found in father type (%s)", name.c_str(), get_cname());
179   return ret;
180 }
181
182 void ValueType::add_entity_value(const std::string& name)
183 {
184   add_entity_value(name, "");
185 }
186
187 void ValueType::add_entity_value(const std::string& name, const std::string& color)
188 {
189   if (name.empty())
190     THROWF(tracing_error, 0, "can't get a value with no name");
191
192   auto it = values_.find(name);
193   if (it == values_.end()) {
194     auto res = values_.emplace(name, EntityValue(name, color, this));
195     XBT_DEBUG("new value %s, child of %s", name.c_str(), get_cname());
196     res.first->second.print();
197   }
198 }
199
200 EntityValue* ValueType::get_entity_value(const std::string& name)
201 {
202   auto ret = values_.find(name);
203   if (ret == values_.end()) {
204     THROWF(tracing_error, 2, "value with name (%s) not found in father type (%s)", name.c_str(), get_cname());
205   }
206   return &ret->second;
207 }
208
209 VariableType* Type::by_name_or_create(const std::string& name, const std::string& color)
210 {
211   auto cont = children_.find(name);
212   std::string mycolor = color.empty() ? "1 1 1" : color;
213   return cont == children_.end() ? new VariableType(name, mycolor, this) : static_cast<VariableType*>(cont->second);
214 }
215
216 LinkType* Type::by_name_or_create(const std::string& name, Type* source, Type* dest)
217 {
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);
225     return ret;
226   } else
227     return static_cast<LinkType*>(it->second);
228 }
229 }
230 }