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