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/instr/instr_paje_containers.hpp"
15 #include "src/instr/instr_paje_types.hpp"
16 #include "src/internal_config.h"
17 #include "xbt/graph.h"
18 #include <iomanip> /** std::setprecision **/
25 #include <direct.h> // _mkdir
26 /* Need to define function drand48 for Windows */
27 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
28 #define drand48() (rand() / (RAND_MAX + 1.0))
43 enum e_event_type : unsigned int {
44 PAJE_DefineContainerType,
45 PAJE_DefineVariableType,
49 PAJE_DefineEntityValue,
51 PAJE_DestroyContainer,
71 explicit EntityValue(std::string name, std::string color, Type* father);
72 ~EntityValue() = default;
73 const char* getCname() { return name_.c_str(); }
74 long long int getId() { return id_; }
85 e_event_type eventType_;
86 PajeEvent(Container* container, Type* type, double timestamp, e_event_type eventType)
87 : container(container), type(type), timestamp_(timestamp), eventType_(eventType){};
88 virtual void print() = 0;
90 void insertIntoBuffer();
93 class SetVariableEvent : public PajeEvent {
97 SetVariableEvent(double timestamp, Container* container, Type* type, double value);
98 void print() override;
101 class AddVariableEvent : public PajeEvent {
105 AddVariableEvent(double timestamp, Container* container, Type* type, double value);
106 void print() override;
109 class SubVariableEvent : public PajeEvent {
113 SubVariableEvent(double timestamp, Container* container, Type* type, double value);
114 void print() override;
117 class SetStateEvent : public PajeEvent {
119 const char* filename;
123 SetStateEvent(double timestamp, Container* container, Type* type, EntityValue* val);
124 void print() override;
127 class PushStateEvent : public PajeEvent {
129 const char* filename;
134 PushStateEvent(double timestamp, Container* container, Type* type, EntityValue* val);
135 PushStateEvent(double timestamp, Container* container, Type* type, EntityValue* val, void* extra);
136 void print() override;
139 class PopStateEvent : public PajeEvent {
141 PopStateEvent(double timestamp, Container* container, Type* type);
142 void print() override;
145 class ResetStateEvent : public PajeEvent {
147 ResetStateEvent(double timestamp, Container* container, Type* type);
148 void print() override;
151 class StartLinkEvent : public PajeEvent {
152 Container* sourceContainer_;
158 StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
160 StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
161 std::string key, int size);
162 void print() override;
165 class EndLinkEvent : public PajeEvent {
166 Container* destContainer;
171 EndLinkEvent(double timestamp, Container* container, Type* type, Container* destContainer, std::string value,
173 ~EndLinkEvent() = default;
174 void print() override;
177 class NewEvent : public PajeEvent {
181 NewEvent(double timestamp, Container* container, Type* type, EntityValue* val);
182 void print() override;
185 } // namespace simgrid::instr
186 typedef simgrid::instr::Container* container_t;
190 extern XBT_PRIVATE std::set<std::string> created_categories;
191 extern XBT_PRIVATE std::set<std::string> declared_marks;
192 extern XBT_PRIVATE std::set<std::string> user_host_variables;
193 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
194 extern XBT_PRIVATE std::set<std::string> user_link_variables;
195 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
197 /* instr_paje_header.c */
198 XBT_PRIVATE void TRACE_header(bool basic, int size);
201 XBT_PRIVATE void TRACE_paje_start();
202 XBT_PRIVATE void TRACE_paje_end();
204 /* from instr_config.c */
205 XBT_PRIVATE bool TRACE_needs_platform();
206 XBT_PRIVATE bool TRACE_is_enabled();
207 XBT_PRIVATE bool TRACE_platform();
208 XBT_PRIVATE bool TRACE_platform_topology();
209 XBT_PRIVATE bool TRACE_is_configured();
210 XBT_PRIVATE bool TRACE_categorized();
211 XBT_PRIVATE bool TRACE_uncategorized();
212 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
213 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
214 XBT_PRIVATE bool TRACE_buffer();
215 XBT_PRIVATE bool TRACE_disable_link();
216 XBT_PRIVATE bool TRACE_disable_speed();
217 XBT_PRIVATE bool TRACE_onelink_only();
218 XBT_PRIVATE bool TRACE_disable_destroy();
219 XBT_PRIVATE bool TRACE_basic();
220 XBT_PRIVATE bool TRACE_display_sizes();
221 XBT_PRIVATE char* TRACE_get_comment();
222 XBT_PRIVATE char* TRACE_get_comment_file();
223 XBT_PRIVATE int TRACE_precision();
224 XBT_PRIVATE char* TRACE_get_filename();
225 XBT_PRIVATE char* TRACE_get_viva_uncat_conf();
226 XBT_PRIVATE char* TRACE_get_viva_cat_conf();
227 XBT_PRIVATE void TRACE_generate_viva_uncat_conf();
228 XBT_PRIVATE void TRACE_generate_viva_cat_conf();
229 XBT_PRIVATE void instr_pause_tracing();
230 XBT_PRIVATE void instr_resume_tracing();
232 /* Public functions used in SMPI */
233 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
234 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
235 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
236 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
237 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
239 /* from resource_utilization.c */
240 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char* resource, const char* category, double value, double now,
242 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char* resource, const char* category, double value, double now,
244 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
247 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
248 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
249 XBT_PRIVATE long long int instr_new_paje_id();
250 void instr_new_variable_type(std::string new_typename, std::string color);
251 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color);
252 void instr_new_user_state_type(std::string father_type, std::string new_typename);
253 void instr_new_value_for_user_state_type(std::string new_typename, const char* value, std::string color);
256 XBT_PRIVATE void TRACE_TI_start();
257 XBT_PRIVATE void TRACE_TI_end();
259 XBT_PRIVATE void TRACE_paje_dump_buffer(bool force);
260 XBT_PRIVATE void dump_comment_file(std::string filename);
261 XBT_PRIVATE void dump_comment(std::string comment);
292 TRACING_REDUCE_SCATTER,
299 struct s_instr_extra_data_t {
304 double sleep_duration;
308 const char* datatype1;
309 const char* datatype2;
314 typedef s_instr_extra_data_t* instr_extra_data;
316 /* Format of TRACING output.
317 * - paje is the regular format, that we all know
318 * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
319 * trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
320 * using the signal that we will create to cleanup the TRACING
322 enum instr_fmt_type_t { instr_fmt_paje, instr_fmt_TI };
323 extern instr_fmt_type_t instr_fmt_type;