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_H_
7 #define INSTR_PRIVATE_H_
11 #include "instr/instr_interface.h"
12 #include "simgrid/instr.h"
13 #include "simgrid_config.h"
14 #include "src/internal_config.h"
17 /* Need to define function drand48 for Windows */
18 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
20 # define drand48() (rand()/(RAND_MAX + 1.0))
23 #define INSTR_DEFAULT_STR_SIZE 500
25 #include "xbt/graph.h"
31 PAJE_DefineContainerType,
32 PAJE_DefineVariableType,
36 PAJE_DefineEntityValue,
38 PAJE_DestroyContainer,
59 //--------------------------------------------------
70 xbt_dict_t values_; // valid for all types except variable and container
71 Type(const char* typeNameBuff, const char* key, const char* color, e_entity_types kind, Type* father);
73 Type* getChild(const char* name);
74 Type* getChildOrNull(const char* name);
76 static Type* containerNew(const char* name, Type* father);
77 static Type* eventNew(const char* name, Type* father);
78 static Type* variableNew(const char* name, const char* color, Type* father);
79 static Type* linkNew(const char* name, Type* father, Type* source, Type* dest);
80 static Type* stateNew(const char* name, Type* father);
83 //--------------------------------------------------
91 Value(const char* name, const char* color, Type* father);
93 static Value* get_or_new(const char* name, const char* color, Type* father);
94 static Value* get(const char* name, Type* father);
98 //--------------------------------------------------
110 //--------------------------------------------------
114 Container(const char* name, simgrid::instr::e_container_types kind, Container* father);
115 virtual ~Container();
117 sg_netpoint_t netpoint_;
118 char* name_; /* Unique name of this container */
119 char* id_; /* Unique id of this container */
120 Type* type_; /* Type of this container */
121 int level_ = 0; /* Level in the hierarchy, root level is 0 */
122 e_container_types kind_; /* This container is of what kind */
124 xbt_dict_t children_;
127 //--------------------------------------------------
131 e_event_type eventType_;
132 virtual void print() = 0;
133 virtual ~PajeEvent();
136 //--------------------------------------------------
137 class SetVariableEvent : public PajeEvent {
139 Container* container;
144 SetVariableEvent(double timestamp, Container* container, Type* type, double value);
145 void print() override;
148 class AddVariableEvent:public PajeEvent {
150 Container* container;
155 AddVariableEvent(double timestamp, Container* container, Type* type, double value);
156 void print() override;
158 //--------------------------------------------------
161 class SubVariableEvent : public PajeEvent {
163 Container* container;
168 SubVariableEvent(double timestamp, Container* container, Type* type, double value);
169 void print() override;
171 //--------------------------------------------------
173 class SetStateEvent : public PajeEvent {
175 Container* container;
178 const char* filename;
182 SetStateEvent(double timestamp, Container* container, Type* type, Value* val);
183 void print() override;
187 class PushStateEvent : public PajeEvent {
189 Container* container;
193 const char* filename;
198 PushStateEvent(double timestamp, Container* container, Type* type, Value* val);
199 PushStateEvent(double timestamp, Container* container, Type* type, Value* val, void* extra);
200 void print() override;
203 class PopStateEvent : public PajeEvent {
204 Container* container;
208 PopStateEvent(double timestamp, Container* container, Type* type);
209 void print() override;
212 class ResetStateEvent : public PajeEvent {
213 Container* container;
217 ResetStateEvent(double timestamp, Container* container, Type* type);
218 void print() override;
221 class StartLinkEvent : public PajeEvent {
222 Container* container_;
224 Container* sourceContainer_;
231 StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, const char* value,
233 StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, const char* value,
234 const char* key, int size);
235 void print() override;
238 class EndLinkEvent : public PajeEvent {
239 Container* container;
241 Container* destContainer;
245 EndLinkEvent(double timestamp, Container* container, Type* type, Container* destContainer, const char* value,
248 void print() override;
252 class NewEvent : public PajeEvent {
254 Container* container;
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(int basic, int size);
279 XBT_PRIVATE void TRACE_paje_start();
280 XBT_PRIVATE void TRACE_paje_end();
281 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
284 /* from instr_config.c */
285 XBT_PRIVATE bool TRACE_needs_platform ();
286 XBT_PRIVATE bool TRACE_is_enabled();
287 XBT_PRIVATE bool TRACE_platform();
288 XBT_PRIVATE bool TRACE_platform_topology();
289 XBT_PRIVATE bool TRACE_is_configured();
290 XBT_PRIVATE bool TRACE_categorized ();
291 XBT_PRIVATE bool TRACE_uncategorized ();
292 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
293 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
294 XBT_PRIVATE bool TRACE_buffer ();
295 XBT_PRIVATE bool TRACE_disable_link();
296 XBT_PRIVATE bool TRACE_disable_speed();
297 XBT_PRIVATE bool TRACE_onelink_only ();
298 XBT_PRIVATE bool TRACE_disable_destroy ();
299 XBT_PRIVATE bool TRACE_basic ();
300 XBT_PRIVATE bool TRACE_display_sizes ();
301 XBT_PRIVATE char *TRACE_get_comment ();
302 XBT_PRIVATE char *TRACE_get_comment_file ();
303 XBT_PRIVATE int TRACE_precision ();
304 XBT_PRIVATE char *TRACE_get_filename();
305 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
306 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
307 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
308 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
309 XBT_PRIVATE void instr_pause_tracing ();
310 XBT_PRIVATE void instr_resume_tracing ();
312 /* Public functions used in SMPI */
313 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
314 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
315 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
316 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
317 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
319 /* from resource_utilization.c */
320 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
322 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
324 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
327 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
328 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
329 XBT_PRIVATE long long int instr_new_paje_id ();
330 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
331 XBT_PUBLIC(simgrid::instr::Container*) PJ_container_get_or_null(const char* name);
332 XBT_PUBLIC(container_t) PJ_container_get_root ();
333 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
334 XBT_PUBLIC(void) PJ_container_free_all (void);
335 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
337 /* instr_paje_types.c */
338 XBT_PUBLIC(simgrid::instr::Type*) PJ_type_get_root();
341 XBT_PRIVATE void TRACE_TI_start();
342 XBT_PRIVATE void TRACE_TI_end();
344 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
345 XBT_PRIVATE void dump_comment_file (const char *filename);
346 XBT_PRIVATE void dump_comment (const char *comment);
348 struct s_instr_extra_data;
349 typedef struct s_instr_extra_data *instr_extra_data;
380 TRACING_REDUCE_SCATTER,
387 typedef struct s_instr_extra_data {
392 double sleep_duration;
396 const char* datatype1;
397 const char* datatype2;
401 } s_instr_extra_data_t;
403 /* Format of TRACING output.
404 * - paje is the regular format, that we all know
405 * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such trace can easily be replayed with smpi_replay afterward.
406 * This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
408 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
409 extern instr_fmt_type_t instr_fmt_type;
413 void LogContainerTypeDefinition(simgrid::instr::Type* type);
414 void LogVariableTypeDefinition(simgrid::instr::Type* type);
415 void LogStateTypeDefinition(simgrid::instr::Type* type);
416 void LogLinkTypeDefinition(simgrid::instr::Type* type, simgrid::instr::Type* source, simgrid::instr::Type* dest);
417 void LogEntityValue(simgrid::instr::Value* val);
418 void LogContainerCreation (container_t container);
419 void LogContainerDestruction (container_t container);
420 void LogDefineEventType(simgrid::instr::Type* type);