Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add FIXME.
[simgrid.git] / src / instr / instr_private.h
1 /* Copyright (c) 2010-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef INSTR_PRIVATE_H_
8 #define INSTR_PRIVATE_H_
9
10 #include "instr/instr.h"
11 #include "instr/instr_interface.h"
12 #include "internal_config.h"
13 #include "simgrid_config.h"
14
15 #ifdef HAVE_TRACING
16
17 SG_BEGIN_DECL()
18
19 /* Need to define function drand48 for Windows */
20 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
21 #ifdef _WIN32
22 #  define drand48() (rand()/(RAND_MAX + 1.0))
23 #endif
24
25 #define INSTR_DEFAULT_STR_SIZE 500
26
27 #include "xbt/graph.h"
28 #include "xbt/dict.h"
29 #include "simgrid/platf.h"
30
31 typedef enum {
32   PAJE_DefineContainerType,
33   PAJE_DefineVariableType,
34   PAJE_DefineStateType,
35   PAJE_DefineEventType,
36   PAJE_DefineLinkType,
37   PAJE_DefineEntityValue,
38   PAJE_CreateContainer,
39   PAJE_DestroyContainer,
40   PAJE_SetVariable,
41   PAJE_AddVariable,
42   PAJE_SubVariable,
43   PAJE_SetState,
44   PAJE_PushState,
45   PAJE_PopState,
46   PAJE_ResetState,
47   PAJE_StartLink,
48   PAJE_EndLink,
49   PAJE_NewEvent
50 } e_event_type;
51
52 typedef enum {
53   TYPE_VARIABLE,
54   TYPE_LINK,
55   TYPE_CONTAINER,
56   TYPE_STATE,
57   TYPE_EVENT
58 } e_entity_types;
59
60 typedef struct s_type *type_t;
61 typedef struct s_type {
62   char *id;
63   char *name;
64   char *color;
65   e_entity_types kind;
66   struct s_type *father;
67   xbt_dict_t children;
68   xbt_dict_t values; //valid for all types except variable and container
69 }s_type_t;
70
71 typedef struct s_val *val_t;
72 typedef struct s_val {
73   char *id;
74   char *name;
75   char *color;
76   type_t father;
77 }s_val_t;
78
79 typedef enum {
80   INSTR_HOST,
81   INSTR_LINK,
82   INSTR_ROUTER,
83   INSTR_AS,
84   INSTR_SMPI,
85   INSTR_MSG_VM,
86   INSTR_MSG_PROCESS,
87   INSTR_MSG_TASK
88 } e_container_types;
89
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;
99   xbt_dict_t children;
100 }s_container_t;
101
102 typedef struct paje_event *paje_event_t;
103 typedef struct paje_event {
104   double timestamp;
105   e_event_type event_type;
106   void (*print) (paje_event_t event);
107   void (*free) (paje_event_t event);
108   void *data;
109 } s_paje_event_t;
110
111 typedef struct s_defineContainerType *defineContainerType_t;
112 typedef struct s_defineContainerType {
113   type_t type;
114 }s_defineContainerType_t;
115
116 typedef struct s_defineVariableType *defineVariableType_t;
117 typedef struct s_defineVariableType {
118   type_t type;
119 }s_defineVariableType_t;
120
121 typedef struct s_defineStateType *defineStateType_t;
122 typedef struct s_defineStateType {
123   type_t type;
124 }s_defineStateType_t;
125
126 typedef struct s_defineEventType *defineEventType_t;
127 typedef struct s_defineEventType {
128   type_t type;
129 }s_defineEventType_t;
130
131 typedef struct s_defineLinkType *defineLinkType_t;
132 typedef struct s_defineLinkType {
133   type_t type;
134   type_t source;
135   type_t dest;
136 }s_defineLinkType_t;
137
138 typedef struct s_defineEntityValue *defineEntityValue_t;
139 typedef struct s_defineEntityValue {
140   val_t value;
141 }s_defineEntityValue_t;
142
143 typedef struct s_createContainer *createContainer_t;
144 typedef struct s_createContainer {
145   container_t container;
146 }s_createContainer_t;
147
148 typedef struct s_destroyContainer *destroyContainer_t;
149 typedef struct s_destroyContainer {
150   container_t container;
151 }s_destroyContainer_t;
152
153 typedef struct s_setVariable *setVariable_t;
154 typedef struct s_setVariable {
155   container_t container;
156   type_t type;
157   double value;
158 }s_setVariable_t;
159
160 typedef struct s_addVariable *addVariable_t;
161 typedef struct s_addVariable {
162   container_t container;
163   type_t type;
164   double value;
165 }s_addVariable_t;
166
167 typedef struct s_subVariable *subVariable_t;
168 typedef struct s_subVariable {
169   container_t container;
170   type_t type;
171   double value;
172 }s_subVariable_t;
173
174 typedef struct s_setState *setState_t;
175 typedef struct s_setState {
176   container_t container;
177   type_t type;
178   val_t value;
179 }s_setState_t;
180
181 typedef struct s_pushState *pushState_t;
182 typedef struct s_pushState {
183   container_t container;
184   type_t type;
185   val_t value;
186   int size;
187   void* extra;
188 }s_pushState_t;
189
190 typedef struct s_popState *popState_t;
191 typedef struct s_popState {
192   container_t container;
193   type_t type;
194   xbt_dynar_t extra;
195 }s_popState_t;
196
197 typedef struct s_resetState *resetState_t;
198 typedef struct s_resetState {
199   container_t container;
200   type_t type;
201 }s_resetState_t;
202
203 typedef struct s_startLink *startLink_t;
204 typedef struct s_startLink {
205   container_t container;
206   type_t type;
207   container_t sourceContainer;
208   char *value;
209   char *key;
210   int size;
211 }s_startLink_t;
212
213 typedef struct s_endLink *endLink_t;
214 typedef struct s_endLink {
215   container_t container;
216   type_t type;
217   container_t destContainer;
218   char *value;
219   char *key;
220 }s_endLink_t;
221
222 typedef struct s_newEvent *newEvent_t;
223 typedef struct s_newEvent {
224   container_t container;
225   type_t type;
226   val_t value;
227 }s_newEvent_t;
228
229 extern xbt_dict_t created_categories;
230 extern xbt_dict_t declared_marks;
231 extern xbt_dict_t user_host_variables;
232 extern xbt_dict_t user_vm_variables;
233 extern xbt_dict_t user_link_variables;
234 extern double TRACE_last_timestamp_to_dump;
235
236 /* instr_paje_header.c */
237 void TRACE_header(int basic, int size);
238
239 /* from paje.c */
240 void TRACE_init(void);
241 void TRACE_finalize(void);
242 void TRACE_paje_init(void);
243 void TRACE_paje_start(void);
244 void TRACE_paje_end(void);
245 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);
266
267 //for tracing gtnets
268 void TRACE_surf_gtnets_communicate(void *action, void *src, void *dst);
269
270 /* from instr_config.c */
271 int TRACE_needs_platform (void);
272 int TRACE_is_enabled(void);
273 int TRACE_platform(void);
274 int TRACE_platform_topology(void);
275 int TRACE_is_configured(void);
276 int TRACE_categorized (void);
277 int TRACE_uncategorized (void);
278 int TRACE_msg_process_is_enabled(void);
279 int TRACE_msg_vm_is_enabled(void);
280 int TRACE_buffer (void);
281 int TRACE_disable_link(void);
282 int TRACE_disable_power(void);
283 int TRACE_onelink_only (void);
284 int TRACE_disable_destroy (void);
285 int TRACE_basic (void);
286 int TRACE_display_sizes (void);
287 char *TRACE_get_comment (void);
288 char *TRACE_get_comment_file (void);
289 char *TRACE_get_filename(void);
290 char *TRACE_get_viva_uncat_conf (void);
291 char *TRACE_get_viva_cat_conf (void);
292 void TRACE_generate_viva_uncat_conf (void);
293 void TRACE_generate_viva_cat_conf (void);
294 void instr_pause_tracing (void);
295 void instr_resume_tracing (void);
296
297 /* Public functions used in SMPI */
298 XBT_PUBLIC(int) TRACE_smpi_is_enabled(void);
299 XBT_PUBLIC(int) TRACE_smpi_is_grouped(void);
300 XBT_PUBLIC(int) TRACE_smpi_is_computing(void);
301 XBT_PUBLIC(int) TRACE_smpi_is_sleeping(void);
302 XBT_PUBLIC(int) TRACE_smpi_view_internals(void);
303
304 /* from resource_utilization.c */
305 void TRACE_surf_host_set_utilization(const char *resource,
306                                      const char *category,
307                                      double value,
308                                      double now,
309                                      double delta);
310 void TRACE_surf_link_set_utilization(const char *resource,
311                                      const char *category,
312                                      double value,
313                                      double now,
314                                      double delta);
315 void TRACE_surf_resource_utilization_alloc(void);
316
317 /* instr_paje.c */
318 extern xbt_dict_t trivaNodeTypes;
319 extern xbt_dict_t trivaEdgeTypes;
320 long long int instr_new_paje_id (void);
321 void PJ_container_alloc (void);
322 void PJ_container_release (void);
323 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
324 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
325 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
326 XBT_PUBLIC(container_t) PJ_container_get_root (void);
327 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
328 XBT_PUBLIC(void) PJ_container_free (container_t container);
329 XBT_PUBLIC(void) PJ_container_free_all (void);
330 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
331
332 /* instr_paje_types.c */
333 void PJ_type_alloc (void);
334 void PJ_type_release (void);
335 XBT_PUBLIC(type_t)  PJ_type_get_root (void);
336 type_t PJ_type_container_new (const char *name, type_t father);
337 type_t PJ_type_event_new (const char *name, type_t father);
338 type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
339 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
340 type_t PJ_type_state_new (const char *name, type_t father);
341 XBT_PUBLIC(type_t)  PJ_type_get (const char *name, const type_t father);
342 XBT_PUBLIC(type_t)  PJ_type_get_or_null (const char *name, type_t father);
343 void PJ_type_free (type_t type);
344 void PJ_type_free_all (void);
345
346 /* instr_paje_values.c */
347 XBT_PUBLIC(val_t)  PJ_value_new (const char *name, const char *color, type_t father);
348 XBT_PUBLIC(val_t)  PJ_value_get_or_new (const char *name, const char *color, type_t father);
349 XBT_PUBLIC(val_t)  PJ_value_get (const char *name, const type_t father);
350 void PJ_value_free (val_t value);
351
352 void print_pajeDefineContainerType(paje_event_t event);
353 void print_pajeDefineVariableType(paje_event_t event);
354 void print_pajeDefineStateType(paje_event_t event);
355 void print_pajeDefineEventType(paje_event_t event);
356 void print_pajeDefineLinkType(paje_event_t event);
357 void print_pajeDefineEntityValue (paje_event_t event);
358 void print_pajeCreateContainer(paje_event_t event);
359 void print_pajeDestroyContainer(paje_event_t event);
360 void print_pajeSetVariable(paje_event_t event);
361 void print_pajeAddVariable(paje_event_t event);
362 void print_pajeSubVariable(paje_event_t event);
363 void print_pajeSetState(paje_event_t event);
364 void print_pajePushState(paje_event_t event);
365 void print_pajePopState(paje_event_t event);
366 void print_pajeResetState(paje_event_t event);
367 void print_pajeStartLink(paje_event_t event);
368 void print_pajeEndLink(paje_event_t event);
369 void print_pajeNewEvent (paje_event_t event);
370
371 void print_TIPushState(paje_event_t event);
372 void print_TICreateContainer(paje_event_t event);
373 void print_TIDestroyContainer(paje_event_t event);
374 void TRACE_TI_start(void);
375 void TRACE_TI_end(void);
376 void TRACE_TI_init(void);
377
378 void print_NULL (paje_event_t event);
379 void TRACE_paje_dump_buffer (int force);
380 void dump_comment_file (const char *filename);
381 void dump_comment (const char *comment);
382
383
384
385
386 typedef struct instr_trace_writer {
387   void (*print_DefineContainerType) (paje_event_t event);
388   void (*print_DefineVariableType)(paje_event_t event);
389   void (*print_DefineStateType)(paje_event_t event);
390   void (*print_DefineEventType)(paje_event_t event);
391   void (*print_DefineLinkType)(paje_event_t event);
392   void (*print_DefineEntityValue)(paje_event_t event);
393   void (*print_CreateContainer)(paje_event_t event);
394   void (*print_DestroyContainer)(paje_event_t event);
395   void (*print_SetVariable)(paje_event_t event);
396   void (*print_AddVariable)(paje_event_t event);
397   void (*print_SubVariable)(paje_event_t event);
398   void (*print_SetState)(paje_event_t event);
399   void (*print_PushState)(paje_event_t event);
400   void (*print_PopState)(paje_event_t event);
401   void (*print_ResetState)(paje_event_t event);
402   void (*print_StartLink)(paje_event_t event);
403   void (*print_EndLink)(paje_event_t event);
404   void (*print_NewEvent) (paje_event_t event);
405 } s_instr_trace_writer_t;
406
407
408
409 struct s_instr_extra_data;
410 typedef struct s_instr_extra_data *instr_extra_data;
411
412
413 typedef enum{
414   TRACING_INIT,
415   TRACING_FINALIZE,
416   TRACING_COMM_SIZE,
417   TRACING_COMM_SPLIT,
418   TRACING_COMM_DUP,
419   TRACING_SEND,
420   TRACING_ISEND,
421   TRACING_SSEND,
422   TRACING_ISSEND,
423   TRACING_RECV,
424   TRACING_IRECV,
425   TRACING_SENDRECV,
426   TRACING_TEST,
427   TRACING_WAIT,
428   TRACING_WAITALL,
429   TRACING_WAITANY,
430   TRACING_BARRIER,
431   TRACING_BCAST,
432   TRACING_REDUCE,
433   TRACING_ALLREDUCE,
434   TRACING_ALLTOALL,
435   TRACING_ALLTOALLV,
436   TRACING_GATHER,
437   TRACING_GATHERV,
438   TRACING_SCATTER,
439   TRACING_SCATTERV,
440   TRACING_ALLGATHER,
441   TRACING_ALLGATHERV,
442   TRACING_REDUCE_SCATTER,
443   TRACING_COMPUTING,
444   TRACING_SLEEPING,
445   TRACING_SCAN,
446   TRACING_EXSCAN
447 } e_caller_type ;
448
449
450
451 typedef struct s_instr_extra_data {
452   e_caller_type type;
453   int send_size;
454   int recv_size;
455   double comp_size;
456   double sleep_duration;
457   int src;
458   int dst;
459   int root;
460   const char* datatype1;
461   const char* datatype2;
462   int * sendcounts;
463   int * recvcounts;
464   int num_processes;
465 } s_instr_extra_data_t;
466
467 SG_END_DECL()
468
469 #endif /* HAVE_TRACING */
470
471 #ifdef HAVE_JEDULE
472 #include "instr/jedule/jedule_sd_binding.h"
473 #endif
474
475 #endif /* INSTR_PRIVATE_H_ */