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