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