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 "simgrid/instr.h"
12 #include "instr/instr_interface.h"
13 #include "src/internal_config.h"
14 #include "simgrid_config.h"
18 /* Need to define function drand48 for Windows */
19 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
21 # define drand48() (rand()/(RAND_MAX + 1.0))
24 #define INSTR_DEFAULT_STR_SIZE 500
26 #include "xbt/graph.h"
30 PAJE_DefineContainerType,
31 PAJE_DefineVariableType,
35 PAJE_DefineEntityValue,
37 PAJE_DestroyContainer,
58 //--------------------------------------------------
60 typedef s_type *type_t;
69 xbt_dict_t values; //valid for all types except variable and container
72 typedef s_type s_type_t;
74 //--------------------------------------------------
85 typedef s_val s_val_t;
87 //--------------------------------------------------
99 //--------------------------------------------------
101 typedef s_container *container_t;
105 sg_netpoint_t netpoint;
106 char *name; /* Unique name of this container */
107 char *id; /* Unique id of this container */
108 type_t type; /* Type of this container */
109 int level; /* Level in the hierarchy, root level is 0 */
110 e_container_types kind; /* This container is of what kind */
114 typedef s_container s_container_t;
116 //--------------------------------------------------
120 e_event_type event_type;
121 virtual void print() = 0;
123 virtual ~PajeEvent();
126 //--------------------------------------------------
128 class DefineVariableTypeEvent : public PajeEvent
132 DefineVariableTypeEvent(type_t type);
133 void print() override;
135 //--------------------------------------------------
137 class DefineStateTypeEvent : public PajeEvent {
140 DefineStateTypeEvent(type_t type);
141 void print() override;
145 class SetVariableEvent : public PajeEvent {
146 container_t container;
150 SetVariableEvent (double timestamp, container_t container, type_t type, double value);
151 void print() override;
155 class AddVariableEvent:public PajeEvent {
156 container_t container;
160 AddVariableEvent (double timestamp, container_t container, type_t type, double value);
161 void print() override;
164 //--------------------------------------------------
167 class SubVariableEvent : public PajeEvent {
169 container_t container;
173 SubVariableEvent(double timestamp, container_t container, type_t type, double value);
174 void print() override;
176 //--------------------------------------------------
178 class SetStateEvent : public PajeEvent {
180 container_t container;
183 const char* filename;
186 SetStateEvent (double timestamp, container_t container, type_t type, val_t value);
187 void print() override;
191 class PushStateEvent : public PajeEvent {
193 container_t container;
197 const char* filename;
201 PushStateEvent (double timestamp, container_t container, type_t type, val_t value);
202 PushStateEvent (double timestamp, container_t container, type_t type, val_t value,
204 void print() override;
207 class PopStateEvent : public PajeEvent {
208 container_t container;
211 PopStateEvent (double timestamp, container_t container, type_t type);
212 void print() override;
215 class ResetStateEvent : public PajeEvent {
216 container_t container;
219 ResetStateEvent (double timestamp, container_t container, type_t type);
220 void print() override;
223 class StartLinkEvent : public PajeEvent {
225 container_t container;
227 container_t sourceContainer;
233 StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
235 StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
236 const char* key, int size);
237 void print() override;
240 class EndLinkEvent : public PajeEvent {
241 container_t container;
243 container_t destContainer;
247 EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
248 const char *value, const char *key);
250 void print() override;
254 class NewEvent : public PajeEvent {
256 container_t container;
260 NewEvent (double timestamp, container_t container, type_t type, val_t value);
261 void print() override;
266 extern XBT_PRIVATE xbt_dict_t created_categories;
267 extern XBT_PRIVATE xbt_dict_t declared_marks;
268 extern XBT_PRIVATE xbt_dict_t user_host_variables;
269 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
270 extern XBT_PRIVATE xbt_dict_t user_link_variables;
271 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
273 /* instr_paje_header.c */
274 XBT_PRIVATE void TRACE_header(int basic, int size);
277 XBT_PRIVATE void TRACE_paje_start();
278 XBT_PRIVATE void TRACE_paje_end();
279 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
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 xbt_dict_t trivaNodeTypes;
326 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
327 XBT_PRIVATE long long int instr_new_paje_id ();
328 XBT_PRIVATE void PJ_container_alloc ();
329 XBT_PRIVATE void PJ_container_release ();
330 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
331 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
332 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
333 XBT_PUBLIC(container_t) PJ_container_get_root ();
334 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
335 XBT_PUBLIC(void) PJ_container_free (container_t container);
336 XBT_PUBLIC(void) PJ_container_free_all (void);
337 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
339 /* instr_paje_types.c */
340 XBT_PRIVATE void PJ_type_alloc ();
341 XBT_PRIVATE void PJ_type_release ();
342 XBT_PUBLIC(type_t) PJ_type_get_root ();
343 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
344 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
345 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
346 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
347 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
348 XBT_PUBLIC(type_t) PJ_type_get (const char *name, const type_t father);
349 XBT_PUBLIC(type_t) PJ_type_get_or_null (const char *name, type_t father);
350 void PJ_type_free_all ();
351 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
353 /* instr_paje_values.c */
354 XBT_PUBLIC(val_t) PJ_value_new (const char *name, const char *color, type_t father);
355 XBT_PUBLIC(val_t) PJ_value_get_or_new (const char *name, const char *color, type_t father);
356 XBT_PUBLIC(val_t) PJ_value_get (const char *name, const type_t father);
357 XBT_PRIVATE void PJ_value_free (val_t value);
359 XBT_PRIVATE void TRACE_TI_start();
360 XBT_PRIVATE void TRACE_TI_end();
362 XBT_PRIVATE void print_NULL (PajeEvent* event);
363 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
364 XBT_PRIVATE void dump_comment_file (const char *filename);
365 XBT_PRIVATE void dump_comment (const char *comment);
367 struct s_instr_extra_data;
368 typedef struct s_instr_extra_data *instr_extra_data;
399 TRACING_REDUCE_SCATTER,
406 typedef struct s_instr_extra_data {
411 double sleep_duration;
415 const char* datatype1;
416 const char* datatype2;
420 } s_instr_extra_data_t;
422 /* Format of TRACING output.
423 * - paje is the regular format, that we all know
424 * - 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.
425 * This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
427 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
428 extern instr_fmt_type_t instr_fmt_type;
432 void DefineContainerEvent(type_t type);
433 void LogVariableTypeDefinition(type_t type);
434 void LogStateTypeDefinition(type_t type);
435 void LogLinkTypeDefinition(type_t type, type_t source, type_t dest);
436 void LogEntityValue (val_t value);
437 void LogContainerCreation (container_t container);
438 void LogContainerDestruction (container_t container);
439 void LogDefineEventType(type_t type);