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 typedef struct s_type *type_t;
59 typedef struct s_type {
64 struct s_type *father;
66 xbt_dict_t values; //valid for all types except variable and container
69 typedef struct s_val *val_t;
70 typedef struct s_val {
88 typedef struct s_container *container_t;
89 typedef struct s_container {
90 sg_netpoint_t netpoint;
91 char *name; /* Unique name of this container */
92 char *id; /* Unique id of this container */
93 type_t type; /* Type of this container */
94 int level; /* Level in the hierarchy, root level is 0 */
95 e_container_types kind; /* This container is of what kind */
96 struct s_container *father;
102 typedef paje_event *paje_event_t;
107 e_event_type event_type;
108 void (*print) (paje_event_t event);
109 void (*free) (paje_event_t event);
113 typedef paje_event s_paje_event_t;
115 typedef struct s_defineContainerType *defineContainerType_t;
116 typedef struct s_defineContainerType {
118 }s_defineContainerType_t;
120 typedef struct s_defineVariableType *defineVariableType_t;
121 typedef struct s_defineVariableType {
123 }s_defineVariableType_t;
125 typedef struct s_defineStateType *defineStateType_t;
126 typedef struct s_defineStateType {
128 }s_defineStateType_t;
130 typedef struct s_defineEventType *defineEventType_t;
131 typedef struct s_defineEventType {
133 }s_defineEventType_t;
135 typedef struct s_defineLinkType *defineLinkType_t;
136 typedef struct s_defineLinkType {
142 typedef struct s_defineEntityValue *defineEntityValue_t;
143 typedef struct s_defineEntityValue {
145 }s_defineEntityValue_t;
147 typedef struct s_createContainer *createContainer_t;
148 typedef struct s_createContainer {
149 container_t container;
150 }s_createContainer_t;
152 typedef struct s_destroyContainer *destroyContainer_t;
153 typedef struct s_destroyContainer {
154 container_t container;
155 }s_destroyContainer_t;
157 typedef struct s_setVariable *setVariable_t;
158 typedef struct s_setVariable {
159 container_t container;
164 typedef struct s_addVariable *addVariable_t;
165 typedef struct s_addVariable {
166 container_t container;
171 typedef struct s_subVariable *subVariable_t;
172 typedef struct s_subVariable {
173 container_t container;
178 typedef struct s_setState *setState_t;
179 typedef struct s_setState {
180 container_t container;
183 const char* filename;
187 typedef struct s_pushState *pushState_t;
188 typedef struct s_pushState {
189 container_t container;
193 const char* filename;
198 typedef struct s_popState *popState_t;
199 typedef struct s_popState {
200 container_t container;
205 typedef struct s_resetState *resetState_t;
206 typedef struct s_resetState {
207 container_t container;
211 typedef struct s_startLink *startLink_t;
212 typedef struct s_startLink {
213 container_t container;
215 container_t sourceContainer;
221 typedef struct s_endLink *endLink_t;
222 typedef struct s_endLink {
223 container_t container;
225 container_t destContainer;
230 typedef struct s_newEvent *newEvent_t;
231 typedef struct s_newEvent {
232 container_t container;
237 extern XBT_PRIVATE xbt_dict_t created_categories;
238 extern XBT_PRIVATE xbt_dict_t declared_marks;
239 extern XBT_PRIVATE xbt_dict_t user_host_variables;
240 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
241 extern XBT_PRIVATE xbt_dict_t user_link_variables;
242 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
244 /* instr_paje_header.c */
245 XBT_PRIVATE void TRACE_header(int basic, int size);
248 XBT_PRIVATE void TRACE_paje_init();
249 XBT_PRIVATE void TRACE_paje_start();
250 XBT_PRIVATE void TRACE_paje_end();
251 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
252 XBT_PUBLIC(void) new_pajeDefineContainerType(type_t type);
253 XBT_PUBLIC(void) new_pajeDefineVariableType(type_t type);
254 XBT_PUBLIC(void) new_pajeDefineStateType(type_t type);
255 XBT_PUBLIC(void) new_pajeDefineEventType(type_t type);
256 XBT_PUBLIC(void) new_pajeDefineLinkType(type_t type, type_t source, type_t dest);
257 XBT_PUBLIC(void) new_pajeDefineEntityValue (val_t type);
258 XBT_PUBLIC(void) new_pajeCreateContainer (container_t container);
259 XBT_PUBLIC(void) new_pajeDestroyContainer (container_t container);
260 XBT_PUBLIC(void) new_pajeSetVariable (double timestamp, container_t container, type_t type, double value);
261 XBT_PUBLIC(void) new_pajeAddVariable (double timestamp, container_t container, type_t type, double value);
262 XBT_PUBLIC(void) new_pajeSubVariable (double timestamp, container_t container, type_t type, double value);
263 XBT_PUBLIC(void) new_pajeSetState (double timestamp, container_t container, type_t type, val_t value);
264 XBT_PUBLIC(void) new_pajePushState (double timestamp, container_t container, type_t type, val_t value);
265 XBT_PUBLIC(void) new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value,
267 XBT_PUBLIC(void) new_pajePopState (double timestamp, container_t container, type_t type);
268 XBT_PUBLIC(void) new_pajeResetState (double timestamp, container_t container, type_t type);
269 XBT_PUBLIC(void) new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer,
270 const char *value, const char *key);
271 XBT_PUBLIC(void) new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type,
272 container_t sourceContainer, const char *value, const char *key, int size);
273 XBT_PUBLIC(void) new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
274 const char *value, const char *key);
275 XBT_PUBLIC(void) new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value);
277 /* from instr_config.c */
278 XBT_PRIVATE bool TRACE_needs_platform ();
279 XBT_PRIVATE bool TRACE_is_enabled();
280 XBT_PRIVATE bool TRACE_platform();
281 XBT_PRIVATE bool TRACE_platform_topology();
282 XBT_PRIVATE bool TRACE_is_configured();
283 XBT_PRIVATE bool TRACE_categorized ();
284 XBT_PRIVATE bool TRACE_uncategorized ();
285 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
286 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
287 XBT_PRIVATE bool TRACE_buffer ();
288 XBT_PRIVATE bool TRACE_disable_link();
289 XBT_PRIVATE bool TRACE_disable_speed();
290 XBT_PRIVATE bool TRACE_onelink_only ();
291 XBT_PRIVATE bool TRACE_disable_destroy ();
292 XBT_PRIVATE bool TRACE_basic ();
293 XBT_PRIVATE bool TRACE_display_sizes ();
294 XBT_PRIVATE char *TRACE_get_comment ();
295 XBT_PRIVATE char *TRACE_get_comment_file ();
296 XBT_PRIVATE int TRACE_precision ();
297 XBT_PRIVATE char *TRACE_get_filename();
298 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
299 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
300 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
301 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
302 XBT_PRIVATE void instr_pause_tracing ();
303 XBT_PRIVATE void instr_resume_tracing ();
305 /* Public functions used in SMPI */
306 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
307 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
308 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
309 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
310 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
312 /* from resource_utilization.c */
313 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
315 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
317 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
320 extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
321 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
322 XBT_PRIVATE long long int instr_new_paje_id ();
323 XBT_PRIVATE void PJ_container_alloc ();
324 XBT_PRIVATE void PJ_container_release ();
325 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
326 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
327 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
328 XBT_PUBLIC(container_t) PJ_container_get_root ();
329 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
330 XBT_PUBLIC(void) PJ_container_free (container_t container);
331 XBT_PUBLIC(void) PJ_container_free_all (void);
332 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
334 /* instr_paje_types.c */
335 XBT_PRIVATE void PJ_type_alloc ();
336 XBT_PRIVATE void PJ_type_release ();
337 XBT_PUBLIC(type_t) PJ_type_get_root ();
338 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
339 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
340 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
341 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
342 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
343 XBT_PUBLIC(type_t) PJ_type_get (const char *name, const type_t father);
344 XBT_PUBLIC(type_t) PJ_type_get_or_null (const char *name, type_t father);
345 void PJ_type_free_all ();
346 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
348 /* instr_paje_values.c */
349 XBT_PUBLIC(val_t) PJ_value_new (const char *name, const char *color, type_t father);
350 XBT_PUBLIC(val_t) PJ_value_get_or_new (const char *name, const char *color, type_t father);
351 XBT_PUBLIC(val_t) PJ_value_get (const char *name, const type_t father);
352 XBT_PRIVATE void PJ_value_free (val_t value);
354 XBT_PRIVATE void print_pajeDefineContainerType(paje_event_t event);
355 XBT_PRIVATE void print_pajeDefineVariableType(paje_event_t event);
356 XBT_PRIVATE void print_pajeDefineStateType(paje_event_t event);
357 XBT_PRIVATE void print_pajeDefineEventType(paje_event_t event);
358 XBT_PRIVATE void print_pajeDefineLinkType(paje_event_t event);
359 XBT_PRIVATE void print_pajeDefineEntityValue (paje_event_t event);
360 XBT_PRIVATE void print_pajeCreateContainer(paje_event_t event);
361 XBT_PRIVATE void print_pajeDestroyContainer(paje_event_t event);
362 XBT_PRIVATE void print_pajeSetVariable(paje_event_t event);
363 XBT_PRIVATE void print_pajeAddVariable(paje_event_t event);
364 XBT_PRIVATE void print_pajeSubVariable(paje_event_t event);
365 XBT_PRIVATE void print_pajeSetState(paje_event_t event);
366 XBT_PRIVATE void print_pajePushState(paje_event_t event);
367 XBT_PRIVATE void print_pajePopState(paje_event_t event);
368 XBT_PRIVATE void print_pajeResetState(paje_event_t event);
369 XBT_PRIVATE void print_pajeStartLink(paje_event_t event);
370 XBT_PRIVATE void print_pajeEndLink(paje_event_t event);
371 XBT_PRIVATE void print_pajeNewEvent (paje_event_t event);
373 XBT_PRIVATE void print_TIPushState(paje_event_t event);
374 XBT_PRIVATE void print_TICreateContainer(paje_event_t event);
375 XBT_PRIVATE void print_TIDestroyContainer(paje_event_t event);
376 XBT_PRIVATE void TRACE_TI_start();
377 XBT_PRIVATE void TRACE_TI_end();
378 XBT_PRIVATE void TRACE_TI_init();
380 XBT_PRIVATE void print_NULL (paje_event_t event);
381 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
382 XBT_PRIVATE void dump_comment_file (const char *filename);
383 XBT_PRIVATE void dump_comment (const char *comment);
385 typedef struct instr_trace_writer {
386 void (*print_DefineContainerType) (paje_event_t event);
387 void (*print_DefineVariableType)(paje_event_t event);
388 void (*print_DefineStateType)(paje_event_t event);
389 void (*print_DefineEventType)(paje_event_t event);
390 void (*print_DefineLinkType)(paje_event_t event);
391 void (*print_DefineEntityValue)(paje_event_t event);
392 void (*print_CreateContainer)(paje_event_t event);
393 void (*print_DestroyContainer)(paje_event_t event);
394 void (*print_SetVariable)(paje_event_t event);
395 void (*print_AddVariable)(paje_event_t event);
396 void (*print_SubVariable)(paje_event_t event);
397 void (*print_SetState)(paje_event_t event);
398 void (*print_PushState)(paje_event_t event);
399 void (*print_PopState)(paje_event_t event);
400 void (*print_ResetState)(paje_event_t event);
401 void (*print_StartLink)(paje_event_t event);
402 void (*print_EndLink)(paje_event_t event);
403 void (*print_NewEvent) (paje_event_t event);
404 } s_instr_trace_writer_t;
406 struct s_instr_extra_data;
407 typedef struct s_instr_extra_data *instr_extra_data;
438 TRACING_REDUCE_SCATTER,
445 typedef struct s_instr_extra_data {
450 double sleep_duration;
454 const char* datatype1;
455 const char* datatype2;
459 } s_instr_extra_data_t;