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