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
81 typedef s_val s_val_t;
94 typedef struct s_container *container_t;
95 typedef struct s_container {
96 sg_netpoint_t netpoint;
97 char *name; /* Unique name of this container */
98 char *id; /* Unique id of this container */
99 type_t type; /* Type of this container */
100 int level; /* Level in the hierarchy, root level is 0 */
101 e_container_types kind; /* This container is of what kind */
102 struct s_container *father;
109 typedef paje_event *paje_event_t;
114 e_event_type event_type;
115 void (*print) (paje_event_t event);
116 void (*free) (paje_event_t event);
120 typedef paje_event s_paje_event_t;
122 typedef struct s_defineContainerType *defineContainerType_t;
123 typedef struct s_defineContainerType {
125 }s_defineContainerType_t;
127 typedef struct s_defineVariableType *defineVariableType_t;
128 typedef struct s_defineVariableType {
130 }s_defineVariableType_t;
132 typedef struct s_defineStateType *defineStateType_t;
133 typedef struct s_defineStateType {
135 }s_defineStateType_t;
137 typedef struct s_defineEventType *defineEventType_t;
138 typedef struct s_defineEventType {
140 }s_defineEventType_t;
142 typedef struct s_defineLinkType *defineLinkType_t;
143 typedef struct s_defineLinkType {
149 typedef struct s_defineEntityValue *defineEntityValue_t;
150 typedef struct s_defineEntityValue {
152 }s_defineEntityValue_t;
154 typedef struct s_createContainer *createContainer_t;
155 typedef struct s_createContainer {
156 container_t container;
157 }s_createContainer_t;
159 typedef struct s_destroyContainer *destroyContainer_t;
160 typedef struct s_destroyContainer {
161 container_t container;
162 }s_destroyContainer_t;
164 typedef struct s_setVariable *setVariable_t;
165 typedef struct s_setVariable {
166 container_t container;
171 typedef struct s_addVariable *addVariable_t;
172 typedef struct s_addVariable {
173 container_t container;
178 typedef struct s_subVariable *subVariable_t;
179 typedef struct s_subVariable {
180 container_t container;
185 typedef struct s_setState *setState_t;
186 typedef struct s_setState {
187 container_t container;
190 const char* filename;
194 typedef struct s_pushState *pushState_t;
195 typedef struct s_pushState {
196 container_t container;
200 const char* filename;
205 typedef struct s_popState *popState_t;
206 typedef struct s_popState {
207 container_t container;
212 typedef struct s_resetState *resetState_t;
213 typedef struct s_resetState {
214 container_t container;
218 typedef struct s_startLink *startLink_t;
219 typedef struct s_startLink {
220 container_t container;
222 container_t sourceContainer;
228 typedef struct s_endLink *endLink_t;
229 typedef struct s_endLink {
230 container_t container;
232 container_t destContainer;
239 typedef s_newEvent *newEvent_t;
243 container_t container;
248 typedef s_newEvent s_newEvent_t;
250 extern XBT_PRIVATE xbt_dict_t created_categories;
251 extern XBT_PRIVATE xbt_dict_t declared_marks;
252 extern XBT_PRIVATE xbt_dict_t user_host_variables;
253 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
254 extern XBT_PRIVATE xbt_dict_t user_link_variables;
255 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
257 /* instr_paje_header.c */
258 XBT_PRIVATE void TRACE_header(int basic, int size);
261 XBT_PRIVATE void TRACE_paje_init();
262 XBT_PRIVATE void TRACE_paje_start();
263 XBT_PRIVATE void TRACE_paje_end();
264 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
265 XBT_PUBLIC(void) new_pajeDefineContainerType(type_t type);
266 XBT_PUBLIC(void) new_pajeDefineVariableType(type_t type);
267 XBT_PUBLIC(void) new_pajeDefineStateType(type_t type);
268 XBT_PUBLIC(void) new_pajeDefineEventType(type_t type);
269 XBT_PUBLIC(void) new_pajeDefineLinkType(type_t type, type_t source, type_t dest);
270 XBT_PUBLIC(void) new_pajeDefineEntityValue (val_t type);
273 XBT_PUBLIC(void) new_pajeCreateContainer (container_t container);
274 XBT_PUBLIC(void) new_pajeDestroyContainer (container_t container);
276 XBT_PUBLIC(void) new_pajeSetVariable (double timestamp, container_t container, type_t type, double value);
277 XBT_PUBLIC(void) new_pajeAddVariable (double timestamp, container_t container, type_t type, double value);
278 XBT_PUBLIC(void) new_pajeSubVariable (double timestamp, container_t container, type_t type, double value);
280 XBT_PUBLIC(void) new_pajeSetState (double timestamp, container_t container, type_t type, val_t value);
281 XBT_PUBLIC(void) new_pajePushState (double timestamp, container_t container, type_t type, val_t value);
282 XBT_PUBLIC(void) new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value,
284 XBT_PUBLIC(void) new_pajePopState (double timestamp, container_t container, type_t type);
285 XBT_PUBLIC(void) new_pajeResetState (double timestamp, container_t container, type_t type);
286 XBT_PUBLIC(void) new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer,
287 const char *value, const char *key);
288 XBT_PUBLIC(void) new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type,
289 container_t sourceContainer, const char *value, const char *key, int size);
290 XBT_PUBLIC(void) new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
291 const char *value, const char *key);
292 XBT_PUBLIC(void) new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value);
294 /* from instr_config.c */
295 XBT_PRIVATE bool TRACE_needs_platform ();
296 XBT_PRIVATE bool TRACE_is_enabled();
297 XBT_PRIVATE bool TRACE_platform();
298 XBT_PRIVATE bool TRACE_platform_topology();
299 XBT_PRIVATE bool TRACE_is_configured();
300 XBT_PRIVATE bool TRACE_categorized ();
301 XBT_PRIVATE bool TRACE_uncategorized ();
302 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
303 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
304 XBT_PRIVATE bool TRACE_buffer ();
305 XBT_PRIVATE bool TRACE_disable_link();
306 XBT_PRIVATE bool TRACE_disable_speed();
307 XBT_PRIVATE bool TRACE_onelink_only ();
308 XBT_PRIVATE bool TRACE_disable_destroy ();
309 XBT_PRIVATE bool TRACE_basic ();
310 XBT_PRIVATE bool TRACE_display_sizes ();
311 XBT_PRIVATE char *TRACE_get_comment ();
312 XBT_PRIVATE char *TRACE_get_comment_file ();
313 XBT_PRIVATE int TRACE_precision ();
314 XBT_PRIVATE char *TRACE_get_filename();
315 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
316 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
317 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
318 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
319 XBT_PRIVATE void instr_pause_tracing ();
320 XBT_PRIVATE void instr_resume_tracing ();
322 /* Public functions used in SMPI */
323 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
324 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
325 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
326 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
327 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
329 /* from resource_utilization.c */
330 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
332 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
334 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
337 extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
338 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
339 XBT_PRIVATE long long int instr_new_paje_id ();
340 XBT_PRIVATE void PJ_container_alloc ();
341 XBT_PRIVATE void PJ_container_release ();
342 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
343 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
344 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
345 XBT_PUBLIC(container_t) PJ_container_get_root ();
346 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
347 XBT_PUBLIC(void) PJ_container_free (container_t container);
348 XBT_PUBLIC(void) PJ_container_free_all (void);
349 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
351 /* instr_paje_types.c */
352 XBT_PRIVATE void PJ_type_alloc ();
353 XBT_PRIVATE void PJ_type_release ();
354 XBT_PUBLIC(type_t) PJ_type_get_root ();
355 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
356 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
357 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
358 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
359 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
360 XBT_PUBLIC(type_t) PJ_type_get (const char *name, const type_t father);
361 XBT_PUBLIC(type_t) PJ_type_get_or_null (const char *name, type_t father);
362 void PJ_type_free_all ();
363 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
365 /* instr_paje_values.c */
366 XBT_PUBLIC(val_t) PJ_value_new (const char *name, const char *color, type_t father);
367 XBT_PUBLIC(val_t) PJ_value_get_or_new (const char *name, const char *color, type_t father);
368 XBT_PUBLIC(val_t) PJ_value_get (const char *name, const type_t father);
369 XBT_PRIVATE void PJ_value_free (val_t value);
371 XBT_PRIVATE void print_pajeDefineContainerType(paje_event_t event);
372 XBT_PRIVATE void print_pajeDefineVariableType(paje_event_t event);
373 XBT_PRIVATE void print_pajeDefineStateType(paje_event_t event);
374 XBT_PRIVATE void print_pajeDefineEventType(paje_event_t event);
375 XBT_PRIVATE void print_pajeDefineLinkType(paje_event_t event);
376 XBT_PRIVATE void print_pajeDefineEntityValue (paje_event_t event);
377 XBT_PRIVATE void print_pajeCreateContainer(paje_event_t event);
378 XBT_PRIVATE void print_pajeDestroyContainer(paje_event_t event);
379 XBT_PRIVATE void print_pajeSetVariable(paje_event_t event);
380 XBT_PRIVATE void print_pajeAddVariable(paje_event_t event);
381 XBT_PRIVATE void print_pajeSubVariable(paje_event_t event);
382 XBT_PRIVATE void print_pajeSetState(paje_event_t event);
383 XBT_PRIVATE void print_pajePushState(paje_event_t event);
384 XBT_PRIVATE void print_pajePopState(paje_event_t event);
385 XBT_PRIVATE void print_pajeResetState(paje_event_t event);
386 XBT_PRIVATE void print_pajeStartLink(paje_event_t event);
387 XBT_PRIVATE void print_pajeEndLink(paje_event_t event);
388 XBT_PRIVATE void print_pajeNewEvent (paje_event_t event);
390 XBT_PRIVATE void print_TIPushState(paje_event_t event);
391 XBT_PRIVATE void print_TICreateContainer(paje_event_t event);
392 XBT_PRIVATE void print_TIDestroyContainer(paje_event_t event);
393 XBT_PRIVATE void TRACE_TI_start();
394 XBT_PRIVATE void TRACE_TI_end();
395 XBT_PRIVATE void TRACE_TI_init();
397 XBT_PRIVATE void print_NULL (paje_event_t event);
398 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
399 XBT_PRIVATE void dump_comment_file (const char *filename);
400 XBT_PRIVATE void dump_comment (const char *comment);
402 typedef struct instr_trace_writer {
403 void (*print_DefineContainerType) (paje_event_t event);
404 void (*print_DefineVariableType)(paje_event_t event);
405 void (*print_DefineStateType)(paje_event_t event);
406 void (*print_DefineEventType)(paje_event_t event);
407 void (*print_DefineLinkType)(paje_event_t event);
408 void (*print_DefineEntityValue)(paje_event_t event);
409 void (*print_CreateContainer)(paje_event_t event);
410 void (*print_DestroyContainer)(paje_event_t event);
411 void (*print_SetVariable)(paje_event_t event);
412 void (*print_AddVariable)(paje_event_t event);
413 void (*print_SubVariable)(paje_event_t event);
414 void (*print_SetState)(paje_event_t event);
415 void (*print_PushState)(paje_event_t event);
416 void (*print_PopState)(paje_event_t event);
417 void (*print_ResetState)(paje_event_t event);
418 void (*print_StartLink)(paje_event_t event);
419 void (*print_EndLink)(paje_event_t event);
420 void (*print_NewEvent) (paje_event_t event);
421 } s_instr_trace_writer_t;
423 struct s_instr_extra_data;
424 typedef struct s_instr_extra_data *instr_extra_data;
455 TRACING_REDUCE_SCATTER,
462 typedef struct s_instr_extra_data {
467 double sleep_duration;
471 const char* datatype1;
472 const char* datatype2;
476 } s_instr_extra_data_t;