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