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 class DefineContainerEvent : public PajeEvent
130 void print() override;
131 DefineContainerEvent(type_t);
134 //--------------------------------------------------
137 //--------------------------------------------------
139 class DefineVariableTypeEvent : public PajeEvent
143 DefineVariableTypeEvent(type_t type);
144 void print() override;
146 //--------------------------------------------------
148 class DefineStateTypeEvent : public PajeEvent {
151 DefineStateTypeEvent(type_t type);
152 void print() override;
155 class DefineEventTypeEvent : public PajeEvent {
158 DefineEventTypeEvent(type_t type);
159 void print() override;
162 class DefineLinkTypeEvent : public PajeEvent {
167 DefineLinkTypeEvent(type_t type, type_t source, type_t dest);
168 void print() override;
171 class DefineEntityValueEvent : public PajeEvent {
174 DefineEntityValueEvent (val_t type);
175 void print() override;
178 class CreateContainerEvent : public PajeEvent {
180 container_t container;
181 explicit CreateContainerEvent (container_t container);
182 void print() override;
185 class DestroyContainerEvent : public PajeEvent {
187 container_t container;
188 DestroyContainerEvent (container_t container);
189 void print() override;
193 class SetVariableEvent : public PajeEvent {
194 container_t container;
198 SetVariableEvent (double timestamp, container_t container, type_t type, double value);
199 void print() override;
203 class AddVariableEvent:public PajeEvent {
204 container_t container;
208 AddVariableEvent (double timestamp, container_t container, type_t type, double value);
209 void print() override;
212 //--------------------------------------------------
215 class SubVariableEvent : public PajeEvent {
217 container_t container;
221 SubVariableEvent(double timestamp, container_t container, type_t type, double value);
222 void print() override;
224 //--------------------------------------------------
226 class SetStateEvent : public PajeEvent {
228 container_t container;
231 const char* filename;
234 SetStateEvent (double timestamp, container_t container, type_t type, val_t value);
235 void print() override;
239 class PushStateEvent : public PajeEvent {
241 container_t container;
245 const char* filename;
249 PushStateEvent (double timestamp, container_t container, type_t type, val_t value);
250 PushStateEvent (double timestamp, container_t container, type_t type, val_t value,
252 void print() override;
255 class PopStateEvent : public PajeEvent {
256 container_t container;
259 PopStateEvent (double timestamp, container_t container, type_t type);
260 void print() override;
263 class ResetStateEvent : public PajeEvent {
264 container_t container;
267 ResetStateEvent (double timestamp, container_t container, type_t type);
268 void print() override;
271 class StartLinkEvent : public PajeEvent {
273 container_t container;
275 container_t sourceContainer;
280 StartLinkEvent (double timestamp, container_t container, type_t type, container_t sourceContainer,
281 const char *value, const char *key);
282 StartLinkEvent (double timestamp, container_t container, type_t type,
283 container_t sourceContainer, const char *value, const char *key, int size);
284 void print() override;
287 class EndLinkEvent : public PajeEvent {
288 container_t container;
290 container_t destContainer;
294 EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
295 const char *value, const char *key);
296 void print() override;
300 class NewEvent : public PajeEvent {
302 container_t container;
306 NewEvent (double timestamp, container_t container, type_t type, val_t value);
307 void print() override;
312 extern XBT_PRIVATE xbt_dict_t created_categories;
313 extern XBT_PRIVATE xbt_dict_t declared_marks;
314 extern XBT_PRIVATE xbt_dict_t user_host_variables;
315 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
316 extern XBT_PRIVATE xbt_dict_t user_link_variables;
317 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
319 /* instr_paje_header.c */
320 XBT_PRIVATE void TRACE_header(int basic, int size);
323 XBT_PRIVATE void TRACE_paje_start();
324 XBT_PRIVATE void TRACE_paje_end();
325 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
328 /* from instr_config.c */
329 XBT_PRIVATE bool TRACE_needs_platform ();
330 XBT_PRIVATE bool TRACE_is_enabled();
331 XBT_PRIVATE bool TRACE_platform();
332 XBT_PRIVATE bool TRACE_platform_topology();
333 XBT_PRIVATE bool TRACE_is_configured();
334 XBT_PRIVATE bool TRACE_categorized ();
335 XBT_PRIVATE bool TRACE_uncategorized ();
336 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
337 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
338 XBT_PRIVATE bool TRACE_buffer ();
339 XBT_PRIVATE bool TRACE_disable_link();
340 XBT_PRIVATE bool TRACE_disable_speed();
341 XBT_PRIVATE bool TRACE_onelink_only ();
342 XBT_PRIVATE bool TRACE_disable_destroy ();
343 XBT_PRIVATE bool TRACE_basic ();
344 XBT_PRIVATE bool TRACE_display_sizes ();
345 XBT_PRIVATE char *TRACE_get_comment ();
346 XBT_PRIVATE char *TRACE_get_comment_file ();
347 XBT_PRIVATE int TRACE_precision ();
348 XBT_PRIVATE char *TRACE_get_filename();
349 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
350 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
351 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
352 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
353 XBT_PRIVATE void instr_pause_tracing ();
354 XBT_PRIVATE void instr_resume_tracing ();
356 /* Public functions used in SMPI */
357 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
358 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
359 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
360 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
361 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
363 /* from resource_utilization.c */
364 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
366 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
368 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
371 extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
372 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
373 XBT_PRIVATE long long int instr_new_paje_id ();
374 XBT_PRIVATE void PJ_container_alloc ();
375 XBT_PRIVATE void PJ_container_release ();
376 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
377 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
378 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
379 XBT_PUBLIC(container_t) PJ_container_get_root ();
380 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
381 XBT_PUBLIC(void) PJ_container_free (container_t container);
382 XBT_PUBLIC(void) PJ_container_free_all (void);
383 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
385 /* instr_paje_types.c */
386 XBT_PRIVATE void PJ_type_alloc ();
387 XBT_PRIVATE void PJ_type_release ();
388 XBT_PUBLIC(type_t) PJ_type_get_root ();
389 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
390 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
391 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
392 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
393 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
394 XBT_PUBLIC(type_t) PJ_type_get (const char *name, const type_t father);
395 XBT_PUBLIC(type_t) PJ_type_get_or_null (const char *name, type_t father);
396 void PJ_type_free_all ();
397 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
399 /* instr_paje_values.c */
400 XBT_PUBLIC(val_t) PJ_value_new (const char *name, const char *color, type_t father);
401 XBT_PUBLIC(val_t) PJ_value_get_or_new (const char *name, const char *color, type_t father);
402 XBT_PUBLIC(val_t) PJ_value_get (const char *name, const type_t father);
403 XBT_PRIVATE void PJ_value_free (val_t value);
405 XBT_PRIVATE void print_pajeDefineContainerType(PajeEvent* event);
406 XBT_PRIVATE void print_pajeDefineVariableType(PajeEvent* event);
407 XBT_PRIVATE void print_pajeDefineStateType(PajeEvent* event);
408 XBT_PRIVATE void print_pajeDefineEventType(PajeEvent* event);
409 XBT_PRIVATE void print_pajeDefineLinkType(PajeEvent* event);
410 XBT_PRIVATE void print_pajeDefineEntityValue (PajeEvent* event);
411 XBT_PRIVATE void print_pajeCreateContainer(PajeEvent* event);
412 XBT_PRIVATE void print_pajeDestroyContainer(PajeEvent* event);
413 XBT_PRIVATE void print_pajeSetVariable(PajeEvent* event);
414 XBT_PRIVATE void print_pajeAddVariable(PajeEvent* event);
415 XBT_PRIVATE void print_pajeSubVariable(PajeEvent* event);
416 XBT_PRIVATE void print_pajeSetState(PajeEvent* event);
417 XBT_PRIVATE void print_pajePushState(PajeEvent* event);
418 XBT_PRIVATE void print_pajePopState(PajeEvent* event);
419 XBT_PRIVATE void print_pajeResetState(PajeEvent* event);
420 XBT_PRIVATE void print_pajeStartLink(PajeEvent* event);
421 XBT_PRIVATE void print_pajeEndLink(PajeEvent* event);
422 XBT_PRIVATE void print_pajeNewEvent (PajeEvent* event);
424 XBT_PRIVATE void TRACE_TI_start();
425 XBT_PRIVATE void TRACE_TI_end();
427 XBT_PRIVATE void print_NULL (PajeEvent* event);
428 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
429 XBT_PRIVATE void dump_comment_file (const char *filename);
430 XBT_PRIVATE void dump_comment (const char *comment);
432 typedef struct instr_trace_writer {
433 void (*print_DefineContainerType) (PajeEvent* event);
434 void (*print_DefineVariableType)(PajeEvent* event);
435 void (*print_DefineStateType)(PajeEvent* event);
436 void (*print_DefineEventType)(PajeEvent* event);
437 void (*print_DefineLinkType)(PajeEvent* event);
438 void (*print_DefineEntityValue)(PajeEvent* event);
439 void (*print_CreateContainer)(PajeEvent* event);
440 void (*print_DestroyContainer)(PajeEvent* event);
441 void (*print_SetVariable)(PajeEvent* event);
442 void (*print_AddVariable)(PajeEvent* event);
443 void (*print_SubVariable)(PajeEvent* event);
444 void (*print_SetState)(PajeEvent* event);
445 void (*print_PushState)(PajeEvent* event);
446 void (*print_PopState)(PajeEvent* event);
447 void (*print_ResetState)(PajeEvent* event);
448 void (*print_StartLink)(PajeEvent* event);
449 void (*print_EndLink)(PajeEvent* event);
450 void (*print_NewEvent) (PajeEvent* event);
451 } s_instr_trace_writer_t;
453 struct s_instr_extra_data;
454 typedef struct s_instr_extra_data *instr_extra_data;
485 TRACING_REDUCE_SCATTER,
492 typedef struct s_instr_extra_data {
497 double sleep_duration;
501 const char* datatype1;
502 const char* datatype2;
506 } s_instr_extra_data_t;
508 /* Format of TRACING output.
509 * - paje is the regular format, that we all know
510 * - 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.
511 * This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
513 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
514 extern instr_fmt_type_t instr_fmt_type;