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 PajeEvent;
 118
 119 class PajeEvent {
 120   public:
 121   double timestamp;
 122   e_event_type event_type;
 123   virtual void print(){};
 124   void *data;
 125   virtual ~PajeEvent();
 126 };
 127
 128 class DefineContainerEvent : public PajeEvent
 129 {
 130   public:
 131   type_t type;
 132   void print() override;
 133   DefineContainerEvent(type_t);
 134 };
 135
 136 //--------------------------------------------------
 137
 138
 139 //--------------------------------------------------
 140
 141 class DefineVariableTypeEvent : public PajeEvent
 142 {
 143   public:
 144   type_t type;
 145    DefineVariableTypeEvent(type_t type);
 146    void print() override;
 147 };
 148 //--------------------------------------------------
 149
 150 class DefineStateTypeEvent : public PajeEvent  {
 151   type_t type;
 152   public:
 153   DefineStateTypeEvent(type_t type);
 154   void print();// override;
 155 };
 156
 157 class DefineEventTypeEvent : public PajeEvent  {
 158   type_t type;
 159   public:
 160   DefineEventTypeEvent(type_t type);
 161   void print() override;
 162 };
 163
 164 class DefineLinkTypeEvent : public PajeEvent  {
 165   type_t type;
 166   type_t source;
 167   type_t dest;
 168   public:
 169   DefineLinkTypeEvent(type_t type, type_t source, type_t dest);
 170   void print() override;
 171 };
 172
 173 class DefineEntityValueEvent : public PajeEvent  {
 174   val_t value;
 175   public:
 176   DefineEntityValueEvent (val_t type);
 177   void print() override;
 178 };
 179
 180 class CreateContainerEvent : public PajeEvent  {
 181   public:
 182   container_t container;
 183   explicit CreateContainerEvent (container_t container);
 184   void print() override;
 185 };
 186
 187 class DestroyContainerEvent : public PajeEvent  {
 188   public:
 189   container_t container;
 190   DestroyContainerEvent (container_t container);
 191   void print() override;
 192 };
 193
 194
 195 class SetVariableEvent : public PajeEvent  {
 196   container_t container;
 197   type_t type;
 198   double value;
 199   public:
 200   SetVariableEvent (double timestamp, container_t container, type_t type, double value);
 201   void print() override;
 202 };
 203
 204
 205 class AddVariableEvent:public PajeEvent {
 206   container_t container;
 207   type_t type;
 208   double value;
 209   public:
 210   AddVariableEvent (double timestamp, container_t container, type_t type, double value);
 211   void print() override;
 212 };
 213
 214 //--------------------------------------------------
 215
 216
 217 class SubVariableEvent : public PajeEvent  {
 218   public:
 219   container_t container;
 220   type_t type;
 221   double value;
 222   public:
 223   SubVariableEvent(double timestamp, container_t container, type_t type, double value);
 224   void print() override;
 225 };
 226 //--------------------------------------------------
 227
 228 class SetStateEvent : public PajeEvent  {
 229   public:
 230   container_t container;
 231   type_t type;
 232   val_t value;
 233   const char* filename;
 234   int linenumber;
 235   public:
 236   SetStateEvent (double timestamp, container_t container, type_t type, val_t value);
 237   void print() override;
 238 };
 239
 240
 241 class PushStateEvent : public PajeEvent  {
 242   public:
 243   container_t container;
 244   type_t type;
 245   val_t value;
 246   int size;
 247   const char* filename;
 248   int linenumber;
 249   void* extra;
 250   public:
 251   PushStateEvent (double timestamp, container_t container, type_t type, val_t value);
 252   PushStateEvent (double timestamp, container_t container, type_t type, val_t value,
 253                                              void* extra);
 254   void print() override;
 255 };
 256
 257 class PopStateEvent : public PajeEvent  {
 258   container_t container;
 259   type_t type;
 260   xbt_dynar_t extra;
 261   public:
 262   PopStateEvent (double timestamp, container_t container, type_t type);
 263   void print() override;
 264 };
 265
 266 class ResetStateEvent : public PajeEvent  {
 267   container_t container;
 268   type_t type;
 269   public:
 270   ResetStateEvent (double timestamp, container_t container, type_t type);
 271   void print() override;
 272 };
 273
 274 class StartLinkEvent : public PajeEvent  {
 275   public:
 276   container_t container;
 277   type_t type;
 278   container_t sourceContainer;
 279   char *value;
 280   char *key;
 281   int size;
 282   public:
 283   StartLinkEvent (double timestamp, container_t container, type_t type, container_t sourceContainer,
 284                                     const char *value, const char *key);
 285   StartLinkEvent (double timestamp, container_t container, type_t type,
 286                                             container_t sourceContainer, const char *value, const char *key, int size);
 287   void print() override;
 288 };
 289
 290 class EndLinkEvent : public PajeEvent  {
 291   container_t container;
 292   type_t type;
 293   container_t destContainer;
 294   char *value;
 295   char *key;
 296   public:
 297   EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
 298                                   const char *value, const char *key);
 299   void print() override;
 300 };
 301
 302
 303 class NewEvent : public PajeEvent  {
 304   public:
 305   container_t container;
 306   type_t type;
 307   val_t value;
 308   public:
 309   NewEvent (double timestamp, container_t container, type_t type, val_t value);
 310   void print() override;
 311
 312 };
 313
 314
 315 extern XBT_PRIVATE xbt_dict_t created_categories;
 316 extern XBT_PRIVATE xbt_dict_t declared_marks;
 317 extern XBT_PRIVATE xbt_dict_t user_host_variables;
 318 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
 319 extern XBT_PRIVATE xbt_dict_t user_link_variables;
 320 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 321
 322 /* instr_paje_header.c */
 323 XBT_PRIVATE void TRACE_header(int basic, int size);
 324
 325 /* from paje.c */
 326 XBT_PRIVATE void TRACE_paje_start();
 327 XBT_PRIVATE void TRACE_paje_end();
 328 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 329
 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(PajeEvent* event);
 409 XBT_PRIVATE void print_pajeDefineVariableType(PajeEvent* event);
 410 XBT_PRIVATE void print_pajeDefineStateType(PajeEvent* event);
 411 XBT_PRIVATE void print_pajeDefineEventType(PajeEvent* event);
 412 XBT_PRIVATE void print_pajeDefineLinkType(PajeEvent* event);
 413 XBT_PRIVATE void print_pajeDefineEntityValue (PajeEvent* event);
 414 XBT_PRIVATE void print_pajeCreateContainer(PajeEvent* event);
 415 XBT_PRIVATE void print_pajeDestroyContainer(PajeEvent* event);
 416 XBT_PRIVATE void print_pajeSetVariable(PajeEvent* event);
 417 XBT_PRIVATE void print_pajeAddVariable(PajeEvent* event);
 418 XBT_PRIVATE void print_pajeSubVariable(PajeEvent* event);
 419 XBT_PRIVATE void print_pajeSetState(PajeEvent* event);
 420 XBT_PRIVATE void print_pajePushState(PajeEvent* event);
 421 XBT_PRIVATE void print_pajePopState(PajeEvent* event);
 422 XBT_PRIVATE void print_pajeResetState(PajeEvent* event);
 423 XBT_PRIVATE void print_pajeStartLink(PajeEvent* event);
 424 XBT_PRIVATE void print_pajeEndLink(PajeEvent* event);
 425 XBT_PRIVATE void print_pajeNewEvent (PajeEvent* event);
 426
 427 XBT_PRIVATE void print_TIPushState(PajeEvent* event);
 428 XBT_PRIVATE void print_TICreateContainer(PajeEvent* event);
 429 XBT_PRIVATE void print_TIDestroyContainer(PajeEvent* 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 (PajeEvent* 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) (PajeEvent* event);
 441   void (*print_DefineVariableType)(PajeEvent* event);
 442   void (*print_DefineStateType)(PajeEvent* event);
 443   void (*print_DefineEventType)(PajeEvent* event);
 444   void (*print_DefineLinkType)(PajeEvent* event);
 445   void (*print_DefineEntityValue)(PajeEvent* event);
 446   void (*print_CreateContainer)(PajeEvent* event);
 447   void (*print_DestroyContainer)(PajeEvent* event);
 448   void (*print_SetVariable)(PajeEvent* event);
 449   void (*print_AddVariable)(PajeEvent* event);
 450   void (*print_SubVariable)(PajeEvent* event);
 451   void (*print_SetState)(PajeEvent* event);
 452   void (*print_PushState)(PajeEvent* event);
 453   void (*print_PopState)(PajeEvent* event);
 454   void (*print_ResetState)(PajeEvent* event);
 455   void (*print_StartLink)(PajeEvent* event);
 456   void (*print_EndLink)(PajeEvent* event);
 457   void (*print_NewEvent) (PajeEvent* 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