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 "instr/instr_interface.h"
  12 #include "simgrid/instr.h"
  13 #include "simgrid_config.h"
  14 #include "src/internal_config.h"
  15 #include <set>
  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 //--------------------------------------------------
  60
  61 class ess_type {
  62   public:
  63   char *id;
  64   char *name;
  65   char *color;
  66 };
  67
  68 class s_type;
  69 typedef s_type *type_t;
  70 class s_type : public ess_type {
  71   public:
  72   e_entity_types kind;
  73   s_type *father;
  74   xbt_dict_t children;
  75   xbt_dict_t values; //valid for all types except variable and container
  76   s_type (const char *typeNameBuff, const char *key, const char *color, e_entity_types kind, type_t father);
  77   static type_t s_type_get_or_null (const char *name, type_t father);
  78   static type_t s_type_container_new (const char *name, type_t father);
  79   static type_t s_type_event_new (const char *name, type_t father);
  80   static type_t s_type_variable_new (const char *name, const char *color, type_t father);
  81 };
  82
  83 //--------------------------------------------------
  84 class value : public ess_type{
  85 public:
  86   type_t father;
  87   value* ret;
  88   value(const char* name, const char* color, type_t father);
  89   ~value();
  90   static value* get_or_new(const char* name, const char* color, type_t father);
  91   static value* get(const char* name, type_t father);
  92 };
  93
  94
  95 //--------------------------------------------------
  96 typedef enum {
  97   INSTR_HOST,
  98   INSTR_LINK,
  99   INSTR_ROUTER,
 100   INSTR_AS,
 101   INSTR_SMPI,
 102   INSTR_MSG_VM,
 103   INSTR_MSG_PROCESS,
 104   INSTR_MSG_TASK
 105 } e_container_types;
 106
 107 //--------------------------------------------------
 108 class s_container;
 109 typedef s_container *container_t;
 110
 111 class s_container {
 112   public:
 113   sg_netpoint_t netpoint;
 114   char *name;     /* Unique name of this container */
 115   char *id;       /* Unique id of this container */
 116   type_t type;    /* Type of this container */
 117   int level;      /* Level in the hierarchy, root level is 0 */
 118   e_container_types kind; /* This container is of what kind */
 119   s_container *father;
 120   xbt_dict_t children;
 121 };
 122
 123 //--------------------------------------------------
 124 class PajeEvent {
 125   public:
 126   double timestamp;
 127   e_event_type event_type;
 128   virtual void print() = 0;
 129   void *data;
 130   virtual ~PajeEvent();
 131 };
 132
 133 //--------------------------------------------------
 134
 135 class DefineVariableTypeEvent : public PajeEvent
 136 {
 137   public:
 138   type_t type;
 139    DefineVariableTypeEvent(type_t type);
 140    void print() override;
 141 };
 142 //--------------------------------------------------
 143
 144 class DefineStateTypeEvent : public PajeEvent  {
 145   type_t type;
 146   public:
 147   DefineStateTypeEvent(type_t type);
 148   void print() override;
 149 };
 150
 151
 152 class SetVariableEvent : public PajeEvent  {
 153   private:
 154   container_t container;
 155   type_t type;
 156   double value;
 157   public:
 158   SetVariableEvent (double timestamp, container_t container, type_t type, double value);
 159   void print() override;
 160 };
 161
 162
 163 class AddVariableEvent:public PajeEvent {
 164   private:
 165   container_t container;
 166   type_t type;
 167   double value;
 168   public:
 169   AddVariableEvent (double timestamp, container_t container, type_t type, double value);
 170   void print() override;
 171 };
 172
 173 //--------------------------------------------------
 174
 175
 176 class SubVariableEvent : public PajeEvent  {
 177   private:
 178   container_t container;
 179   type_t type;
 180   double value;
 181   public:
 182   SubVariableEvent(double timestamp, container_t container, type_t type, double value);
 183   void print() override;
 184 };
 185 //--------------------------------------------------
 186
 187 class SetStateEvent : public PajeEvent  {
 188   private:
 189   container_t container;
 190   type_t type;
 191   value* val;
 192   const char* filename;
 193   int linenumber;
 194   public:
 195     SetStateEvent(double timestamp, container_t container, type_t type, value* val);
 196     void print() override;
 197 };
 198
 199
 200 class PushStateEvent : public PajeEvent  {
 201   public:
 202   container_t container;
 203   type_t type;
 204   value* val;
 205   int size;
 206   const char* filename;
 207   int linenumber;
 208   void* extra_;
 209   public:
 210     PushStateEvent(double timestamp, container_t container, type_t type, value* val);
 211     PushStateEvent(double timestamp, container_t container, type_t type, value* val, void* extra);
 212     void print() override;
 213 };
 214
 215 class PopStateEvent : public PajeEvent  {
 216   container_t container;
 217   type_t type;
 218   public:
 219   PopStateEvent (double timestamp, container_t container, type_t type);
 220   void print() override;
 221 };
 222
 223 class ResetStateEvent : public PajeEvent  {
 224   container_t container;
 225   type_t type;
 226   public:
 227   ResetStateEvent (double timestamp, container_t container, type_t type);
 228   void print() override;
 229 };
 230
 231 class StartLinkEvent : public PajeEvent  {
 232   public:
 233   container_t container;
 234   type_t type;
 235   container_t sourceContainer;
 236   char *value;
 237   char *key;
 238   int size;
 239   public:
 240     ~StartLinkEvent();
 241     StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
 242                    const char* key);
 243     StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
 244                    const char* key, int size);
 245     void print() override;
 246 };
 247
 248 class EndLinkEvent : public PajeEvent  {
 249   container_t container;
 250   type_t type;
 251   container_t destContainer;
 252   char *value;
 253   char *key;
 254   public:
 255   EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
 256                                   const char *value, const char *key);
 257   ~EndLinkEvent();
 258   void print() override;
 259 };
 260
 261
 262 class NewEvent : public PajeEvent  {
 263   public:
 264   container_t container;
 265   type_t type;
 266   value* val;
 267
 268 public:
 269   NewEvent(double timestamp, container_t container, type_t type, value* val);
 270   void print() override;
 271
 272 };
 273
 274 extern XBT_PRIVATE std::set<std::string> created_categories;
 275 extern XBT_PRIVATE std::set<std::string> declared_marks;
 276 extern XBT_PRIVATE std::set<std::string> user_host_variables;
 277 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
 278 extern XBT_PRIVATE std::set<std::string> user_link_variables;
 279 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 280
 281 /* instr_paje_header.c */
 282 XBT_PRIVATE void TRACE_header(int basic, int size);
 283
 284 /* from paje.c */
 285 XBT_PRIVATE void TRACE_paje_start();
 286 XBT_PRIVATE void TRACE_paje_end();
 287 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 288
 289
 290 /* from instr_config.c */
 291 XBT_PRIVATE bool TRACE_needs_platform ();
 292 XBT_PRIVATE bool TRACE_is_enabled();
 293 XBT_PRIVATE bool TRACE_platform();
 294 XBT_PRIVATE bool TRACE_platform_topology();
 295 XBT_PRIVATE bool TRACE_is_configured();
 296 XBT_PRIVATE bool TRACE_categorized ();
 297 XBT_PRIVATE bool TRACE_uncategorized ();
 298 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
 299 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
 300 XBT_PRIVATE bool TRACE_buffer ();
 301 XBT_PRIVATE bool TRACE_disable_link();
 302 XBT_PRIVATE bool TRACE_disable_speed();
 303 XBT_PRIVATE bool TRACE_onelink_only ();
 304 XBT_PRIVATE bool TRACE_disable_destroy ();
 305 XBT_PRIVATE bool TRACE_basic ();
 306 XBT_PRIVATE bool TRACE_display_sizes ();
 307 XBT_PRIVATE char *TRACE_get_comment ();
 308 XBT_PRIVATE char *TRACE_get_comment_file ();
 309 XBT_PRIVATE int TRACE_precision ();
 310 XBT_PRIVATE char *TRACE_get_filename();
 311 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
 312 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
 313 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
 314 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
 315 XBT_PRIVATE void instr_pause_tracing ();
 316 XBT_PRIVATE void instr_resume_tracing ();
 317
 318 /* Public functions used in SMPI */
 319 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
 320 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
 321 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
 322 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
 323 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
 324
 325 /* from resource_utilization.c */
 326 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
 327                                      double delta);
 328 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
 329                                      double delta);
 330 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
 331
 332 /* instr_paje.c */
 333 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
 334 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
 335 XBT_PRIVATE long long int instr_new_paje_id ();
 336 XBT_PRIVATE void PJ_container_alloc ();
 337 XBT_PRIVATE void PJ_container_release ();
 338 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
 339 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
 340 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
 341 XBT_PUBLIC(container_t) PJ_container_get_root ();
 342 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
 343 XBT_PUBLIC(void) PJ_container_free (container_t container);
 344 XBT_PUBLIC(void) PJ_container_free_all (void);
 345 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
 346
 347 /* instr_paje_types.c */
 348 XBT_PRIVATE void PJ_type_release ();
 349 XBT_PUBLIC(type_t)  PJ_type_get_root ();
 350 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
 351 XBT_PRIVATE type_t PJ_type_state_new (const char *name, type_t father);
 352 XBT_PUBLIC(type_t)  PJ_type_get (const char *name, const type_t father);
 353 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
 354
 355 /* instr_config.c */
 356 XBT_PRIVATE void recursiveDestroyType (type_t type);
 357
 358 XBT_PRIVATE void TRACE_TI_start();
 359 XBT_PRIVATE void TRACE_TI_end();
 360
 361 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 362 XBT_PRIVATE void dump_comment_file (const char *filename);
 363 XBT_PRIVATE void dump_comment (const char *comment);
 364
 365 struct s_instr_extra_data;
 366 typedef struct s_instr_extra_data *instr_extra_data;
 367
 368 typedef enum{
 369   TRACING_INIT,
 370   TRACING_FINALIZE,
 371   TRACING_COMM_SIZE,
 372   TRACING_COMM_SPLIT,
 373   TRACING_COMM_DUP,
 374   TRACING_SEND,
 375   TRACING_ISEND,
 376   TRACING_SSEND,
 377   TRACING_ISSEND,
 378   TRACING_RECV,
 379   TRACING_IRECV,
 380   TRACING_SENDRECV,
 381   TRACING_TEST,
 382   TRACING_WAIT,
 383   TRACING_WAITALL,
 384   TRACING_WAITANY,
 385   TRACING_BARRIER,
 386   TRACING_BCAST,
 387   TRACING_REDUCE,
 388   TRACING_ALLREDUCE,
 389   TRACING_ALLTOALL,
 390   TRACING_ALLTOALLV,
 391   TRACING_GATHER,
 392   TRACING_GATHERV,
 393   TRACING_SCATTER,
 394   TRACING_SCATTERV,
 395   TRACING_ALLGATHER,
 396   TRACING_ALLGATHERV,
 397   TRACING_REDUCE_SCATTER,
 398   TRACING_COMPUTING,
 399   TRACING_SLEEPING,
 400   TRACING_SCAN,
 401   TRACING_EXSCAN
 402 } e_caller_type ;
 403
 404 typedef struct s_instr_extra_data {
 405   e_caller_type type;
 406   int send_size;
 407   int recv_size;
 408   double comp_size;
 409   double sleep_duration;
 410   int src;
 411   int dst;
 412   int root;
 413   const char* datatype1;
 414   const char* datatype2;
 415   int * sendcounts;
 416   int * recvcounts;
 417   int num_processes;
 418 } s_instr_extra_data_t;
 419
 420 /* Format of TRACING output.
 421  *   - paje is the regular format, that we all know
 422  *   - 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.
 423  *     This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
 424  */
 425 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
 426 extern instr_fmt_type_t instr_fmt_type;
 427
 428 SG_END_DECL()
 429
 430 void DefineContainerEvent(type_t type);
 431 void LogVariableTypeDefinition(type_t type);
 432 void LogStateTypeDefinition(type_t type);
 433 void LogLinkTypeDefinition(type_t type, type_t source, type_t dest);
 434 void LogEntityValue(value* val);
 435 void LogContainerCreation (container_t container);
 436 void LogContainerDestruction (container_t container);
 437 void LogDefineEventType(type_t type);
 438
 439 #endif