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"
19 /* Need to define function drand48 for Windows */
20 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
22 # define drand48() (rand()/(RAND_MAX + 1.0))
25 #define INSTR_DEFAULT_STR_SIZE 500
27 #include "xbt/graph.h"
31 PAJE_DefineContainerType,
32 PAJE_DefineVariableType,
36 PAJE_DefineEntityValue,
38 PAJE_DestroyContainer,
59 //--------------------------------------------------
69 typedef s_type *type_t;
70 class s_type : public ess_type {
75 xbt_dict_t values; //valid for all types except variable and container
76 s_type (const char *typeNameBuff, const char *key, const char *color, e_entity_types kind, type_t father);
77 static type_t s_type_get_or_null (const char *name, type_t father);
78 static type_t s_type_container_new (const char *name, type_t father);
79 static type_t s_type_event_new (const char *name, type_t father);
80 static type_t s_type_variable_new (const char *name, const char *color, type_t father);
81 static type_t s_type_link_new (const char *name, type_t father, type_t source, type_t dest);
84 //--------------------------------------------------
85 class value : public ess_type{
89 value(const char* name, const char* color, type_t father);
91 static value* get_or_new(const char* name, const char* color, type_t father);
92 static value* get(const char* name, type_t father);
96 //--------------------------------------------------
108 //--------------------------------------------------
110 typedef s_container *container_t;
114 sg_netpoint_t netpoint;
115 char *name; /* Unique name of this container */
116 char *id; /* Unique id of this container */
117 type_t type; /* Type of this container */
118 int level; /* Level in the hierarchy, root level is 0 */
119 e_container_types kind; /* This container is of what kind */
124 //--------------------------------------------------
128 e_event_type event_type;
129 virtual void print() = 0;
131 virtual ~PajeEvent();
134 //--------------------------------------------------
136 class DefineVariableTypeEvent : public PajeEvent
140 DefineVariableTypeEvent(type_t type);
141 void print() override;
143 //--------------------------------------------------
145 class DefineStateTypeEvent : public PajeEvent {
148 DefineStateTypeEvent(type_t type);
149 void print() override;
153 class SetVariableEvent : public PajeEvent {
155 container_t container;
159 SetVariableEvent (double timestamp, container_t container, type_t type, double value);
160 void print() override;
164 class AddVariableEvent:public PajeEvent {
166 container_t container;
170 AddVariableEvent (double timestamp, container_t container, type_t type, double value);
171 void print() override;
174 //--------------------------------------------------
177 class SubVariableEvent : public PajeEvent {
179 container_t container;
183 SubVariableEvent(double timestamp, container_t container, type_t type, double value);
184 void print() override;
186 //--------------------------------------------------
188 class SetStateEvent : public PajeEvent {
190 container_t container;
193 const char* filename;
196 SetStateEvent(double timestamp, container_t container, type_t type, value* val);
197 void print() override;
201 class PushStateEvent : public PajeEvent {
203 container_t container;
207 const char* filename;
211 PushStateEvent(double timestamp, container_t container, type_t type, value* val);
212 PushStateEvent(double timestamp, container_t container, type_t type, value* val, void* extra);
213 void print() override;
216 class PopStateEvent : public PajeEvent {
217 container_t container;
220 PopStateEvent (double timestamp, container_t container, type_t type);
221 void print() override;
224 class ResetStateEvent : public PajeEvent {
225 container_t container;
228 ResetStateEvent (double timestamp, container_t container, type_t type);
229 void print() override;
232 class StartLinkEvent : public PajeEvent {
234 container_t container;
236 container_t sourceContainer;
242 StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
244 StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
245 const char* key, int size);
246 void print() override;
249 class EndLinkEvent : public PajeEvent {
250 container_t container;
252 container_t destContainer;
256 EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
257 const char *value, const char *key);
259 void print() override;
263 class NewEvent : public PajeEvent {
265 container_t container;
270 NewEvent(double timestamp, container_t container, type_t type, value* val);
271 void print() override;
275 extern XBT_PRIVATE std::set<std::string> created_categories;
276 extern XBT_PRIVATE std::set<std::string> declared_marks;
277 extern XBT_PRIVATE std::set<std::string> user_host_variables;
278 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
279 extern XBT_PRIVATE std::set<std::string> user_link_variables;
280 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
282 /* instr_paje_header.c */
283 XBT_PRIVATE void TRACE_header(int basic, int size);
286 XBT_PRIVATE void TRACE_paje_start();
287 XBT_PRIVATE void TRACE_paje_end();
288 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
291 /* from instr_config.c */
292 XBT_PRIVATE bool TRACE_needs_platform ();
293 XBT_PRIVATE bool TRACE_is_enabled();
294 XBT_PRIVATE bool TRACE_platform();
295 XBT_PRIVATE bool TRACE_platform_topology();
296 XBT_PRIVATE bool TRACE_is_configured();
297 XBT_PRIVATE bool TRACE_categorized ();
298 XBT_PRIVATE bool TRACE_uncategorized ();
299 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
300 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
301 XBT_PRIVATE bool TRACE_buffer ();
302 XBT_PRIVATE bool TRACE_disable_link();
303 XBT_PRIVATE bool TRACE_disable_speed();
304 XBT_PRIVATE bool TRACE_onelink_only ();
305 XBT_PRIVATE bool TRACE_disable_destroy ();
306 XBT_PRIVATE bool TRACE_basic ();
307 XBT_PRIVATE bool TRACE_display_sizes ();
308 XBT_PRIVATE char *TRACE_get_comment ();
309 XBT_PRIVATE char *TRACE_get_comment_file ();
310 XBT_PRIVATE int TRACE_precision ();
311 XBT_PRIVATE char *TRACE_get_filename();
312 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
313 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
314 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
315 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
316 XBT_PRIVATE void instr_pause_tracing ();
317 XBT_PRIVATE void instr_resume_tracing ();
319 /* Public functions used in SMPI */
320 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
321 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
322 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
323 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
324 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
326 /* from resource_utilization.c */
327 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
329 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
331 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
334 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
335 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
336 XBT_PRIVATE long long int instr_new_paje_id ();
337 XBT_PRIVATE void PJ_container_alloc ();
338 XBT_PRIVATE void PJ_container_release ();
339 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
340 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
341 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
342 XBT_PUBLIC(container_t) PJ_container_get_root ();
343 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
344 XBT_PUBLIC(void) PJ_container_free (container_t container);
345 XBT_PUBLIC(void) PJ_container_free_all (void);
346 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
348 /* instr_paje_types.c */
349 XBT_PRIVATE void PJ_type_release ();
350 XBT_PUBLIC(type_t) PJ_type_get_root ();
351 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
352 XBT_PUBLIC(type_t) PJ_type_get (const char *name, const type_t father);
353 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
356 XBT_PRIVATE void recursiveDestroyType (type_t type);
358 XBT_PRIVATE void TRACE_TI_start();
359 XBT_PRIVATE void TRACE_TI_end();
361 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
362 XBT_PRIVATE void dump_comment_file (const char *filename);
363 XBT_PRIVATE void dump_comment (const char *comment);
365 struct s_instr_extra_data;
366 typedef struct s_instr_extra_data *instr_extra_data;
397 TRACING_REDUCE_SCATTER,
404 typedef struct s_instr_extra_data {
409 double sleep_duration;
413 const char* datatype1;
414 const char* datatype2;
418 } s_instr_extra_data_t;
420 /* Format of TRACING output.
421 * - paje is the regular format, that we all know
422 * - 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.
423 * This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
425 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
426 extern instr_fmt_type_t instr_fmt_type;
430 void DefineContainerEvent(type_t type);
431 void LogVariableTypeDefinition(type_t type);
432 void LogStateTypeDefinition(type_t type);
433 void LogLinkTypeDefinition(type_t type, type_t source, type_t dest);
434 void LogEntityValue(value* val);
435 void LogContainerCreation (container_t container);
436 void LogContainerDestruction (container_t container);
437 void LogDefineEventType(type_t type);