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 };
  80
  81 //--------------------------------------------------
  82 class value : public ess_type{
  83 public:
  84   type_t father;
  85   value* ret;
  86   value(const char* name, const char* color, type_t father);
  87   ~value();
  88   static value* get_or_new(const char* name, const char* color, type_t father);
  89   static value* get(const char* name, type_t father);
  90 };
  91
  92
  93 //--------------------------------------------------
  94 typedef enum {
  95   INSTR_HOST,
  96   INSTR_LINK,
  97   INSTR_ROUTER,
  98   INSTR_AS,
  99   INSTR_SMPI,
 100   INSTR_MSG_VM,
 101   INSTR_MSG_PROCESS,
 102   INSTR_MSG_TASK
 103 } e_container_types;
 104
 105 //--------------------------------------------------
 106 class s_container;
 107 typedef s_container *container_t;
 108
 109 class s_container {
 110   public:
 111   sg_netpoint_t netpoint;
 112   char *name;     /* Unique name of this container */
 113   char *id;       /* Unique id of this container */
 114   type_t type;    /* Type of this container */
 115   int level;      /* Level in the hierarchy, root level is 0 */
 116   e_container_types kind; /* This container is of what kind */
 117   s_container *father;
 118   xbt_dict_t children;
 119 };
 120
 121 //--------------------------------------------------
 122 class PajeEvent {
 123   public:
 124   double timestamp;
 125   e_event_type event_type;
 126   virtual void print() = 0;
 127   void *data;
 128   virtual ~PajeEvent();
 129 };
 130
 131 //--------------------------------------------------
 132
 133 class DefineVariableTypeEvent : public PajeEvent
 134 {
 135   public:
 136   type_t type;
 137    DefineVariableTypeEvent(type_t type);
 138    void print() override;
 139 };
 140 //--------------------------------------------------
 141
 142 class DefineStateTypeEvent : public PajeEvent  {
 143   type_t type;
 144   public:
 145   DefineStateTypeEvent(type_t type);
 146   void print() override;
 147 };
 148
 149
 150 class SetVariableEvent : public PajeEvent  {
 151   private:
 152   container_t container;
 153   type_t type;
 154   double value;
 155   public:
 156   SetVariableEvent (double timestamp, container_t container, type_t type, double value);
 157   void print() override;
 158 };
 159
 160
 161 class AddVariableEvent:public PajeEvent {
 162   private:
 163   container_t container;
 164   type_t type;
 165   double value;
 166   public:
 167   AddVariableEvent (double timestamp, container_t container, type_t type, double value);
 168   void print() override;
 169 };
 170
 171 //--------------------------------------------------
 172
 173
 174 class SubVariableEvent : public PajeEvent  {
 175   private:
 176   container_t container;
 177   type_t type;
 178   double value;
 179   public:
 180   SubVariableEvent(double timestamp, container_t container, type_t type, double value);
 181   void print() override;
 182 };
 183 //--------------------------------------------------
 184
 185 class SetStateEvent : public PajeEvent  {
 186   private:
 187   container_t container;
 188   type_t type;
 189   value* val;
 190   const char* filename;
 191   int linenumber;
 192   public:
 193     SetStateEvent(double timestamp, container_t container, type_t type, value* val);
 194     void print() override;
 195 };
 196
 197
 198 class PushStateEvent : public PajeEvent  {
 199   public:
 200   container_t container;
 201   type_t type;
 202   value* val;
 203   int size;
 204   const char* filename;
 205   int linenumber;
 206   void* extra_;
 207   public:
 208     PushStateEvent(double timestamp, container_t container, type_t type, value* val);
 209     PushStateEvent(double timestamp, container_t container, type_t type, value* val, void* extra);
 210     void print() override;
 211 };
 212
 213 class PopStateEvent : public PajeEvent  {
 214   container_t container;
 215   type_t type;
 216   public:
 217   PopStateEvent (double timestamp, container_t container, type_t type);
 218   void print() override;
 219 };
 220
 221 class ResetStateEvent : public PajeEvent  {
 222   container_t container;
 223   type_t type;
 224   public:
 225   ResetStateEvent (double timestamp, container_t container, type_t type);
 226   void print() override;
 227 };
 228
 229 class StartLinkEvent : public PajeEvent  {
 230   public:
 231   container_t container;
 232   type_t type;
 233   container_t sourceContainer;
 234   char *value;
 235   char *key;
 236   int size;
 237   public:
 238     ~StartLinkEvent();
 239     StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
 240                    const char* key);
 241     StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
 242                    const char* key, int size);
 243     void print() override;
 244 };
 245
 246 class EndLinkEvent : public PajeEvent  {
 247   container_t container;
 248   type_t type;
 249   container_t destContainer;
 250   char *value;
 251   char *key;
 252   public:
 253   EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
 254                                   const char *value, const char *key);
 255   ~EndLinkEvent();
 256   void print() override;
 257 };
 258
 259
 260 class NewEvent : public PajeEvent  {
 261   public:
 262   container_t container;
 263   type_t type;
 264   value* val;
 265
 266 public:
 267   NewEvent(double timestamp, container_t container, type_t type, value* val);
 268   void print() override;
 269
 270 };
 271
 272 extern XBT_PRIVATE std::set<std::string> created_categories;
 273 extern XBT_PRIVATE std::set<std::string> declared_marks;
 274 extern XBT_PRIVATE std::set<std::string> user_host_variables;
 275 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
 276 extern XBT_PRIVATE std::set<std::string> user_link_variables;
 277 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 278
 279 /* instr_paje_header.c */
 280 XBT_PRIVATE void TRACE_header(int basic, int size);
 281
 282 /* from paje.c */
 283 XBT_PRIVATE void TRACE_paje_start();
 284 XBT_PRIVATE void TRACE_paje_end();
 285 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
 286
 287
 288 /* from instr_config.c */
 289 XBT_PRIVATE bool TRACE_needs_platform ();
 290 XBT_PRIVATE bool TRACE_is_enabled();
 291 XBT_PRIVATE bool TRACE_platform();
 292 XBT_PRIVATE bool TRACE_platform_topology();
 293 XBT_PRIVATE bool TRACE_is_configured();
 294 XBT_PRIVATE bool TRACE_categorized ();
 295 XBT_PRIVATE bool TRACE_uncategorized ();
 296 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
 297 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
 298 XBT_PRIVATE bool TRACE_buffer ();
 299 XBT_PRIVATE bool TRACE_disable_link();
 300 XBT_PRIVATE bool TRACE_disable_speed();
 301 XBT_PRIVATE bool TRACE_onelink_only ();
 302 XBT_PRIVATE bool TRACE_disable_destroy ();
 303 XBT_PRIVATE bool TRACE_basic ();
 304 XBT_PRIVATE bool TRACE_display_sizes ();
 305 XBT_PRIVATE char *TRACE_get_comment ();
 306 XBT_PRIVATE char *TRACE_get_comment_file ();
 307 XBT_PRIVATE int TRACE_precision ();
 308 XBT_PRIVATE char *TRACE_get_filename();
 309 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
 310 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
 311 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
 312 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
 313 XBT_PRIVATE void instr_pause_tracing ();
 314 XBT_PRIVATE void instr_resume_tracing ();
 315
 316 /* Public functions used in SMPI */
 317 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
 318 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
 319 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
 320 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
 321 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
 322
 323 /* from resource_utilization.c */
 324 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
 325                                      double delta);
 326 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
 327                                      double delta);
 328 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
 329
 330 /* instr_paje.c */
 331 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
 332 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
 333 XBT_PRIVATE long long int instr_new_paje_id ();
 334 XBT_PRIVATE void PJ_container_alloc ();
 335 XBT_PRIVATE void PJ_container_release ();
 336 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
 337 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
 338 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
 339 XBT_PUBLIC(container_t) PJ_container_get_root ();
 340 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
 341 XBT_PUBLIC(void) PJ_container_free (container_t container);
 342 XBT_PUBLIC(void) PJ_container_free_all (void);
 343 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
 344
 345 /* instr_paje_types.c */
 346 XBT_PRIVATE void PJ_type_release ();
 347 XBT_PUBLIC(type_t)  PJ_type_get_root ();
 348 XBT_PRIVATE type_t PJ_type_event_new (const char *name, type_t father);
 349 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
 350 XBT_PRIVATE XBT_PRIVATE type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
 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