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   public:
 119   double timestamp;
 120   e_event_type event_type;
 121   virtual void print() = 0;
 122   void *data;
 123   virtual ~PajeEvent();
 124 };
 125
 126 class DefineContainerEvent : public PajeEvent
 127 {
 128   public:
 129   type_t type;
 130   void print() override;
 131   DefineContainerEvent(type_t);
 132 };
 133
 134 //--------------------------------------------------
 135
 136
 137 //--------------------------------------------------
 138
 139 class DefineVariableTypeEvent : public PajeEvent
 140 {
 141   public:
 142   type_t type;
 143    DefineVariableTypeEvent(type_t type);
 144    void print() override;
 145 };
 146 //--------------------------------------------------
 147
 148 class DefineStateTypeEvent : public PajeEvent  {
 149   type_t type;
 150   public:
 151   DefineStateTypeEvent(type_t type);
 152   void print() override;
 153 };
 154
 155 class DefineEventTypeEvent : public PajeEvent  {
 156   type_t type;
 157   public:
 158   DefineEventTypeEvent(type_t type);
 159   void print() override;
 160 };
 161
 162 class DefineLinkTypeEvent : public PajeEvent  {
 163   type_t type;
 164   type_t source;
 165   type_t dest;
 166   public:
 167   DefineLinkTypeEvent(type_t type, type_t source, type_t dest);
 168   void print() override;
 169 };
 170
 171 class DefineEntityValueEvent : public PajeEvent  {
 172   val_t value;
 173   public:
 174   DefineEntityValueEvent (val_t type);
 175   void print() override;
 176 };
 177
 178 class CreateContainerEvent : public PajeEvent  {
 179   public:
 180   container_t container;
 181   explicit CreateContainerEvent (container_t container);
 182   void print() override;
 183 };
 184
 185 class DestroyContainerEvent : public PajeEvent  {
 186   public:
 187   container_t container;
 188   DestroyContainerEvent (container_t container);
 189   void print() override;
 190 };
 191
 192
 193 class SetVariableEvent : public PajeEvent  {
 194   container_t container;
 195   type_t type;
 196   double value;
 197   public:
 198   SetVariableEvent (double timestamp, container_t container, type_t type, double value);
 199   void print() override;
 200 };
 201
 202
 203 class AddVariableEvent:public PajeEvent {
 204   container_t container;
 205   type_t type;
 206   double value;
 207   public:
 208   AddVariableEvent (double timestamp, container_t container, type_t type, double value);
 209   void print() override;
 210 };
 211
 212 //--------------------------------------------------
 213
 214
 215 class SubVariableEvent : public PajeEvent  {
 216   public:
 217   container_t container;
 218   type_t type;
 219   double value;
 220   public:
 221   SubVariableEvent(double timestamp, container_t container, type_t type, double value);
 222   void print() override;
 223 };
 224 //--------------------------------------------------
 225
 226 class SetStateEvent : public PajeEvent  {
 227   public:
 228   container_t container;
 229   type_t type;
 230   val_t value;
 231   const char* filename;
 232   int linenumber;
 233   public:
 234   SetStateEvent (double timestamp, container_t container, type_t type, val_t value);
 235   void print() override;
 236 };
 237
 238
 239 class PushStateEvent : public PajeEvent  {
 240   public:
 241   container_t container;
 242   type_t type;
 243   val_t value;
 244   int size;
 245   const char* filename;
 246   int linenumber;
 247   void* extra_;
 248   public:
 249   PushStateEvent (double timestamp, container_t container, type_t type, val_t value);
 250   PushStateEvent (double timestamp, container_t container, type_t type, val_t value,
 251                                              void* extra);
 252   void print() override;
 253 };
 254
 255 class PopStateEvent : public PajeEvent  {
 256   container_t container;
 257   type_t type;
 258   public:
 259   PopStateEvent (double timestamp, container_t container, type_t type);
 260   void print() override;
 261 };
 262
 263 class ResetStateEvent : public PajeEvent  {
 264   container_t container;
 265   type_t type;
 266   public:
 267   ResetStateEvent (double timestamp, container_t container, type_t type);
 268   void print() override;
 269 };
 270
 271 class StartLinkEvent : public PajeEvent  {
 272   public:
 273   container_t container;
 274   type_t type;
 275   container_t sourceContainer;
 276   char *value;
 277   char *key;
 278   int size;
 279   public:
 280     ~StartLinkEvent();
 281     StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
 282                    const char* key);
 283     StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
 284                    const char* key, int size);
 285     void print() override;
 286 };
 287
 288 class EndLinkEvent : public PajeEvent  {
 289   container_t container;
 290   type_t type;
 291   container_t destContainer;
 292   char *value;
 293   char *key;
 294   public:
 295   EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
 296                                   const char *value, const char *key);
 297   ~EndLinkEvent();
 298   void print() override;
 299 };
 300
 301
 302 class NewEvent : public PajeEvent  {
 303   public:
 304   container_t container;
 305   type_t type;
 306   val_t value;
 307   public:
 308   NewEvent (double timestamp, container_t container, type_t type, val_t value);
 309   void print() override;
 310
 311 };
 312
 313
 314 extern XBT_PRIVATE xbt_dict_t created_categories;
 315 extern XBT_PRIVATE xbt_dict_t declared_marks;
 316 extern XBT_PRIVATE xbt_dict_t user_host_variables;
 317 extern XBT_PRIVATE xbt_dict_t user_vm_variables;
 318 extern XBT_PRIVATE xbt_dict_t user_link_variables;
 319 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 320
 321 /* instr_paje_header.c */
 322 XBT_PRIVATE void TRACE_header(int basic, int size);
 323
 324 /* from paje.c */
 325 XBT_PRIVATE void TRACE_paje_start();
 326 XBT_PRIVATE void TRACE_paje_end();
 327 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 328
 329
 330 /* from instr_config.c */
 331 XBT_PRIVATE bool TRACE_needs_platform ();
 332 XBT_PRIVATE bool TRACE_is_enabled();
 333 XBT_PRIVATE bool TRACE_platform();
 334 XBT_PRIVATE bool TRACE_platform_topology();
 335 XBT_PRIVATE bool TRACE_is_configured();
 336 XBT_PRIVATE bool TRACE_categorized ();
 337 XBT_PRIVATE bool TRACE_uncategorized ();
 338 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
 339 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
 340 XBT_PRIVATE bool TRACE_buffer ();
 341 XBT_PRIVATE bool TRACE_disable_link();
 342 XBT_PRIVATE bool TRACE_disable_speed();
 343 XBT_PRIVATE bool TRACE_onelink_only ();
 344 XBT_PRIVATE bool TRACE_disable_destroy ();
 345 XBT_PRIVATE bool TRACE_basic ();
 346 XBT_PRIVATE bool TRACE_display_sizes ();
 347 XBT_PRIVATE char *TRACE_get_comment ();
 348 XBT_PRIVATE char *TRACE_get_comment_file ();
 349 XBT_PRIVATE int TRACE_precision ();
 350 XBT_PRIVATE char *TRACE_get_filename();
 351 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
 352 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
 353 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
 354 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
 355 XBT_PRIVATE void instr_pause_tracing ();
 356 XBT_PRIVATE void instr_resume_tracing ();
 357
 358 /* Public functions used in SMPI */
 359 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
 360 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
 361 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
 362 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
 363 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
 364
 365 /* from resource_utilization.c */
 366 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
 367                                      double delta);
 368 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
 369                                      double delta);
 370 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
 371
 372 /* instr_paje.c */
 373 extern XBT_PRIVATE xbt_dict_t trivaNodeTypes;
 374 extern XBT_PRIVATE xbt_dict_t trivaEdgeTypes;
 375 XBT_PRIVATE long long int instr_new_paje_id ();
 376 XBT_PRIVATE void PJ_container_alloc ();
 377 XBT_PRIVATE void PJ_container_release ();
 378 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
 379 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
 380 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
 381 XBT_PUBLIC(container_t) PJ_container_get_root ();
 382 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
 383 XBT_PUBLIC(void) PJ_container_free (container_t container);
 384 XBT_PUBLIC(void) PJ_container_free_all (void);
 385 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
 386
 387 /* instr_paje_types.c */
 388 XBT_PRIVATE void PJ_type_alloc ();
 389 XBT_PRIVATE void PJ_type_release ();
 390 XBT_PUBLIC(type_t)  PJ_type_get_root ();
 391 XBT_PRIVATE type_t PJ_type_container_new (const char *name, type_t father);
 392 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
 393 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
 394 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
 395 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
 396 XBT_PUBLIC(type_t)  PJ_type_get (const char *name, const type_t father);
 397 XBT_PUBLIC(type_t)  PJ_type_get_or_null (const char *name, type_t father);
 398 void PJ_type_free_all ();
 399 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
 400
 401 /* instr_paje_values.c */
 402 XBT_PUBLIC(val_t)  PJ_value_new (const char *name, const char *color, type_t father);
 403 XBT_PUBLIC(val_t)  PJ_value_get_or_new (const char *name, const char *color, type_t father);
 404 XBT_PUBLIC(val_t)  PJ_value_get (const char *name, const type_t father);
 405 XBT_PRIVATE void PJ_value_free (val_t value);
 406
 407 XBT_PRIVATE void print_pajeDefineContainerType(PajeEvent* event);
 408 XBT_PRIVATE void print_pajeDefineVariableType(PajeEvent* event);
 409 XBT_PRIVATE void print_pajeDefineStateType(PajeEvent* event);
 410 XBT_PRIVATE void print_pajeDefineEventType(PajeEvent* event);
 411 XBT_PRIVATE void print_pajeDefineLinkType(PajeEvent* event);
 412 XBT_PRIVATE void print_pajeDefineEntityValue (PajeEvent* event);
 413 XBT_PRIVATE void print_pajeCreateContainer(PajeEvent* event);
 414 XBT_PRIVATE void print_pajeDestroyContainer(PajeEvent* event);
 415 XBT_PRIVATE void print_pajeSetVariable(PajeEvent* event);
 416 XBT_PRIVATE void print_pajeAddVariable(PajeEvent* event);
 417 XBT_PRIVATE void print_pajeSubVariable(PajeEvent* event);
 418 XBT_PRIVATE void print_pajeSetState(PajeEvent* event);
 419 XBT_PRIVATE void print_pajePushState(PajeEvent* event);
 420 XBT_PRIVATE void print_pajePopState(PajeEvent* event);
 421 XBT_PRIVATE void print_pajeResetState(PajeEvent* event);
 422 XBT_PRIVATE void print_pajeStartLink(PajeEvent* event);
 423 XBT_PRIVATE void print_pajeEndLink(PajeEvent* event);
 424 XBT_PRIVATE void print_pajeNewEvent (PajeEvent* event);
 425
 426 XBT_PRIVATE void TRACE_TI_start();
 427 XBT_PRIVATE void TRACE_TI_end();
 428
 429 XBT_PRIVATE void print_NULL (PajeEvent* event);
 430 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 431 XBT_PRIVATE void dump_comment_file (const char *filename);
 432 XBT_PRIVATE void dump_comment (const char *comment);
 433
 434 typedef struct instr_trace_writer {
 435   void (*print_DefineContainerType) (PajeEvent* event);
 436   void (*print_DefineVariableType)(PajeEvent* event);
 437   void (*print_DefineStateType)(PajeEvent* event);
 438   void (*print_DefineEventType)(PajeEvent* event);
 439   void (*print_DefineLinkType)(PajeEvent* event);
 440   void (*print_DefineEntityValue)(PajeEvent* event);
 441   void (*print_CreateContainer)(PajeEvent* event);
 442   void (*print_DestroyContainer)(PajeEvent* event);
 443   void (*print_SetVariable)(PajeEvent* event);
 444   void (*print_AddVariable)(PajeEvent* event);
 445   void (*print_SubVariable)(PajeEvent* event);
 446   void (*print_SetState)(PajeEvent* event);
 447   void (*print_PushState)(PajeEvent* event);
 448   void (*print_PopState)(PajeEvent* event);
 449   void (*print_ResetState)(PajeEvent* event);
 450   void (*print_StartLink)(PajeEvent* event);
 451   void (*print_EndLink)(PajeEvent* event);
 452   void (*print_NewEvent) (PajeEvent* event);
 453 } s_instr_trace_writer_t;
 454
 455 struct s_instr_extra_data;
 456 typedef struct s_instr_extra_data *instr_extra_data;
 457
 458 typedef enum{
 459   TRACING_INIT,
 460   TRACING_FINALIZE,
 461   TRACING_COMM_SIZE,
 462   TRACING_COMM_SPLIT,
 463   TRACING_COMM_DUP,
 464   TRACING_SEND,
 465   TRACING_ISEND,
 466   TRACING_SSEND,
 467   TRACING_ISSEND,
 468   TRACING_RECV,
 469   TRACING_IRECV,
 470   TRACING_SENDRECV,
 471   TRACING_TEST,
 472   TRACING_WAIT,
 473   TRACING_WAITALL,
 474   TRACING_WAITANY,
 475   TRACING_BARRIER,
 476   TRACING_BCAST,
 477   TRACING_REDUCE,
 478   TRACING_ALLREDUCE,
 479   TRACING_ALLTOALL,
 480   TRACING_ALLTOALLV,
 481   TRACING_GATHER,
 482   TRACING_GATHERV,
 483   TRACING_SCATTER,
 484   TRACING_SCATTERV,
 485   TRACING_ALLGATHER,
 486   TRACING_ALLGATHERV,
 487   TRACING_REDUCE_SCATTER,
 488   TRACING_COMPUTING,
 489   TRACING_SLEEPING,
 490   TRACING_SCAN,
 491   TRACING_EXSCAN
 492 } e_caller_type ;
 493
 494 typedef struct s_instr_extra_data {
 495   e_caller_type type;
 496   int send_size;
 497   int recv_size;
 498   double comp_size;
 499   double sleep_duration;
 500   int src;
 501   int dst;
 502   int root;
 503   const char* datatype1;
 504   const char* datatype2;
 505   int * sendcounts;
 506   int * recvcounts;
 507   int num_processes;
 508 } s_instr_extra_data_t;
 509
 510 /* Format of TRACING output.
 511  *   - paje is the regular format, that we all know
 512  *   - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such trace can easily be replayed with smpi_replay afterward.
 513  *     This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
 514  */
 515 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
 516 extern instr_fmt_type_t instr_fmt_type;
 517
 518 SG_END_DECL()
 519
 520 #endif