1 /* Copyright (c) 2010-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef INSTR_PRIVATE_H_
8 #define INSTR_PRIVATE_H_
12 #include "simgrid/instr.h"
13 #include "instr/instr_interface.h"
14 #include "internal_config.h"
15 #include "simgrid_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"
29 #include "simgrid/platf.h"
32 PAJE_DefineContainerType,
33 PAJE_DefineVariableType,
37 PAJE_DefineEntityValue,
39 PAJE_DestroyContainer,
60 typedef struct s_type *type_t;
61 typedef struct s_type {
66 struct s_type *father;
68 xbt_dict_t values; //valid for all types except variable and container
71 typedef struct s_val *val_t;
72 typedef struct s_val {
90 typedef struct s_container *container_t;
91 typedef struct s_container {
92 sg_routing_edge_t net_elm;
93 char *name; /* Unique name of this container */
94 char *id; /* Unique id of this container */
95 type_t type; /* Type of this container */
96 int level; /* Level in the hierarchy, root level is 0 */
97 e_container_types kind; /* This container is of what kind */
98 struct s_container *father;
102 typedef struct paje_event *paje_event_t;
103 typedef struct paje_event {
105 e_event_type event_type;
106 void (*print) (paje_event_t event);
107 void (*free) (paje_event_t event);
111 typedef struct s_defineContainerType *defineContainerType_t;
112 typedef struct s_defineContainerType {
114 }s_defineContainerType_t;
116 typedef struct s_defineVariableType *defineVariableType_t;
117 typedef struct s_defineVariableType {
119 }s_defineVariableType_t;
121 typedef struct s_defineStateType *defineStateType_t;
122 typedef struct s_defineStateType {
124 }s_defineStateType_t;
126 typedef struct s_defineEventType *defineEventType_t;
127 typedef struct s_defineEventType {
129 }s_defineEventType_t;
131 typedef struct s_defineLinkType *defineLinkType_t;
132 typedef struct s_defineLinkType {
138 typedef struct s_defineEntityValue *defineEntityValue_t;
139 typedef struct s_defineEntityValue {
141 }s_defineEntityValue_t;
143 typedef struct s_createContainer *createContainer_t;
144 typedef struct s_createContainer {
145 container_t container;
146 }s_createContainer_t;
148 typedef struct s_destroyContainer *destroyContainer_t;
149 typedef struct s_destroyContainer {
150 container_t container;
151 }s_destroyContainer_t;
153 typedef struct s_setVariable *setVariable_t;
154 typedef struct s_setVariable {
155 container_t container;
160 typedef struct s_addVariable *addVariable_t;
161 typedef struct s_addVariable {
162 container_t container;
167 typedef struct s_subVariable *subVariable_t;
168 typedef struct s_subVariable {
169 container_t container;
174 typedef struct s_setState *setState_t;
175 typedef struct s_setState {
176 container_t container;
181 typedef struct s_pushState *pushState_t;
182 typedef struct s_pushState {
183 container_t container;
190 typedef struct s_popState *popState_t;
191 typedef struct s_popState {
192 container_t container;
197 typedef struct s_resetState *resetState_t;
198 typedef struct s_resetState {
199 container_t container;
203 typedef struct s_startLink *startLink_t;
204 typedef struct s_startLink {
205 container_t container;
207 container_t sourceContainer;
213 typedef struct s_endLink *endLink_t;
214 typedef struct s_endLink {
215 container_t container;
217 container_t destContainer;
222 typedef struct s_newEvent *newEvent_t;
223 typedef struct s_newEvent {
224 container_t container;
229 extern XBT_PRIVATE xbt_dict_t created_categories;
230 extern XBT_PRIVATE xbt_dict_t declared_marks;
231 extern XBT_PRIVATE xbt_dict_t user_host_variables;
232 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
233 extern XBT_PRIVATE xbt_dict_t user_link_variables;
234 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
236 /* instr_paje_header.c */
237 XBT_PRIVATE void TRACE_header(int basic, int size);
240 XBT_PRIVATE void TRACE_init(void);
241 XBT_PRIVATE void TRACE_finalize(void);
242 XBT_PRIVATE void TRACE_paje_init(void);
243 XBT_PRIVATE void TRACE_paje_start(void);
244 XBT_PRIVATE void TRACE_paje_end(void);
245 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
246 XBT_PUBLIC(void) new_pajeDefineContainerType(type_t type);
247 XBT_PUBLIC(void) new_pajeDefineVariableType(type_t type);
248 XBT_PUBLIC(void) new_pajeDefineStateType(type_t type);
249 XBT_PUBLIC(void) new_pajeDefineEventType(type_t type);
250 XBT_PUBLIC(void) new_pajeDefineLinkType(type_t type, type_t source, type_t dest);
251 XBT_PUBLIC(void) new_pajeDefineEntityValue (val_t type);
252 XBT_PUBLIC(void) new_pajeCreateContainer (container_t container);
253 XBT_PUBLIC(void) new_pajeDestroyContainer (container_t container);
254 XBT_PUBLIC(void) new_pajeSetVariable (double timestamp, container_t container, type_t type, double value);
255 XBT_PUBLIC(void) new_pajeAddVariable (double timestamp, container_t container, type_t type, double value);
256 XBT_PUBLIC(void) new_pajeSubVariable (double timestamp, container_t container, type_t type, double value);
257 XBT_PUBLIC(void) new_pajeSetState (double timestamp, container_t container, type_t type, val_t value);
258 XBT_PUBLIC(void) new_pajePushState (double timestamp, container_t container, type_t type, val_t value);
259 XBT_PUBLIC(void) new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value, void* extra);
260 XBT_PUBLIC(void) new_pajePopState (double timestamp, container_t container, type_t type);
261 XBT_PUBLIC(void) new_pajeResetState (double timestamp, container_t container, type_t type);
262 XBT_PUBLIC(void) new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer, const char *value, const char *key);
263 XBT_PUBLIC(void) new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type, container_t sourceContainer, const char *value, const char *key, int size);
264 XBT_PUBLIC(void) new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer, const char *value, const char *key);
265 XBT_PUBLIC(void) new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value);
267 /* from instr_config.c */
268 XBT_PRIVATE int TRACE_needs_platform (void);
269 XBT_PRIVATE int TRACE_is_enabled(void);
270 XBT_PRIVATE int TRACE_platform(void);
271 XBT_PRIVATE int TRACE_platform_topology(void);
272 XBT_PRIVATE int TRACE_is_configured(void);
273 XBT_PRIVATE int TRACE_categorized (void);
274 XBT_PRIVATE int TRACE_uncategorized (void);
275 XBT_PRIVATE int TRACE_msg_process_is_enabled(void);
276 XBT_PRIVATE int TRACE_msg_vm_is_enabled(void);
277 XBT_PRIVATE int TRACE_buffer (void);
278 XBT_PRIVATE int TRACE_disable_link(void);
279 XBT_PRIVATE int TRACE_disable_power(void);
280 XBT_PRIVATE int TRACE_onelink_only (void);
281 XBT_PRIVATE int TRACE_disable_destroy (void);
282 XBT_PRIVATE int TRACE_basic (void);
283 XBT_PRIVATE int TRACE_display_sizes (void);
284 XBT_PRIVATE char *TRACE_get_comment (void);
285 XBT_PRIVATE char *TRACE_get_comment_file (void);
286 XBT_PRIVATE int TRACE_precision (void);
287 XBT_PRIVATE char *TRACE_get_filename(void);
288 XBT_PRIVATE char *TRACE_get_viva_uncat_conf (void);
289 XBT_PRIVATE char *TRACE_get_viva_cat_conf (void);
290 XBT_PRIVATE void TRACE_generate_viva_uncat_conf (void);
291 XBT_PRIVATE void TRACE_generate_viva_cat_conf (void);
292 XBT_PRIVATE void instr_pause_tracing (void);
293 XBT_PRIVATE void instr_resume_tracing (void);
295 /* Public functions used in SMPI */
296 XBT_PUBLIC(int) TRACE_smpi_is_enabled(void);
297 XBT_PUBLIC(int) TRACE_smpi_is_grouped(void);
298 XBT_PUBLIC(int) TRACE_smpi_is_computing(void);
299 XBT_PUBLIC(int) TRACE_smpi_is_sleeping(void);
300 XBT_PUBLIC(int) TRACE_smpi_view_internals(void);
302 /* from resource_utilization.c */
303 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource,
304 const char *category,
308 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,
309 const char *category,
313 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc(void);
316 extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
317 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
318 XBT_PRIVATE long long int instr_new_paje_id (void);
319 XBT_PRIVATE void PJ_container_alloc (void);
320 XBT_PRIVATE void PJ_container_release (void);
321 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
322 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
323 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
324 XBT_PUBLIC(container_t) PJ_container_get_root (void);
325 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
326 XBT_PUBLIC(void) PJ_container_free (container_t container);
327 XBT_PUBLIC(void) PJ_container_free_all (void);
328 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
330 /* instr_paje_types.c */
331 XBT_PRIVATE void PJ_type_alloc (void);
332 XBT_PRIVATE void PJ_type_release (void);
333 XBT_PUBLIC(type_t) PJ_type_get_root (void);
334 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
335 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
336 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
337 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
338 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
339 XBT_PUBLIC(type_t) PJ_type_get (const char *name, const type_t father);
340 XBT_PUBLIC(type_t) PJ_type_get_or_null (const char *name, type_t father);
341 void PJ_type_free_all (void);
342 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
344 /* instr_paje_values.c */
345 XBT_PUBLIC(val_t) PJ_value_new (const char *name, const char *color, type_t father);
346 XBT_PUBLIC(val_t) PJ_value_get_or_new (const char *name, const char *color, type_t father);
347 XBT_PUBLIC(val_t) PJ_value_get (const char *name, const type_t father);
348 XBT_PRIVATE void PJ_value_free (val_t value);
350 XBT_PRIVATE void print_pajeDefineContainerType(paje_event_t event);
351 XBT_PRIVATE void print_pajeDefineVariableType(paje_event_t event);
352 XBT_PRIVATE void print_pajeDefineStateType(paje_event_t event);
353 XBT_PRIVATE void print_pajeDefineEventType(paje_event_t event);
354 XBT_PRIVATE void print_pajeDefineLinkType(paje_event_t event);
355 XBT_PRIVATE void print_pajeDefineEntityValue (paje_event_t event);
356 XBT_PRIVATE void print_pajeCreateContainer(paje_event_t event);
357 XBT_PRIVATE void print_pajeDestroyContainer(paje_event_t event);
358 XBT_PRIVATE void print_pajeSetVariable(paje_event_t event);
359 XBT_PRIVATE void print_pajeAddVariable(paje_event_t event);
360 XBT_PRIVATE void print_pajeSubVariable(paje_event_t event);
361 XBT_PRIVATE void print_pajeSetState(paje_event_t event);
362 XBT_PRIVATE void print_pajePushState(paje_event_t event);
363 XBT_PRIVATE void print_pajePopState(paje_event_t event);
364 XBT_PRIVATE void print_pajeResetState(paje_event_t event);
365 XBT_PRIVATE void print_pajeStartLink(paje_event_t event);
366 XBT_PRIVATE void print_pajeEndLink(paje_event_t event);
367 XBT_PRIVATE void print_pajeNewEvent (paje_event_t event);
369 XBT_PRIVATE void print_TIPushState(paje_event_t event);
370 XBT_PRIVATE void print_TICreateContainer(paje_event_t event);
371 XBT_PRIVATE void print_TIDestroyContainer(paje_event_t event);
372 XBT_PRIVATE void TRACE_TI_start(void);
373 XBT_PRIVATE void TRACE_TI_end(void);
374 XBT_PRIVATE void TRACE_TI_init(void);
376 XBT_PRIVATE void print_NULL (paje_event_t event);
377 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
378 XBT_PRIVATE void dump_comment_file (const char *filename);
379 XBT_PRIVATE void dump_comment (const char *comment);
384 typedef struct instr_trace_writer {
385 void (*print_DefineContainerType) (paje_event_t event);
386 void (*print_DefineVariableType)(paje_event_t event);
387 void (*print_DefineStateType)(paje_event_t event);
388 void (*print_DefineEventType)(paje_event_t event);
389 void (*print_DefineLinkType)(paje_event_t event);
390 void (*print_DefineEntityValue)(paje_event_t event);
391 void (*print_CreateContainer)(paje_event_t event);
392 void (*print_DestroyContainer)(paje_event_t event);
393 void (*print_SetVariable)(paje_event_t event);
394 void (*print_AddVariable)(paje_event_t event);
395 void (*print_SubVariable)(paje_event_t event);
396 void (*print_SetState)(paje_event_t event);
397 void (*print_PushState)(paje_event_t event);
398 void (*print_PopState)(paje_event_t event);
399 void (*print_ResetState)(paje_event_t event);
400 void (*print_StartLink)(paje_event_t event);
401 void (*print_EndLink)(paje_event_t event);
402 void (*print_NewEvent) (paje_event_t event);
403 } s_instr_trace_writer_t;
407 struct s_instr_extra_data;
408 typedef struct s_instr_extra_data *instr_extra_data;
440 TRACING_REDUCE_SCATTER,
449 typedef struct s_instr_extra_data {
454 double sleep_duration;
458 const char* datatype1;
459 const char* datatype2;
463 } s_instr_extra_data_t;
468 #include "instr/jedule/jedule_sd_binding.h"
471 #endif /* INSTR_PRIVATE_H_ */