Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix conflict
[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   val_t ret;
85   s_val(const char *name, const char *color, type_t father);
86   val_t PJ_value_update (const char *name, const char *color, type_t father);
87 };
88
89
90 //--------------------------------------------------
91 typedef enum {
92   INSTR_HOST,
93   INSTR_LINK,
94   INSTR_ROUTER,
95   INSTR_AS,
96   INSTR_SMPI,
97   INSTR_MSG_VM,
98   INSTR_MSG_PROCESS,
99   INSTR_MSG_TASK
100 } e_container_types;
101
102 //--------------------------------------------------
103 class s_container;
104 typedef s_container *container_t;
105
106 class s_container {
107   public:
108   sg_netpoint_t netpoint;
109   char *name;     /* Unique name of this container */
110   char *id;       /* Unique id of this container */
111   type_t type;    /* Type of this container */
112   int level;      /* Level in the hierarchy, root level is 0 */
113   e_container_types kind; /* This container is of what kind */
114   s_container *father;
115   xbt_dict_t children;
116 };
117 typedef s_container s_container_t;
118
119 //--------------------------------------------------
120 class PajeEvent {
121   public:
122   double timestamp;
123   e_event_type event_type;
124   virtual void print() = 0;
125   void *data;
126   virtual ~PajeEvent();
127 };
128
129 //--------------------------------------------------
130
131 class DefineVariableTypeEvent : public PajeEvent
132 {
133   public:
134   type_t type;
135    DefineVariableTypeEvent(type_t type);
136    void print() override;
137 };
138 //--------------------------------------------------
139
140 class DefineStateTypeEvent : public PajeEvent  {
141   type_t type;
142   public:
143   DefineStateTypeEvent(type_t type);
144   void print() override;
145 };
146
147
148 class SetVariableEvent : public PajeEvent  {
149   container_t container;
150   type_t type;
151   double value;
152   public:
153   SetVariableEvent (double timestamp, container_t container, type_t type, double value);
154   void print() override;
155 };
156
157
158 class AddVariableEvent:public PajeEvent {
159   container_t container;
160   type_t type;
161   double value;
162   public:
163   AddVariableEvent (double timestamp, container_t container, type_t type, double value);
164   void print() override;
165 };
166
167 //--------------------------------------------------
168
169
170 class SubVariableEvent : public PajeEvent  {
171   public:
172   container_t container;
173   type_t type;
174   double value;
175   public:
176   SubVariableEvent(double timestamp, container_t container, type_t type, double value);
177   void print() override;
178 };
179 //--------------------------------------------------
180
181 class SetStateEvent : public PajeEvent  {
182   public:
183   container_t container;
184   type_t type;
185   val_t value;
186   const char* filename;
187   int linenumber;
188   public:
189   SetStateEvent (double timestamp, container_t container, type_t type, val_t value);
190   void print() override;
191 };
192
193
194 class PushStateEvent : public PajeEvent  {
195   public:
196   container_t container;
197   type_t type;
198   val_t value;
199   int size;
200   const char* filename;
201   int linenumber;
202   void* extra_;
203   public:
204   PushStateEvent (double timestamp, container_t container, type_t type, val_t value);
205   PushStateEvent (double timestamp, container_t container, type_t type, val_t value,
206                                              void* extra);
207   void print() override;
208 };
209
210 class PopStateEvent : public PajeEvent  {
211   container_t container;
212   type_t type;
213   public:
214   PopStateEvent (double timestamp, container_t container, type_t type);
215   void print() override;
216 };
217
218 class ResetStateEvent : public PajeEvent  {
219   container_t container;
220   type_t type;
221   public:
222   ResetStateEvent (double timestamp, container_t container, type_t type);
223   void print() override;
224 };
225
226 class StartLinkEvent : public PajeEvent  {
227   public:
228   container_t container;
229   type_t type;
230   container_t sourceContainer;
231   char *value;
232   char *key;
233   int size;
234   public:
235     ~StartLinkEvent();
236     StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
237                    const char* key);
238     StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
239                    const char* key, int size);
240     void print() override;
241 };
242
243 class EndLinkEvent : public PajeEvent  {
244   container_t container;
245   type_t type;
246   container_t destContainer;
247   char *value;
248   char *key;
249   public:
250   EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
251                                   const char *value, const char *key);
252   ~EndLinkEvent();
253   void print() override;
254 };
255
256
257 class NewEvent : public PajeEvent  {
258   public:
259   container_t container;
260   type_t type;
261   val_t value;
262   public:
263   NewEvent (double timestamp, container_t container, type_t type, val_t value);
264   void print() override;
265
266 };
267
268 class paje_value{
269   public:
270   paje_value(){};
271   ~paje_value(){};
272   val_t PJ_value_new (const char *name, const char *color, type_t father);
273   val_t PJ_value_get (const char *name, type_t father);
274   val_t PJ_value_get_or_new (const char *name, const char *color, type_t father);
275 };
276
277 extern XBT_PRIVATE xbt_dict_t created_categories;
278 extern XBT_PRIVATE xbt_dict_t declared_marks;
279 extern XBT_PRIVATE xbt_dict_t user_host_variables;
280 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
281 extern XBT_PRIVATE xbt_dict_t user_link_variables;
282 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
283
284 /* instr_paje_header.c */
285 XBT_PRIVATE void TRACE_header(int basic, int size);
286
287 /* from paje.c */
288 XBT_PRIVATE void TRACE_paje_start();
289 XBT_PRIVATE void TRACE_paje_end();
290 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
291
292
293 /* from instr_config.c */
294 XBT_PRIVATE bool TRACE_needs_platform ();
295 XBT_PRIVATE bool TRACE_is_enabled();
296 XBT_PRIVATE bool TRACE_platform();
297 XBT_PRIVATE bool TRACE_platform_topology();
298 XBT_PRIVATE bool TRACE_is_configured();
299 XBT_PRIVATE bool TRACE_categorized ();
300 XBT_PRIVATE bool TRACE_uncategorized ();
301 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
302 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
303 XBT_PRIVATE bool TRACE_buffer ();
304 XBT_PRIVATE bool TRACE_disable_link();
305 XBT_PRIVATE bool TRACE_disable_speed();
306 XBT_PRIVATE bool TRACE_onelink_only ();
307 XBT_PRIVATE bool TRACE_disable_destroy ();
308 XBT_PRIVATE bool TRACE_basic ();
309 XBT_PRIVATE bool TRACE_display_sizes ();
310 XBT_PRIVATE char *TRACE_get_comment ();
311 XBT_PRIVATE char *TRACE_get_comment_file ();
312 XBT_PRIVATE int TRACE_precision ();
313 XBT_PRIVATE char *TRACE_get_filename();
314 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
315 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
316 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
317 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
318 XBT_PRIVATE void instr_pause_tracing ();
319 XBT_PRIVATE void instr_resume_tracing ();
320
321 /* Public functions used in SMPI */
322 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
323 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
324 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
325 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
326 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
327
328 /* from resource_utilization.c */
329 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
330                                      double delta);
331 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
332                                      double delta);
333 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
334
335 /* instr_paje.c */
336 extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
337 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
338 XBT_PRIVATE long long int instr_new_paje_id ();
339 XBT_PRIVATE void PJ_container_alloc ();
340 XBT_PRIVATE void PJ_container_release ();
341 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
342 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
343 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
344 XBT_PUBLIC(container_t) PJ_container_get_root ();
345 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
346 XBT_PUBLIC(void) PJ_container_free (container_t container);
347 XBT_PUBLIC(void) PJ_container_free_all (void);
348 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
349
350 /* instr_paje_types.c */
351 XBT_PRIVATE void PJ_type_release ();
352 XBT_PUBLIC(type_t)  PJ_type_get_root ();
353 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
354 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
355 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
356 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
357 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
358 XBT_PUBLIC(type_t)  PJ_type_get (const char *name, const type_t father);
359 XBT_PUBLIC(type_t)  PJ_type_get_or_null (const char *name, type_t father);
360 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type); 
361
362 /* instr_config.c */
363 XBT_PRIVATE void recursiveDestroyType (type_t type);
364
365 /* instr_paje_values.c */
366 XBT_PUBLIC(val_t)  PJ_value_get_or_new (const char *name, const char *color, type_t father);
367 XBT_PUBLIC(val_t)  PJ_value_get (const char *name, const type_t father);
368
369 XBT_PRIVATE void TRACE_TI_start();
370 XBT_PRIVATE void TRACE_TI_end();
371
372 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
373 XBT_PRIVATE void dump_comment_file (const char *filename);
374 XBT_PRIVATE void dump_comment (const char *comment);
375
376 struct s_instr_extra_data;
377 typedef struct s_instr_extra_data *instr_extra_data;
378
379 typedef enum{
380   TRACING_INIT,
381   TRACING_FINALIZE,
382   TRACING_COMM_SIZE,
383   TRACING_COMM_SPLIT,
384   TRACING_COMM_DUP,
385   TRACING_SEND,
386   TRACING_ISEND,
387   TRACING_SSEND,
388   TRACING_ISSEND,
389   TRACING_RECV,
390   TRACING_IRECV,
391   TRACING_SENDRECV,
392   TRACING_TEST,
393   TRACING_WAIT,
394   TRACING_WAITALL,
395   TRACING_WAITANY,
396   TRACING_BARRIER,
397   TRACING_BCAST,
398   TRACING_REDUCE,
399   TRACING_ALLREDUCE,
400   TRACING_ALLTOALL,
401   TRACING_ALLTOALLV,
402   TRACING_GATHER,
403   TRACING_GATHERV,
404   TRACING_SCATTER,
405   TRACING_SCATTERV,
406   TRACING_ALLGATHER,
407   TRACING_ALLGATHERV,
408   TRACING_REDUCE_SCATTER,
409   TRACING_COMPUTING,
410   TRACING_SLEEPING,
411   TRACING_SCAN,
412   TRACING_EXSCAN
413 } e_caller_type ;
414
415 typedef struct s_instr_extra_data {
416   e_caller_type type;
417   int send_size;
418   int recv_size;
419   double comp_size;
420   double sleep_duration;
421   int src;
422   int dst;
423   int root;
424   const char* datatype1;
425   const char* datatype2;
426   int * sendcounts;
427   int * recvcounts;
428   int num_processes;
429 } s_instr_extra_data_t;
430
431 /* Format of TRACING output.
432  *   - paje is the regular format, that we all know
433  *   - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such trace can easily be replayed with smpi_replay afterward.
434  *     This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
435  */
436 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
437 extern instr_fmt_type_t instr_fmt_type;
438
439 SG_END_DECL()
440
441 void DefineContainerEvent(type_t type);
442 void LogVariableTypeDefinition(type_t type);
443 void LogStateTypeDefinition(type_t type);
444 void LogLinkTypeDefinition(type_t type, type_t source, type_t dest);
445 void LogEntityValue (val_t value);
446 void LogContainerCreation (container_t container);
447 void LogContainerDestruction (container_t container);
448 void LogDefineEventType(type_t type);
449
450 #endif