Logo AND Algorithmique Numérique Distribuée

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