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* getOrCreateContainerType(std::string name);
83 Type* getOrCreateEventType(std::string name);
84 Type* getOrCreateLinkType(std::string name, Type* source, Type* dest);
85 Type* getOrCreateStateType(std::string name);
86 Type* getOrCreateVariableType(std::string name, std::string color);
88 void logContainerTypeDefinition();
89 void logVariableTypeDefinition();
90 void logStateTypeDefinition();
91 void logLinkTypeDefinition(simgrid::instr::Type* source, simgrid::instr::Type* dest);
92 void logDefineEventType();
94 static Type* createRootType();
95 static Type* getRootType();
98 //--------------------------------------------------
105 explicit Value(std::string name, std::string color, Type* father);
109 static Value* byNameOrCreate(std::string name, std::string color, Type* father);
110 static Value* byName(std::string name, Type* father);
111 const char* getCname() { return name_.c_str(); }
112 const char* getId() { return id_.c_str(); }
113 bool isColored() { return not color_.empty(); }
117 //--------------------------------------------------
118 enum e_container_types {
130 e_container_types kind_; /* This container is of what kind */
131 std::string name_; /* Unique name of this container */
132 int level_ = 0; /* Level in the hierarchy, root level is 0 */
133 sg_netpoint_t netpoint_ = nullptr;
136 Container(std::string name, simgrid::instr::e_container_types kind, Container* father);
137 virtual ~Container();
139 std::string id_; /* Unique id of this container */
140 Type* type_; /* Type of this container */
142 std::map<std::string, Container*> children_;
143 static Container* byNameOrNull(std::string name);
144 static Container* byName(std::string name);
145 std::string getName() { return name_; }
146 const char* getCname() { return name_.c_str(); }
147 void removeFromParent();
149 void logDestruction();
152 //--------------------------------------------------
155 Container* container;
160 e_event_type eventType_;
161 PajeEvent(Container* container, Type* type, double timestamp, e_event_type eventType)
162 : container(container), type(type), timestamp_(timestamp), eventType_(eventType){};
163 virtual void print() = 0;
164 virtual ~PajeEvent();
165 void insertIntoBuffer();
168 //--------------------------------------------------
169 class SetVariableEvent : public PajeEvent {
173 SetVariableEvent(double timestamp, Container* container, Type* type, double value);
174 void print() override;
177 class AddVariableEvent : public PajeEvent {
181 AddVariableEvent(double timestamp, Container* container, Type* type, double value);
182 void print() override;
184 //--------------------------------------------------
186 class SubVariableEvent : public PajeEvent {
190 SubVariableEvent(double timestamp, Container* container, Type* type, double value);
191 void print() override;
193 //--------------------------------------------------
195 class SetStateEvent : public PajeEvent {
197 const char* filename;
201 SetStateEvent(double timestamp, Container* container, Type* type, Value* val);
202 void print() override;
205 class PushStateEvent : public PajeEvent {
207 const char* filename;
212 PushStateEvent(double timestamp, Container* container, Type* type, Value* val);
213 PushStateEvent(double timestamp, Container* container, Type* type, Value* val, void* extra);
214 void print() override;
217 class PopStateEvent : public PajeEvent {
219 PopStateEvent(double timestamp, Container* container, Type* type);
220 void print() override;
223 class ResetStateEvent : public PajeEvent {
225 ResetStateEvent(double timestamp, Container* container, Type* type);
226 void print() override;
229 class StartLinkEvent : public PajeEvent {
230 Container* sourceContainer_;
236 StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
238 StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
239 std::string key, int size);
240 void print() override;
243 class EndLinkEvent : public PajeEvent {
244 Container* destContainer;
249 EndLinkEvent(double timestamp, Container* container, Type* type, Container* destContainer, std::string value,
251 ~EndLinkEvent() = default;
252 void print() override;
255 class NewEvent : public PajeEvent {
259 NewEvent(double timestamp, Container* container, Type* type, Value* val);
260 void print() override;
263 } // namespace simgrid::instr
264 typedef simgrid::instr::Container* container_t;
268 extern XBT_PRIVATE std::set<std::string> created_categories;
269 extern XBT_PRIVATE std::set<std::string> declared_marks;
270 extern XBT_PRIVATE std::set<std::string> user_host_variables;
271 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
272 extern XBT_PRIVATE std::set<std::string> user_link_variables;
273 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
275 /* instr_paje_header.c */
276 XBT_PRIVATE void TRACE_header(bool basic, int size);
279 XBT_PRIVATE void TRACE_paje_start();
280 XBT_PRIVATE void TRACE_paje_end();
282 /* from instr_config.c */
283 XBT_PRIVATE bool TRACE_needs_platform();
284 XBT_PRIVATE bool TRACE_is_enabled();
285 XBT_PRIVATE bool TRACE_platform();
286 XBT_PRIVATE bool TRACE_platform_topology();
287 XBT_PRIVATE bool TRACE_is_configured();
288 XBT_PRIVATE bool TRACE_categorized();
289 XBT_PRIVATE bool TRACE_uncategorized();
290 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
291 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
292 XBT_PRIVATE bool TRACE_buffer();
293 XBT_PRIVATE bool TRACE_disable_link();
294 XBT_PRIVATE bool TRACE_disable_speed();
295 XBT_PRIVATE bool TRACE_onelink_only();
296 XBT_PRIVATE bool TRACE_disable_destroy();
297 XBT_PRIVATE bool TRACE_basic();
298 XBT_PRIVATE bool TRACE_display_sizes();
299 XBT_PRIVATE char* TRACE_get_comment();
300 XBT_PRIVATE char* TRACE_get_comment_file();
301 XBT_PRIVATE int TRACE_precision();
302 XBT_PRIVATE char* TRACE_get_filename();
303 XBT_PRIVATE char* TRACE_get_viva_uncat_conf();
304 XBT_PRIVATE char* TRACE_get_viva_cat_conf();
305 XBT_PRIVATE void TRACE_generate_viva_uncat_conf();
306 XBT_PRIVATE void TRACE_generate_viva_cat_conf();
307 XBT_PRIVATE void instr_pause_tracing();
308 XBT_PRIVATE void instr_resume_tracing();
310 /* Public functions used in SMPI */
311 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
312 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
313 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
314 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
315 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
317 /* from resource_utilization.c */
318 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char* resource, const char* category, double value, double now,
320 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char* resource, const char* category, double value, double now,
322 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
325 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
326 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
327 XBT_PRIVATE long long int instr_new_paje_id();
328 XBT_PUBLIC(container_t) PJ_container_get_root ();
329 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
330 void instr_new_variable_type(std::string new_typename, const char* color);
331 void instr_new_user_variable_type(std::string father_type, std::string new_typename, const char* color);
332 void instr_new_user_state_type(std::string father_type, std::string new_typename);
333 void instr_new_value_for_user_state_type(std::string new_typename, const char* value, const char* color);
336 XBT_PRIVATE void TRACE_TI_start();
337 XBT_PRIVATE void TRACE_TI_end();
339 XBT_PRIVATE void TRACE_paje_dump_buffer(bool force);
340 XBT_PRIVATE void dump_comment_file(std::string filename);
341 XBT_PRIVATE void dump_comment(std::string comment);
372 TRACING_REDUCE_SCATTER,
379 struct s_instr_extra_data_t {
384 double sleep_duration;
388 const char* datatype1;
389 const char* datatype2;
394 typedef s_instr_extra_data_t* instr_extra_data;
396 /* Format of TRACING output.
397 * - paje is the regular format, that we all know
398 * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
399 * trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
400 * using the signal that we will create to cleanup the TRACING
402 enum instr_fmt_type_t { instr_fmt_paje, instr_fmt_TI };
403 extern instr_fmt_type_t instr_fmt_type;