src/instr/instr_private.hpp

   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_HPP
   7 #define INSTR_PRIVATE_HPP
   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 "xbt/graph.h"
  16 #include <iomanip> /** std::setprecision **/
  17 #include <map>
  18 #include <set>
  19 #include <sstream>
  20 #include <string>
  21 #include <sys/stat.h>
  22 #ifdef WIN32
  23 #include <direct.h> // _mkdir
  24 /* Need to define function drand48 for Windows */
  25 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
  26 #define drand48() (rand() / (RAND_MAX + 1.0))
  27 #endif
  28
  29 #define INSTR_DEFAULT_STR_SIZE 500
  30
  31 namespace simgrid {
  32 namespace instr {
  33
  34 class Value;
  35
  36 enum e_event_type {
  37   PAJE_DefineContainerType,
  38   PAJE_DefineVariableType,
  39   PAJE_DefineStateType,
  40   PAJE_DefineEventType,
  41   PAJE_DefineLinkType,
  42   PAJE_DefineEntityValue,
  43   PAJE_CreateContainer,
  44   PAJE_DestroyContainer,
  45   PAJE_SetVariable,
  46   PAJE_AddVariable,
  47   PAJE_SubVariable,
  48   PAJE_SetState,
  49   PAJE_PushState,
  50   PAJE_PopState,
  51   PAJE_ResetState,
  52   PAJE_StartLink,
  53   PAJE_EndLink,
  54   PAJE_NewEvent
  55 };
  56
  57 //--------------------------------------------------
  58 enum e_entity_types { TYPE_VARIABLE, TYPE_LINK, TYPE_CONTAINER, TYPE_STATE, TYPE_EVENT };
  59
  60 class Type {
  61   std::string id_;
  62   std::string name_;
  63   std::string color_;
  64   e_entity_types kind_;
  65   Type* father_;
  66
  67 public:
  68   std::map<std::string, Type*> children_;
  69   std::map<std::string, Value*> values_; // valid for all types except variable and container
  70
  71   Type(std::string name, std::string alias, std::string color, e_entity_types kind, Type* father);
  72   ~Type();
  73
  74   std::string getName() { return name_; }
  75   const char* getCname() { return name_.c_str(); }
  76   const char* getId() { return id_.c_str(); }
  77   e_entity_types getKind() { return kind_; }
  78   bool isColored() { return not color_.empty(); }
  79
  80   Type* byName(std::string name);
  81
  82   Type* getOrCreateContainerType(std::string name);
  83   Type* getOrCreateEventType(std::string name);
  84   Type* getOrCreateLinkType(std::string name, Type* source, Type* dest);
  85   Type* getOrCreateStateType(std::string name);
  86   Type* getOrCreateVariableType(std::string name, std::string color);
  87
  88   void logContainerTypeDefinition();
  89   void logVariableTypeDefinition();
  90   void logStateTypeDefinition();
  91   void logLinkTypeDefinition(simgrid::instr::Type* source, simgrid::instr::Type* dest);
  92   void logDefineEventType();
  93
  94   static Type* createRootType();
  95   static Type* getRootType();
  96 };
  97
  98 //--------------------------------------------------
  99 class Value {
 100   std::string name_;
 101   std::string id_;
 102   std::string color_;
 103   Type* father_;
 104
 105   explicit Value(std::string name, std::string color, Type* father);
 106
 107 public:
 108   ~Value();
 109   static Value* byNameOrCreate(std::string name, std::string color, Type* father);
 110   static Value* byName(std::string name, Type* father);
 111   const char* getCname() { return name_.c_str(); }
 112   const char* getId() { return id_.c_str(); }
 113   bool isColored() { return not color_.empty(); }
 114   void print();
 115 };
 116
 117 //--------------------------------------------------
 118 enum e_container_types {
 119   INSTR_HOST,
 120   INSTR_LINK,
 121   INSTR_ROUTER,
 122   INSTR_AS,
 123   INSTR_SMPI,
 124   INSTR_MSG_VM,
 125   INSTR_MSG_PROCESS,
 126   INSTR_MSG_TASK
 127 };
 128
 129 class Container {
 130   e_container_types kind_; /* This container is of what kind */
 131   int level_ = 0;          /* Level in the hierarchy, root level is 0 */
 132   sg_netpoint_t netpoint_ = nullptr;
 133
 134 public:
 135   Container(std::string name, simgrid::instr::e_container_types kind, Container* father);
 136   virtual ~Container();
 137
 138   std::string name_;       /* Unique name of this container */
 139   std::string id_;         /* Unique id of this container */
 140   Type* type_;             /* Type of this container */
 141   Container* father_;
 142   std::map<std::string, Container*> children_;
 143   static Container* byNameOrNull(std::string name);
 144   static Container* byName(std::string name);
 145   void removeFromParent();
 146   void logCreation();
 147   void logDestruction();
 148 };
 149
 150 //--------------------------------------------------
 151 class PajeEvent {
 152 protected:
 153   Container* container;
 154   Type* type;
 155
 156 public:
 157   double timestamp_;
 158   e_event_type eventType_;
 159   PajeEvent(Container* container, Type* type, double timestamp, e_event_type eventType)
 160       : container(container), type(type), timestamp_(timestamp), eventType_(eventType){};
 161   virtual void print() = 0;
 162   virtual ~PajeEvent();
 163   void insertIntoBuffer();
 164 };
 165
 166 //--------------------------------------------------
 167 class SetVariableEvent : public PajeEvent {
 168   double value;
 169
 170 public:
 171   SetVariableEvent(double timestamp, Container* container, Type* type, double value);
 172   void print() override;
 173 };
 174
 175 class AddVariableEvent : public PajeEvent {
 176   double value;
 177
 178 public:
 179   AddVariableEvent(double timestamp, Container* container, Type* type, double value);
 180   void print() override;
 181 };
 182 //--------------------------------------------------
 183
 184 class SubVariableEvent : public PajeEvent {
 185   double value;
 186
 187 public:
 188   SubVariableEvent(double timestamp, Container* container, Type* type, double value);
 189   void print() override;
 190 };
 191 //--------------------------------------------------
 192
 193 class SetStateEvent : public PajeEvent {
 194   Value* value;
 195   const char* filename;
 196   int linenumber;
 197
 198 public:
 199   SetStateEvent(double timestamp, Container* container, Type* type, Value* val);
 200   void print() override;
 201 };
 202
 203 class PushStateEvent : public PajeEvent {
 204   Value* value;
 205   const char* filename;
 206   int linenumber;
 207   void* extra_;
 208
 209 public:
 210   PushStateEvent(double timestamp, Container* container, Type* type, Value* val);
 211   PushStateEvent(double timestamp, Container* container, Type* type, Value* val, void* extra);
 212   void print() override;
 213 };
 214
 215 class PopStateEvent : public PajeEvent {
 216 public:
 217   PopStateEvent(double timestamp, Container* container, Type* type);
 218   void print() override;
 219 };
 220
 221 class ResetStateEvent : public PajeEvent {
 222 public:
 223   ResetStateEvent(double timestamp, Container* container, Type* type);
 224   void print() override;
 225 };
 226
 227 class StartLinkEvent : public PajeEvent {
 228   Container* sourceContainer_;
 229   std::string value_;
 230   std::string key_;
 231   int size_;
 232
 233 public:
 234   StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
 235                  std::string key);
 236   StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
 237                  std::string key, int size);
 238   void print() override;
 239 };
 240
 241 class EndLinkEvent : public PajeEvent {
 242   Container* destContainer;
 243   std::string value;
 244   std::string key;
 245
 246 public:
 247   EndLinkEvent(double timestamp, Container* container, Type* type, Container* destContainer, std::string value,
 248                std::string key);
 249   ~EndLinkEvent() = default;
 250   void print() override;
 251 };
 252
 253 class NewEvent : public PajeEvent {
 254   Value* val;
 255
 256 public:
 257   NewEvent(double timestamp, Container* container, Type* type, Value* val);
 258   void print() override;
 259 };
 260 }
 261 } // namespace simgrid::instr
 262 typedef simgrid::instr::Container* container_t;
 263
 264 extern "C" {
 265
 266 extern XBT_PRIVATE std::set<std::string> created_categories;
 267 extern XBT_PRIVATE std::set<std::string> declared_marks;
 268 extern XBT_PRIVATE std::set<std::string> user_host_variables;
 269 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
 270 extern XBT_PRIVATE std::set<std::string> user_link_variables;
 271 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 272
 273 /* instr_paje_header.c */
 274 XBT_PRIVATE void TRACE_header(bool basic, int size);
 275
 276 /* from paje.c */
 277 XBT_PRIVATE void TRACE_paje_start();
 278 XBT_PRIVATE void TRACE_paje_end();
 279
 280 /* from instr_config.c */
 281 XBT_PRIVATE bool TRACE_needs_platform();
 282 XBT_PRIVATE bool TRACE_is_enabled();
 283 XBT_PRIVATE bool TRACE_platform();
 284 XBT_PRIVATE bool TRACE_platform_topology();
 285 XBT_PRIVATE bool TRACE_is_configured();
 286 XBT_PRIVATE bool TRACE_categorized();
 287 XBT_PRIVATE bool TRACE_uncategorized();
 288 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
 289 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
 290 XBT_PRIVATE bool TRACE_buffer();
 291 XBT_PRIVATE bool TRACE_disable_link();
 292 XBT_PRIVATE bool TRACE_disable_speed();
 293 XBT_PRIVATE bool TRACE_onelink_only();
 294 XBT_PRIVATE bool TRACE_disable_destroy();
 295 XBT_PRIVATE bool TRACE_basic();
 296 XBT_PRIVATE bool TRACE_display_sizes();
 297 XBT_PRIVATE char* TRACE_get_comment();
 298 XBT_PRIVATE char* TRACE_get_comment_file();
 299 XBT_PRIVATE int TRACE_precision();
 300 XBT_PRIVATE char* TRACE_get_filename();
 301 XBT_PRIVATE char* TRACE_get_viva_uncat_conf();
 302 XBT_PRIVATE char* TRACE_get_viva_cat_conf();
 303 XBT_PRIVATE void TRACE_generate_viva_uncat_conf();
 304 XBT_PRIVATE void TRACE_generate_viva_cat_conf();
 305 XBT_PRIVATE void instr_pause_tracing();
 306 XBT_PRIVATE void instr_resume_tracing();
 307
 308 /* Public functions used in SMPI */
 309 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
 310 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
 311 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
 312 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
 313 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
 314
 315 /* from resource_utilization.c */
 316 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char* resource, const char* category, double value, double now,
 317                                                  double delta);
 318 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char* resource, const char* category, double value, double now,
 319                                                  double delta);
 320 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
 321
 322 /* instr_paje.c */
 323 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
 324 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
 325 XBT_PRIVATE long long int instr_new_paje_id();
 326 XBT_PUBLIC(container_t) PJ_container_get_root ();
 327 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
 328
 329 /* instr_config.c */
 330 XBT_PRIVATE void TRACE_TI_start();
 331 XBT_PRIVATE void TRACE_TI_end();
 332
 333 XBT_PRIVATE void TRACE_paje_dump_buffer(bool force);
 334 XBT_PRIVATE void dump_comment_file(std::string filename);
 335 XBT_PRIVATE void dump_comment(std::string comment);
 336
 337 enum e_caller_type {
 338   TRACING_INIT,
 339   TRACING_FINALIZE,
 340   TRACING_COMM_SIZE,
 341   TRACING_COMM_SPLIT,
 342   TRACING_COMM_DUP,
 343   TRACING_SEND,
 344   TRACING_ISEND,
 345   TRACING_SSEND,
 346   TRACING_ISSEND,
 347   TRACING_RECV,
 348   TRACING_IRECV,
 349   TRACING_SENDRECV,
 350   TRACING_TEST,
 351   TRACING_WAIT,
 352   TRACING_WAITALL,
 353   TRACING_WAITANY,
 354   TRACING_BARRIER,
 355   TRACING_BCAST,
 356   TRACING_REDUCE,
 357   TRACING_ALLREDUCE,
 358   TRACING_ALLTOALL,
 359   TRACING_ALLTOALLV,
 360   TRACING_GATHER,
 361   TRACING_GATHERV,
 362   TRACING_SCATTER,
 363   TRACING_SCATTERV,
 364   TRACING_ALLGATHER,
 365   TRACING_ALLGATHERV,
 366   TRACING_REDUCE_SCATTER,
 367   TRACING_COMPUTING,
 368   TRACING_SLEEPING,
 369   TRACING_SCAN,
 370   TRACING_EXSCAN
 371 };
 372
 373 struct s_instr_extra_data_t {
 374   e_caller_type type;
 375   int send_size;
 376   int recv_size;
 377   double comp_size;
 378   double sleep_duration;
 379   int src;
 380   int dst;
 381   int root;
 382   const char* datatype1;
 383   const char* datatype2;
 384   int* sendcounts;
 385   int* recvcounts;
 386   int num_processes;
 387 };
 388 typedef s_instr_extra_data_t* instr_extra_data;
 389
 390 /* Format of TRACING output.
 391  *   - paje is the regular format, that we all know
 392  *   - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
 393  *     trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
 394  *     using the signal that we will create to cleanup the TRACING
 395  */
 396 enum instr_fmt_type_t { instr_fmt_paje, instr_fmt_TI };
 397 extern instr_fmt_type_t instr_fmt_type;
 398 }
 399
 400 #endif