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