src/instr/instr_private.h

   1 /* Copyright (c) 2010-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef INSTR_PRIVATE_H_
   8 #define INSTR_PRIVATE_H_
   9
  10 #include <xbt/base.h>
  11
  12 #include "simgrid/instr.h"
  13 #include "instr/instr_interface.h"
  14 #include "src/internal_config.h"
  15 #include "simgrid_config.h"
  16
  17 SG_BEGIN_DECL()
  18
  19 /* Need to define function drand48 for Windows */
  20 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
  21 #ifdef _WIN32
  22 #  define drand48() (rand()/(RAND_MAX + 1.0))
  23 #endif
  24
  25 #define INSTR_DEFAULT_STR_SIZE 500
  26
  27 #include "xbt/graph.h"
  28 #include "xbt/dict.h"
  29
  30 typedef enum {
  31   PAJE_DefineContainerType,
  32   PAJE_DefineVariableType,
  33   PAJE_DefineStateType,
  34   PAJE_DefineEventType,
  35   PAJE_DefineLinkType,
  36   PAJE_DefineEntityValue,
  37   PAJE_CreateContainer,
  38   PAJE_DestroyContainer,
  39   PAJE_SetVariable,
  40   PAJE_AddVariable,
  41   PAJE_SubVariable,
  42   PAJE_SetState,
  43   PAJE_PushState,
  44   PAJE_PopState,
  45   PAJE_ResetState,
  46   PAJE_StartLink,
  47   PAJE_EndLink,
  48   PAJE_NewEvent
  49 } e_event_type;
  50
  51 typedef enum {
  52   TYPE_VARIABLE,
  53   TYPE_LINK,
  54   TYPE_CONTAINER,
  55   TYPE_STATE,
  56   TYPE_EVENT
  57 } e_entity_types;
  58
  59 typedef struct s_type *type_t;
  60 typedef struct s_type {
  61   char *id;
  62   char *name;
  63   char *color;
  64   e_entity_types kind;
  65   struct s_type *father;
  66   xbt_dict_t children;
  67   xbt_dict_t values; //valid for all types except variable and container
  68 }s_type_t;
  69
  70 typedef struct s_val *val_t;
  71 typedef struct s_val {
  72   char *id;
  73   char *name;
  74   char *color;
  75   type_t father;
  76 }s_val_t;
  77
  78 typedef enum {
  79   INSTR_HOST,
  80   INSTR_LINK,
  81   INSTR_ROUTER,
  82   INSTR_AS,
  83   INSTR_SMPI,
  84   INSTR_MSG_VM,
  85   INSTR_MSG_PROCESS,
  86   INSTR_MSG_TASK
  87 } e_container_types;
  88
  89 typedef struct s_container *container_t;
  90 typedef struct s_container {
  91   sg_netcard_t netcard;
  92   char *name;     /* Unique name of this container */
  93   char *id;       /* Unique id of this container */
  94   type_t type;    /* Type of this container */
  95   int level;      /* Level in the hierarchy, root level is 0 */
  96   e_container_types kind; /* This container is of what kind */
  97   struct s_container *father;
  98   xbt_dict_t children;
  99 }s_container_t;
 100
 101 typedef struct paje_event *paje_event_t;
 102 typedef struct paje_event {
 103   double timestamp;
 104   e_event_type event_type;
 105   void (*print) (paje_event_t event);
 106   void (*free) (paje_event_t event);
 107   void *data;
 108 } s_paje_event_t;
 109
 110 typedef struct s_defineContainerType *defineContainerType_t;
 111 typedef struct s_defineContainerType {
 112   type_t type;
 113 }s_defineContainerType_t;
 114
 115 typedef struct s_defineVariableType *defineVariableType_t;
 116 typedef struct s_defineVariableType {
 117   type_t type;
 118 }s_defineVariableType_t;
 119
 120 typedef struct s_defineStateType *defineStateType_t;
 121 typedef struct s_defineStateType {
 122   type_t type;
 123 }s_defineStateType_t;
 124
 125 typedef struct s_defineEventType *defineEventType_t;
 126 typedef struct s_defineEventType {
 127   type_t type;
 128 }s_defineEventType_t;
 129
 130 typedef struct s_defineLinkType *defineLinkType_t;
 131 typedef struct s_defineLinkType {
 132   type_t type;
 133   type_t source;
 134   type_t dest;
 135 }s_defineLinkType_t;
 136
 137 typedef struct s_defineEntityValue *defineEntityValue_t;
 138 typedef struct s_defineEntityValue {
 139   val_t value;
 140 }s_defineEntityValue_t;
 141
 142 typedef struct s_createContainer *createContainer_t;
 143 typedef struct s_createContainer {
 144   container_t container;
 145 }s_createContainer_t;
 146
 147 typedef struct s_destroyContainer *destroyContainer_t;
 148 typedef struct s_destroyContainer {
 149   container_t container;
 150 }s_destroyContainer_t;
 151
 152 typedef struct s_setVariable *setVariable_t;
 153 typedef struct s_setVariable {
 154   container_t container;
 155   type_t type;
 156   double value;
 157 }s_setVariable_t;
 158
 159 typedef struct s_addVariable *addVariable_t;
 160 typedef struct s_addVariable {
 161   container_t container;
 162   type_t type;
 163   double value;
 164 }s_addVariable_t;
 165
 166 typedef struct s_subVariable *subVariable_t;
 167 typedef struct s_subVariable {
 168   container_t container;
 169   type_t type;
 170   double value;
 171 }s_subVariable_t;
 172
 173 typedef struct s_setState *setState_t;
 174 typedef struct s_setState {
 175   container_t container;
 176   type_t type;
 177   val_t value;
 178   const char* filename;
 179   int linenumber;
 180 }s_setState_t;
 181
 182 typedef struct s_pushState *pushState_t;
 183 typedef struct s_pushState {
 184   container_t container;
 185   type_t type;
 186   val_t value;
 187   int size;
 188   const char* filename;
 189   int linenumber;
 190   void* extra;
 191 }s_pushState_t;
 192
 193 typedef struct s_popState *popState_t;
 194 typedef struct s_popState {
 195   container_t container;
 196   type_t type;
 197   xbt_dynar_t extra;
 198 }s_popState_t;
 199
 200 typedef struct s_resetState *resetState_t;
 201 typedef struct s_resetState {
 202   container_t container;
 203   type_t type;
 204 }s_resetState_t;
 205
 206 typedef struct s_startLink *startLink_t;
 207 typedef struct s_startLink {
 208   container_t container;
 209   type_t type;
 210   container_t sourceContainer;
 211   char *value;
 212   char *key;
 213   int size;
 214 }s_startLink_t;
 215
 216 typedef struct s_endLink *endLink_t;
 217 typedef struct s_endLink {
 218   container_t container;
 219   type_t type;
 220   container_t destContainer;
 221   char *value;
 222   char *key;
 223 }s_endLink_t;
 224
 225 typedef struct s_newEvent *newEvent_t;
 226 typedef struct s_newEvent {
 227   container_t container;
 228   type_t type;
 229   val_t value;
 230 }s_newEvent_t;
 231
 232 extern XBT_PRIVATE xbt_dict_t created_categories;
 233 extern XBT_PRIVATE xbt_dict_t declared_marks;
 234 extern XBT_PRIVATE xbt_dict_t user_host_variables;
 235 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
 236 extern XBT_PRIVATE xbt_dict_t user_link_variables;
 237 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 238
 239 /* instr_paje_header.c */
 240 XBT_PRIVATE void TRACE_header(int basic, int size);
 241
 242 /* from paje.c */
 243 XBT_PRIVATE void TRACE_init(void);
 244 XBT_PRIVATE void TRACE_finalize(void);
 245 XBT_PRIVATE void TRACE_paje_init(void);
 246 XBT_PRIVATE void TRACE_paje_start(void);
 247 XBT_PRIVATE void TRACE_paje_end(void);
 248 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 249 XBT_PUBLIC(void) new_pajeDefineContainerType(type_t type);
 250 XBT_PUBLIC(void) new_pajeDefineVariableType(type_t type);
 251 XBT_PUBLIC(void) new_pajeDefineStateType(type_t type);
 252 XBT_PUBLIC(void) new_pajeDefineEventType(type_t type);
 253 XBT_PUBLIC(void) new_pajeDefineLinkType(type_t type, type_t source, type_t dest);
 254 XBT_PUBLIC(void) new_pajeDefineEntityValue (val_t type);
 255 XBT_PUBLIC(void) new_pajeCreateContainer (container_t container);
 256 XBT_PUBLIC(void) new_pajeDestroyContainer (container_t container);
 257 XBT_PUBLIC(void) new_pajeSetVariable (double timestamp, container_t container, type_t type, double value);
 258 XBT_PUBLIC(void) new_pajeAddVariable (double timestamp, container_t container, type_t type, double value);
 259 XBT_PUBLIC(void) new_pajeSubVariable (double timestamp, container_t container, type_t type, double value);
 260 XBT_PUBLIC(void) new_pajeSetState (double timestamp, container_t container, type_t type, val_t value);
 261 XBT_PUBLIC(void) new_pajePushState (double timestamp, container_t container, type_t type, val_t value);
 262 XBT_PUBLIC(void) new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value,
 263                                              void* extra);
 264 XBT_PUBLIC(void) new_pajePopState (double timestamp, container_t container, type_t type);
 265 XBT_PUBLIC(void) new_pajeResetState (double timestamp, container_t container, type_t type);
 266 XBT_PUBLIC(void) new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer,
 267                                     const char *value, const char *key);
 268 XBT_PUBLIC(void) new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type,
 269                                             container_t sourceContainer, const char *value, const char *key, int size);
 270 XBT_PUBLIC(void) new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
 271                                   const char *value, const char *key);
 272 XBT_PUBLIC(void) new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value);
 273
 274 /* from instr_config.c */
 275 XBT_PRIVATE bool TRACE_needs_platform (void);
 276 XBT_PRIVATE bool TRACE_is_enabled(void);
 277 XBT_PRIVATE bool TRACE_platform(void);
 278 XBT_PRIVATE bool TRACE_platform_topology(void);
 279 XBT_PRIVATE bool TRACE_is_configured(void);
 280 XBT_PRIVATE bool TRACE_categorized (void);
 281 XBT_PRIVATE bool TRACE_uncategorized (void);
 282 XBT_PRIVATE bool TRACE_msg_process_is_enabled(void);
 283 XBT_PRIVATE bool TRACE_msg_vm_is_enabled(void);
 284 XBT_PRIVATE bool TRACE_buffer (void);
 285 XBT_PRIVATE bool TRACE_disable_link(void);
 286 XBT_PRIVATE bool TRACE_disable_speed(void);
 287 XBT_PRIVATE bool TRACE_onelink_only (void);
 288 XBT_PRIVATE bool TRACE_disable_destroy (void);
 289 XBT_PRIVATE bool TRACE_basic (void);
 290 XBT_PRIVATE bool TRACE_display_sizes (void);
 291 XBT_PRIVATE char *TRACE_get_comment (void);
 292 XBT_PRIVATE char *TRACE_get_comment_file (void);
 293 XBT_PRIVATE int TRACE_precision (void);
 294 XBT_PRIVATE char *TRACE_get_filename(void);
 295 XBT_PRIVATE char *TRACE_get_viva_uncat_conf (void);
 296 XBT_PRIVATE char *TRACE_get_viva_cat_conf (void);
 297 XBT_PRIVATE void TRACE_generate_viva_uncat_conf (void);
 298 XBT_PRIVATE void TRACE_generate_viva_cat_conf (void);
 299 XBT_PRIVATE void instr_pause_tracing (void);
 300 XBT_PRIVATE void instr_resume_tracing (void);
 301
 302 /* Public functions used in SMPI */
 303 XBT_PUBLIC(bool) TRACE_smpi_is_enabled(void);
 304 XBT_PUBLIC(bool) TRACE_smpi_is_grouped(void);
 305 XBT_PUBLIC(bool) TRACE_smpi_is_computing(void);
 306 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping(void);
 307 XBT_PUBLIC(bool) TRACE_smpi_view_internals(void);
 308
 309 /* from resource_utilization.c */
 310 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
 311                                      double delta);
 312 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
 313                                      double delta);
 314 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc(void);
 315
 316 /* instr_paje.c */
 317 extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
 318 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
 319 XBT_PRIVATE long long int instr_new_paje_id (void);
 320 XBT_PRIVATE void PJ_container_alloc (void);
 321 XBT_PRIVATE void PJ_container_release (void);
 322 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
 323 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
 324 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
 325 XBT_PUBLIC(container_t) PJ_container_get_root (void);
 326 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
 327 XBT_PUBLIC(void) PJ_container_free (container_t container);
 328 XBT_PUBLIC(void) PJ_container_free_all (void);
 329 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
 330
 331 /* instr_paje_types.c */
 332 XBT_PRIVATE void PJ_type_alloc (void);
 333 XBT_PRIVATE void PJ_type_release (void);
 334 XBT_PUBLIC(type_t)  PJ_type_get_root (void);
 335 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
 336 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
 337 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
 338 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
 339 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
 340 XBT_PUBLIC(type_t)  PJ_type_get (const char *name, const type_t father);
 341 XBT_PUBLIC(type_t)  PJ_type_get_or_null (const char *name, type_t father);
 342 void PJ_type_free_all (void);
 343 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
 344
 345 /* instr_paje_values.c */
 346 XBT_PUBLIC(val_t)  PJ_value_new (const char *name, const char *color, type_t father);
 347 XBT_PUBLIC(val_t)  PJ_value_get_or_new (const char *name, const char *color, type_t father);
 348 XBT_PUBLIC(val_t)  PJ_value_get (const char *name, const type_t father);
 349 XBT_PRIVATE void PJ_value_free (val_t value);
 350
 351 XBT_PRIVATE void print_pajeDefineContainerType(paje_event_t event);
 352 XBT_PRIVATE void print_pajeDefineVariableType(paje_event_t event);
 353 XBT_PRIVATE void print_pajeDefineStateType(paje_event_t event);
 354 XBT_PRIVATE void print_pajeDefineEventType(paje_event_t event);
 355 XBT_PRIVATE void print_pajeDefineLinkType(paje_event_t event);
 356 XBT_PRIVATE void print_pajeDefineEntityValue (paje_event_t event);
 357 XBT_PRIVATE void print_pajeCreateContainer(paje_event_t event);
 358 XBT_PRIVATE void print_pajeDestroyContainer(paje_event_t event);
 359 XBT_PRIVATE void print_pajeSetVariable(paje_event_t event);
 360 XBT_PRIVATE void print_pajeAddVariable(paje_event_t event);
 361 XBT_PRIVATE void print_pajeSubVariable(paje_event_t event);
 362 XBT_PRIVATE void print_pajeSetState(paje_event_t event);
 363 XBT_PRIVATE void print_pajePushState(paje_event_t event);
 364 XBT_PRIVATE void print_pajePopState(paje_event_t event);
 365 XBT_PRIVATE void print_pajeResetState(paje_event_t event);
 366 XBT_PRIVATE void print_pajeStartLink(paje_event_t event);
 367 XBT_PRIVATE void print_pajeEndLink(paje_event_t event);
 368 XBT_PRIVATE void print_pajeNewEvent (paje_event_t event);
 369
 370 XBT_PRIVATE void print_TIPushState(paje_event_t event);
 371 XBT_PRIVATE void print_TICreateContainer(paje_event_t event);
 372 XBT_PRIVATE void print_TIDestroyContainer(paje_event_t event);
 373 XBT_PRIVATE void TRACE_TI_start(void);
 374 XBT_PRIVATE void TRACE_TI_end(void);
 375 XBT_PRIVATE void TRACE_TI_init(void);
 376
 377 XBT_PRIVATE void print_NULL (paje_event_t event);
 378 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 379 XBT_PRIVATE void dump_comment_file (const char *filename);
 380 XBT_PRIVATE void dump_comment (const char *comment);
 381
 382 typedef struct instr_trace_writer {
 383   void (*print_DefineContainerType) (paje_event_t event);
 384   void (*print_DefineVariableType)(paje_event_t event);
 385   void (*print_DefineStateType)(paje_event_t event);
 386   void (*print_DefineEventType)(paje_event_t event);
 387   void (*print_DefineLinkType)(paje_event_t event);
 388   void (*print_DefineEntityValue)(paje_event_t event);
 389   void (*print_CreateContainer)(paje_event_t event);
 390   void (*print_DestroyContainer)(paje_event_t event);
 391   void (*print_SetVariable)(paje_event_t event);
 392   void (*print_AddVariable)(paje_event_t event);
 393   void (*print_SubVariable)(paje_event_t event);
 394   void (*print_SetState)(paje_event_t event);
 395   void (*print_PushState)(paje_event_t event);
 396   void (*print_PopState)(paje_event_t event);
 397   void (*print_ResetState)(paje_event_t event);
 398   void (*print_StartLink)(paje_event_t event);
 399   void (*print_EndLink)(paje_event_t event);
 400   void (*print_NewEvent) (paje_event_t event);
 401 } s_instr_trace_writer_t;
 402
 403 struct s_instr_extra_data;
 404 typedef struct s_instr_extra_data *instr_extra_data;
 405
 406 typedef enum{
 407   TRACING_INIT,
 408   TRACING_FINALIZE,
 409   TRACING_COMM_SIZE,
 410   TRACING_COMM_SPLIT,
 411   TRACING_COMM_DUP,
 412   TRACING_SEND,
 413   TRACING_ISEND,
 414   TRACING_SSEND,
 415   TRACING_ISSEND,
 416   TRACING_RECV,
 417   TRACING_IRECV,
 418   TRACING_SENDRECV,
 419   TRACING_TEST,
 420   TRACING_WAIT,
 421   TRACING_WAITALL,
 422   TRACING_WAITANY,
 423   TRACING_BARRIER,
 424   TRACING_BCAST,
 425   TRACING_REDUCE,
 426   TRACING_ALLREDUCE,
 427   TRACING_ALLTOALL,
 428   TRACING_ALLTOALLV,
 429   TRACING_GATHER,
 430   TRACING_GATHERV,
 431   TRACING_SCATTER,
 432   TRACING_SCATTERV,
 433   TRACING_ALLGATHER,
 434   TRACING_ALLGATHERV,
 435   TRACING_REDUCE_SCATTER,
 436   TRACING_COMPUTING,
 437   TRACING_SLEEPING,
 438   TRACING_SCAN,
 439   TRACING_EXSCAN
 440 } e_caller_type ;
 441
 442 typedef struct s_instr_extra_data {
 443   e_caller_type type;
 444   int send_size;
 445   int recv_size;
 446   double comp_size;
 447   double sleep_duration;
 448   int src;
 449   int dst;
 450   int root;
 451   const char* datatype1;
 452   const char* datatype2;
 453   int * sendcounts;
 454   int * recvcounts;
 455   int num_processes;
 456 } s_instr_extra_data_t;
 457
 458 SG_END_DECL()
 459
 460 #if HAVE_JEDULE
 461 #include "simgrid/jedule/jedule_sd_binding.h"
 462 #endif
 463
 464 #endif /* INSTR_PRIVATE_H_ */