1 /* Copyright (c) 2010-2017. 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 #ifndef INSTR_PRIVATE_HPP
7 #define INSTR_PRIVATE_HPP
11 #include "instr/instr_interface.h"
12 #include "simgrid/instr.h"
13 #include "simgrid_config.h"
14 #include "src/internal_config.h"
15 #include "xbt/graph.h"
16 #include <iomanip> /** std::setprecision **/
23 #include <direct.h> // _mkdir
24 /* Need to define function drand48 for Windows */
25 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
26 #define drand48() (rand() / (RAND_MAX + 1.0))
29 #define INSTR_DEFAULT_STR_SIZE 500
37 PAJE_DefineContainerType,
38 PAJE_DefineVariableType,
42 PAJE_DefineEntityValue,
44 PAJE_DestroyContainer,
57 //--------------------------------------------------
58 enum e_entity_types { TYPE_VARIABLE, TYPE_LINK, TYPE_CONTAINER, TYPE_STATE, TYPE_EVENT };
68 std::map<std::string, Type*> children_;
69 std::map<std::string, Value*> values_; // valid for all types except variable and container
71 Type(std::string name, std::string alias, std::string color, e_entity_types kind, Type* father);
74 std::string getName() { return name_; }
75 const char* getCname() { return name_.c_str(); }
76 const char* getId() { return id_.c_str(); }
77 e_entity_types getKind() { return kind_; }
78 bool isColored() { return not color_.empty(); }
80 Type* byName(std::string name);
82 Type* addEventType(std::string name);
83 Type* addLinkType(std::string name, Type* source, Type* dest);
84 Type* addStateType(std::string name);
85 Type* addVariableType(std::string name, std::string color);
87 void logContainerTypeDefinition();
88 void logVariableTypeDefinition();
89 void logStateTypeDefinition();
90 void logLinkTypeDefinition(simgrid::instr::Type* source, simgrid::instr::Type* dest);
91 void logDefineEventType();
93 Type* getChildOrNull(std::string name);
94 static Type* containerNew(const char* name, Type* father);
97 //--------------------------------------------------
103 explicit Value(std::string name, std::string color, Type* father);
108 static Value* byNameOrCreate(std::string name, std::string color, Type* father);
109 static Value* byName(std::string name, Type* father);
110 const char* getCname() { return name_.c_str(); }
111 const char* getId() { return id_.c_str(); }
112 bool isColored() { return not color_.empty(); }
116 //--------------------------------------------------
117 enum e_container_types {
129 e_container_types kind_; /* This container is of what kind */
130 int level_ = 0; /* Level in the hierarchy, root level is 0 */
133 Container(std::string name, simgrid::instr::e_container_types kind, Container* father);
134 virtual ~Container();
136 sg_netpoint_t netpoint_ = nullptr;
137 std::string name_; /* Unique name of this container */
138 std::string id_; /* Unique id of this container */
139 Type* type_; /* Type of this container */
141 std::map<std::string, Container*> children_;
142 static Container* byNameOrNull(std::string name);
143 static Container* byName(std::string name);
144 void removeFromParent();
146 void logDestruction();
149 //--------------------------------------------------
152 Container* container;
157 e_event_type eventType_;
158 PajeEvent(Container* container, Type* type, double timestamp, e_event_type eventType)
159 : container(container), type(type), timestamp_(timestamp), eventType_(eventType){};
160 virtual void print() = 0;
161 virtual ~PajeEvent();
162 void insertIntoBuffer();
165 //--------------------------------------------------
166 class SetVariableEvent : public PajeEvent {
170 SetVariableEvent(double timestamp, Container* container, Type* type, double value);
171 void print() override;
174 class AddVariableEvent : public PajeEvent {
178 AddVariableEvent(double timestamp, Container* container, Type* type, double value);
179 void print() override;
181 //--------------------------------------------------
183 class SubVariableEvent : public PajeEvent {
187 SubVariableEvent(double timestamp, Container* container, Type* type, double value);
188 void print() override;
190 //--------------------------------------------------
192 class SetStateEvent : public PajeEvent {
194 const char* filename;
198 SetStateEvent(double timestamp, Container* container, Type* type, Value* val);
199 void print() override;
202 class PushStateEvent : public PajeEvent {
204 const char* filename;
209 PushStateEvent(double timestamp, Container* container, Type* type, Value* val);
210 PushStateEvent(double timestamp, Container* container, Type* type, Value* val, void* extra);
211 void print() override;
214 class PopStateEvent : public PajeEvent {
216 PopStateEvent(double timestamp, Container* container, Type* type);
217 void print() override;
220 class ResetStateEvent : public PajeEvent {
222 ResetStateEvent(double timestamp, Container* container, Type* type);
223 void print() override;
226 class StartLinkEvent : public PajeEvent {
227 Container* sourceContainer_;
233 StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
235 StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
236 std::string key, int size);
237 void print() override;
240 class EndLinkEvent : public PajeEvent {
241 Container* destContainer;
246 EndLinkEvent(double timestamp, Container* container, Type* type, Container* destContainer, std::string value,
248 ~EndLinkEvent() = default;
249 void print() override;
252 class NewEvent : public PajeEvent {
256 NewEvent(double timestamp, Container* container, Type* type, Value* val);
257 void print() override;
260 } // namespace simgrid::instr
261 typedef simgrid::instr::Container* container_t;
265 extern XBT_PRIVATE std::set<std::string> created_categories;
266 extern XBT_PRIVATE std::set<std::string> declared_marks;
267 extern XBT_PRIVATE std::set<std::string> user_host_variables;
268 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
269 extern XBT_PRIVATE std::set<std::string> user_link_variables;
270 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
272 /* instr_paje_header.c */
273 XBT_PRIVATE void TRACE_header(bool basic, int size);
276 XBT_PRIVATE void TRACE_paje_start();
277 XBT_PRIVATE void TRACE_paje_end();
279 /* from instr_config.c */
280 XBT_PRIVATE bool TRACE_needs_platform();
281 XBT_PRIVATE bool TRACE_is_enabled();
282 XBT_PRIVATE bool TRACE_platform();
283 XBT_PRIVATE bool TRACE_platform_topology();
284 XBT_PRIVATE bool TRACE_is_configured();
285 XBT_PRIVATE bool TRACE_categorized();
286 XBT_PRIVATE bool TRACE_uncategorized();
287 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
288 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
289 XBT_PRIVATE bool TRACE_buffer();
290 XBT_PRIVATE bool TRACE_disable_link();
291 XBT_PRIVATE bool TRACE_disable_speed();
292 XBT_PRIVATE bool TRACE_onelink_only();
293 XBT_PRIVATE bool TRACE_disable_destroy();
294 XBT_PRIVATE bool TRACE_basic();
295 XBT_PRIVATE bool TRACE_display_sizes();
296 XBT_PRIVATE char* TRACE_get_comment();
297 XBT_PRIVATE char* TRACE_get_comment_file();
298 XBT_PRIVATE int TRACE_precision();
299 XBT_PRIVATE char* TRACE_get_filename();
300 XBT_PRIVATE char* TRACE_get_viva_uncat_conf();
301 XBT_PRIVATE char* TRACE_get_viva_cat_conf();
302 XBT_PRIVATE void TRACE_generate_viva_uncat_conf();
303 XBT_PRIVATE void TRACE_generate_viva_cat_conf();
304 XBT_PRIVATE void instr_pause_tracing();
305 XBT_PRIVATE void instr_resume_tracing();
307 /* Public functions used in SMPI */
308 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
309 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
310 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
311 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
312 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
314 /* from resource_utilization.c */
315 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char* resource, const char* category, double value, double now,
317 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char* resource, const char* category, double value, double now,
319 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
322 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
323 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
324 XBT_PRIVATE long long int instr_new_paje_id();
325 XBT_PUBLIC(container_t) PJ_container_get_root ();
326 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
328 /* instr_paje_types.c */
329 XBT_PUBLIC(simgrid::instr::Type*) PJ_type_get_root();
332 XBT_PRIVATE void TRACE_TI_start();
333 XBT_PRIVATE void TRACE_TI_end();
335 XBT_PRIVATE void TRACE_paje_dump_buffer(bool force);
336 XBT_PRIVATE void dump_comment_file(const char* filename);
337 XBT_PRIVATE void dump_comment(const char* comment);
368 TRACING_REDUCE_SCATTER,
375 struct s_instr_extra_data_t {
380 double sleep_duration;
384 const char* datatype1;
385 const char* datatype2;
390 typedef s_instr_extra_data_t* instr_extra_data;
392 /* Format of TRACING output.
393 * - paje is the regular format, that we all know
394 * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
395 * trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
396 * using the signal that we will create to cleanup the TRACING
398 enum instr_fmt_type_t { instr_fmt_paje, instr_fmt_TI };
399 extern instr_fmt_type_t instr_fmt_type;