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 typedef struct s_type *type_t;
  59 typedef struct s_type {
  60   char *id;
  61   char *name;
  62   char *color;
  63   e_entity_types kind;
  64   struct s_type *father;
  65   xbt_dict_t children;
  66   xbt_dict_t values; //valid for all types except variable and container
  67 }s_type_t;
  68
  69 //--------------------------------------------------
  70 class s_val;
  71 typedef s_val *val_t;
  72
  73 class s_val {
  74   public:
  75   char *id;
  76   char *name;
  77   char *color;
  78   type_t father;
  79 };
  80 typedef s_val s_val_t;
  81
  82 //--------------------------------------------------
  83 typedef enum {
  84   INSTR_HOST,
  85   INSTR_LINK,
  86   INSTR_ROUTER,
  87   INSTR_AS,
  88   INSTR_SMPI,
  89   INSTR_MSG_VM,
  90   INSTR_MSG_PROCESS,
  91   INSTR_MSG_TASK
  92 } e_container_types;
  93
  94 //--------------------------------------------------
  95 class s_container;
  96 typedef s_container *container_t;
  97
  98 class s_container {
  99   public:
 100   sg_netpoint_t netpoint;
 101   char *name;     /* Unique name of this container */
 102   char *id;       /* Unique id of this container */
 103   type_t type;    /* Type of this container */
 104   int level;      /* Level in the hierarchy, root level is 0 */
 105   e_container_types kind; /* This container is of what kind */
 106   s_container *father;
 107   xbt_dict_t children;
 108 };
 109 typedef s_container s_container_t;
 110
 111 //--------------------------------------------------
 112 class paje_event;
 113 typedef paje_event *paje_event_t;
 114
 115 class paje_event {
 116   public:
 117   double timestamp;
 118   e_event_type event_type;
 119   void (*print) (paje_event_t event);
 120   void (*free) (paje_event_t event);
 121   void *data;
 122 };
 123 typedef paje_event s_paje_event_t;
 124 //--------------------------------------------------
 125
 126 typedef struct s_defineContainerType *defineContainerType_t;
 127 typedef struct s_defineContainerType {
 128   type_t type;
 129 }s_defineContainerType_t;
 130
 131 typedef struct s_defineVariableType *defineVariableType_t;
 132 typedef struct s_defineVariableType {
 133   type_t type;
 134 }s_defineVariableType_t;
 135
 136 typedef struct s_defineStateType *defineStateType_t;
 137 typedef struct s_defineStateType {
 138   type_t type;
 139 }s_defineStateType_t;
 140
 141 typedef struct s_defineEventType *defineEventType_t;
 142 typedef struct s_defineEventType {
 143   type_t type;
 144 }s_defineEventType_t;
 145
 146 typedef struct s_defineLinkType *defineLinkType_t;
 147 typedef struct s_defineLinkType {
 148   type_t type;
 149   type_t source;
 150   type_t dest;
 151 }s_defineLinkType_t;
 152
 153 typedef struct s_defineEntityValue *defineEntityValue_t;
 154 typedef struct s_defineEntityValue {
 155   val_t value;
 156 }s_defineEntityValue_t;
 157
 158 typedef struct s_createContainer *createContainer_t;
 159 typedef struct s_createContainer {
 160   container_t container;
 161 }s_createContainer_t;
 162
 163 typedef struct s_destroyContainer *destroyContainer_t;
 164 typedef struct s_destroyContainer {
 165   container_t container;
 166 }s_destroyContainer_t;
 167
 168 typedef struct s_setVariable *setVariable_t;
 169 typedef struct s_setVariable {
 170   container_t container;
 171   type_t type;
 172   double value;
 173 }s_setVariable_t;
 174
 175 typedef struct s_addVariable *addVariable_t;
 176 typedef struct s_addVariable {
 177   container_t container;
 178   type_t type;
 179   double value;
 180 }s_addVariable_t;
 181
 182 //--------------------------------------------------
 183 class s_subVariable;
 184
 185 typedef s_subVariable *subVariable_t;
 186
 187 class s_subVariable {
 188   public:
 189   container_t container;
 190   type_t type;
 191   double value;
 192   //methods
 193   XBT_PUBLIC(void) new_pajeSubVariable (double timestamp, container_t container, type_t type, double value);
 194 };
 195 typedef s_subVariable s_subVariable_t;
 196 //--------------------------------------------------
 197
 198 class s_setState;
 199
 200 typedef s_setState *setState_t;
 201 class s_setState {
 202   public:
 203   container_t container;
 204   type_t type;
 205   val_t value;
 206   const char* filename;
 207   int linenumber;
 208 };
 209
 210 typedef s_setState s_setState_t;
 211
 212 class s_pushState;
 213
 214 typedef s_pushState *pushState_t;
 215 class s_pushState {
 216   public:
 217   container_t container;
 218   type_t type;
 219   val_t value;
 220   int size;
 221   const char* filename;
 222   int linenumber;
 223   void* extra;
 224 };
 225
 226 typedef s_pushState s_pushState_t;
 227
 228 typedef struct s_popState *popState_t;
 229 typedef struct s_popState {
 230   container_t container;
 231   type_t type;
 232   xbt_dynar_t extra;
 233 }s_popState_t;
 234
 235 typedef struct s_resetState *resetState_t;
 236 typedef struct s_resetState {
 237   container_t container;
 238   type_t type;
 239 }s_resetState_t;
 240
 241 typedef struct s_startLink *startLink_t;
 242 typedef struct s_startLink {
 243   container_t container;
 244   type_t type;
 245   container_t sourceContainer;
 246   char *value;
 247   char *key;
 248   int size;
 249 }s_startLink_t;
 250
 251 typedef struct s_endLink *endLink_t;
 252 typedef struct s_endLink {
 253   container_t container;
 254   type_t type;
 255   container_t destContainer;
 256   char *value;
 257   char *key;
 258 }s_endLink_t;
 259
 260 class s_newEvent;
 261
 262 typedef s_newEvent *newEvent_t;
 263
 264 class s_newEvent {
 265   public:
 266   container_t container;
 267   type_t type;
 268   val_t value;
 269 };
 270
 271 typedef s_newEvent s_newEvent_t;
 272
 273 extern XBT_PRIVATE xbt_dict_t created_categories;
 274 extern XBT_PRIVATE xbt_dict_t declared_marks;
 275 extern XBT_PRIVATE xbt_dict_t user_host_variables;
 276 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
 277 extern XBT_PRIVATE xbt_dict_t user_link_variables;
 278 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 279
 280 /* instr_paje_header.c */
 281 XBT_PRIVATE void TRACE_header(int basic, int size);
 282
 283 /* from paje.c */
 284 XBT_PRIVATE void TRACE_paje_init();
 285 XBT_PRIVATE void TRACE_paje_start();
 286 XBT_PRIVATE void TRACE_paje_end();
 287 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 288 XBT_PUBLIC(void) new_pajeDefineContainerType(type_t type);
 289 XBT_PUBLIC(void) new_pajeDefineVariableType(type_t type);
 290 XBT_PUBLIC(void) new_pajeDefineStateType(type_t type);
 291 XBT_PUBLIC(void) new_pajeDefineEventType(type_t type);
 292 XBT_PUBLIC(void) new_pajeDefineLinkType(type_t type, type_t source, type_t dest);
 293 XBT_PUBLIC(void) new_pajeDefineEntityValue (val_t type);
 294
 295 // Container
 296 XBT_PUBLIC(void) new_pajeCreateContainer (container_t container);
 297 XBT_PUBLIC(void) new_pajeDestroyContainer (container_t container);
 298
 299 XBT_PUBLIC(void) new_pajeSetVariable (double timestamp, container_t container, type_t type, double value);
 300 XBT_PUBLIC(void) new_pajeAddVariable (double timestamp, container_t container, type_t type, double value);
 301
 302
 303 XBT_PUBLIC(void) new_pajeSetState (double timestamp, container_t container, type_t type, val_t value);
 304 XBT_PUBLIC(void) new_pajePushState (double timestamp, container_t container, type_t type, val_t value);
 305 XBT_PUBLIC(void) new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value,
 306                                              void* extra);
 307 XBT_PUBLIC(void) new_pajePopState (double timestamp, container_t container, type_t type);
 308 XBT_PUBLIC(void) new_pajeResetState (double timestamp, container_t container, type_t type);
 309 XBT_PUBLIC(void) new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer,
 310                                     const char *value, const char *key);
 311 XBT_PUBLIC(void) new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type,
 312                                             container_t sourceContainer, const char *value, const char *key, int size);
 313 XBT_PUBLIC(void) new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
 314                                   const char *value, const char *key);
 315 XBT_PUBLIC(void) new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value);
 316
 317 /* from instr_config.c */
 318 XBT_PRIVATE bool TRACE_needs_platform ();
 319 XBT_PRIVATE bool TRACE_is_enabled();
 320 XBT_PRIVATE bool TRACE_platform();
 321 XBT_PRIVATE bool TRACE_platform_topology();
 322 XBT_PRIVATE bool TRACE_is_configured();
 323 XBT_PRIVATE bool TRACE_categorized ();
 324 XBT_PRIVATE bool TRACE_uncategorized ();
 325 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
 326 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
 327 XBT_PRIVATE bool TRACE_buffer ();
 328 XBT_PRIVATE bool TRACE_disable_link();
 329 XBT_PRIVATE bool TRACE_disable_speed();
 330 XBT_PRIVATE bool TRACE_onelink_only ();
 331 XBT_PRIVATE bool TRACE_disable_destroy ();
 332 XBT_PRIVATE bool TRACE_basic ();
 333 XBT_PRIVATE bool TRACE_display_sizes ();
 334 XBT_PRIVATE char *TRACE_get_comment ();
 335 XBT_PRIVATE char *TRACE_get_comment_file ();
 336 XBT_PRIVATE int TRACE_precision ();
 337 XBT_PRIVATE char *TRACE_get_filename();
 338 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
 339 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
 340 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
 341 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
 342 XBT_PRIVATE void instr_pause_tracing ();
 343 XBT_PRIVATE void instr_resume_tracing ();
 344
 345 /* Public functions used in SMPI */
 346 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
 347 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
 348 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
 349 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
 350 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
 351
 352 /* from resource_utilization.c */
 353 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
 354                                      double delta);
 355 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
 356                                      double delta);
 357 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
 358
 359 /* instr_paje.c */
 360 extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
 361 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
 362 XBT_PRIVATE long long int instr_new_paje_id ();
 363 XBT_PRIVATE void PJ_container_alloc ();
 364 XBT_PRIVATE void PJ_container_release ();
 365 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
 366 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
 367 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
 368 XBT_PUBLIC(container_t) PJ_container_get_root ();
 369 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
 370 XBT_PUBLIC(void) PJ_container_free (container_t container);
 371 XBT_PUBLIC(void) PJ_container_free_all (void);
 372 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
 373
 374 /* instr_paje_types.c */
 375 XBT_PRIVATE void PJ_type_alloc ();
 376 XBT_PRIVATE void PJ_type_release ();
 377 XBT_PUBLIC(type_t)  PJ_type_get_root ();
 378 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
 379 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
 380 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
 381 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
 382 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
 383 XBT_PUBLIC(type_t)  PJ_type_get (const char *name, const type_t father);
 384 XBT_PUBLIC(type_t)  PJ_type_get_or_null (const char *name, type_t father);
 385 void PJ_type_free_all ();
 386 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
 387
 388 /* instr_paje_values.c */
 389 XBT_PUBLIC(val_t)  PJ_value_new (const char *name, const char *color, type_t father);
 390 XBT_PUBLIC(val_t)  PJ_value_get_or_new (const char *name, const char *color, type_t father);
 391 XBT_PUBLIC(val_t)  PJ_value_get (const char *name, const type_t father);
 392 XBT_PRIVATE void PJ_value_free (val_t value);
 393
 394 XBT_PRIVATE void print_pajeDefineContainerType(paje_event_t event);
 395 XBT_PRIVATE void print_pajeDefineVariableType(paje_event_t event);
 396 XBT_PRIVATE void print_pajeDefineStateType(paje_event_t event);
 397 XBT_PRIVATE void print_pajeDefineEventType(paje_event_t event);
 398 XBT_PRIVATE void print_pajeDefineLinkType(paje_event_t event);
 399 XBT_PRIVATE void print_pajeDefineEntityValue (paje_event_t event);
 400 XBT_PRIVATE void print_pajeCreateContainer(paje_event_t event);
 401 XBT_PRIVATE void print_pajeDestroyContainer(paje_event_t event);
 402 XBT_PRIVATE void print_pajeSetVariable(paje_event_t event);
 403 XBT_PRIVATE void print_pajeAddVariable(paje_event_t event);
 404 XBT_PRIVATE void print_pajeSubVariable(paje_event_t event);
 405 XBT_PRIVATE void print_pajeSetState(paje_event_t event);
 406 XBT_PRIVATE void print_pajePushState(paje_event_t event);
 407 XBT_PRIVATE void print_pajePopState(paje_event_t event);
 408 XBT_PRIVATE void print_pajeResetState(paje_event_t event);
 409 XBT_PRIVATE void print_pajeStartLink(paje_event_t event);
 410 XBT_PRIVATE void print_pajeEndLink(paje_event_t event);
 411 XBT_PRIVATE void print_pajeNewEvent (paje_event_t event);
 412
 413 XBT_PRIVATE void print_TIPushState(paje_event_t event);
 414 XBT_PRIVATE void print_TICreateContainer(paje_event_t event);
 415 XBT_PRIVATE void print_TIDestroyContainer(paje_event_t event);
 416 XBT_PRIVATE void TRACE_TI_start();
 417 XBT_PRIVATE void TRACE_TI_end();
 418 XBT_PRIVATE void TRACE_TI_init();
 419
 420 XBT_PRIVATE void print_NULL (paje_event_t event);
 421 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 422 XBT_PRIVATE void dump_comment_file (const char *filename);
 423 XBT_PRIVATE void dump_comment (const char *comment);
 424
 425 typedef struct instr_trace_writer {
 426   void (*print_DefineContainerType) (paje_event_t event);
 427   void (*print_DefineVariableType)(paje_event_t event);
 428   void (*print_DefineStateType)(paje_event_t event);
 429   void (*print_DefineEventType)(paje_event_t event);
 430   void (*print_DefineLinkType)(paje_event_t event);
 431   void (*print_DefineEntityValue)(paje_event_t event);
 432   void (*print_CreateContainer)(paje_event_t event);
 433   void (*print_DestroyContainer)(paje_event_t event);
 434   void (*print_SetVariable)(paje_event_t event);
 435   void (*print_AddVariable)(paje_event_t event);
 436   void (*print_SubVariable)(paje_event_t event);
 437   void (*print_SetState)(paje_event_t event);
 438   void (*print_PushState)(paje_event_t event);
 439   void (*print_PopState)(paje_event_t event);
 440   void (*print_ResetState)(paje_event_t event);
 441   void (*print_StartLink)(paje_event_t event);
 442   void (*print_EndLink)(paje_event_t event);
 443   void (*print_NewEvent) (paje_event_t event);
 444 } s_instr_trace_writer_t;
 445
 446 struct s_instr_extra_data;
 447 typedef struct s_instr_extra_data *instr_extra_data;
 448
 449 typedef enum{
 450   TRACING_INIT,
 451   TRACING_FINALIZE,
 452   TRACING_COMM_SIZE,
 453   TRACING_COMM_SPLIT,
 454   TRACING_COMM_DUP,
 455   TRACING_SEND,
 456   TRACING_ISEND,
 457   TRACING_SSEND,
 458   TRACING_ISSEND,
 459   TRACING_RECV,
 460   TRACING_IRECV,
 461   TRACING_SENDRECV,
 462   TRACING_TEST,
 463   TRACING_WAIT,
 464   TRACING_WAITALL,
 465   TRACING_WAITANY,
 466   TRACING_BARRIER,
 467   TRACING_BCAST,
 468   TRACING_REDUCE,
 469   TRACING_ALLREDUCE,
 470   TRACING_ALLTOALL,
 471   TRACING_ALLTOALLV,
 472   TRACING_GATHER,
 473   TRACING_GATHERV,
 474   TRACING_SCATTER,
 475   TRACING_SCATTERV,
 476   TRACING_ALLGATHER,
 477   TRACING_ALLGATHERV,
 478   TRACING_REDUCE_SCATTER,
 479   TRACING_COMPUTING,
 480   TRACING_SLEEPING,
 481   TRACING_SCAN,
 482   TRACING_EXSCAN
 483 } e_caller_type ;
 484
 485 typedef struct s_instr_extra_data {
 486   e_caller_type type;
 487   int send_size;
 488   int recv_size;
 489   double comp_size;
 490   double sleep_duration;
 491   int src;
 492   int dst;
 493   int root;
 494   const char* datatype1;
 495   const char* datatype2;
 496   int * sendcounts;
 497   int * recvcounts;
 498   int num_processes;
 499 } s_instr_extra_data_t;
 500
 501 SG_END_DECL()
 502
 503 #endif