src/instr/instr_private.hpp

   1 /* Copyright (c) 2010-2018. 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/instr/instr_paje_containers.hpp"
  15 #include "src/instr/instr_paje_events.hpp"
  16 #include "src/instr/instr_paje_types.hpp"
  17 #include "src/instr/instr_paje_values.hpp"
  18 #include "src/internal_config.h"
  19 #include "xbt/graph.h"
  20
  21 #include <iomanip> /** std::setprecision **/
  22 #include <map>
  23 #include <memory>
  24 #include <set>
  25 #include <sstream>
  26 #include <string>
  27 #include <sys/stat.h>
  28 #ifdef WIN32
  29 #include <direct.h> // _mkdir
  30 /* Need to define function drand48 for Windows */
  31 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
  32 #define drand48() (rand() / (RAND_MAX + 1.0))
  33 #endif
  34
  35 typedef simgrid::instr::Container* container_t;
  36
  37 namespace simgrid {
  38 namespace instr {
  39
  40 class TIData {
  41   std::string name_;
  42   double amount_ = 0;
  43
  44 public:
  45   int endpoint                 = 0;
  46   int send_size                = 0;
  47   std::shared_ptr<std::vector<int>> sendcounts = nullptr;
  48   int recv_size                = 0;
  49   std::shared_ptr<std::vector<int>> recvcounts = nullptr;
  50   std::string send_type        = "";
  51   std::string recv_type        = "";
  52
  53   // NoOpTI: init, finalize, test, wait, barrier
  54   explicit TIData(std::string name) : name_(name){};
  55   // CPuTI: compute, sleep (+ waitAny and waitAll out of laziness)
  56   explicit TIData(std::string name, double amount) : name_(name), amount_(amount){};
  57   // Pt2PtTI: send, isend, sssend, issend, recv, irecv
  58   explicit TIData(std::string name, int endpoint, int size, std::string datatype)
  59       : name_(name), endpoint(endpoint), send_size(size), send_type(datatype){};
  60   // CollTI: bcast, reduce, allReduce, gather, scatter, allGather, allToAll
  61   explicit TIData(std::string name, int root, double amount, int send_size, int recv_size, std::string send_type,
  62                   std::string recv_type)
  63       : name_(name)
  64       , amount_(amount)
  65       , endpoint(root)
  66       , send_size(send_size)
  67       , recv_size(recv_size)
  68       , send_type(send_type)
  69       , recv_type(recv_type){};
  70   // VarCollTI: gatherV, scatterV, allGatherV, allToAllV (+ reduceScatter out of laziness)
  71   explicit TIData(std::string name, int root, int send_size, std::vector<int>* sendcounts, int recv_size,
  72                   std::vector<int>* recvcounts, std::string send_type, std::string recv_type)
  73       : TIData(name, root, send_size, std::shared_ptr<std::vector<int>>(sendcounts), recv_size,
  74                std::shared_ptr<std::vector<int>>(recvcounts), send_type, recv_type){};
  75
  76   explicit TIData(std::string name, int root, int send_size, std::shared_ptr<std::vector<int>> sendcounts,
  77                   int recv_size, std::shared_ptr<std::vector<int>> recvcounts, std::string send_type,
  78                   std::string recv_type)
  79       : name_(name)
  80       , endpoint(root)
  81       , send_size(send_size)
  82       , sendcounts(sendcounts)
  83       , recv_size(recv_size)
  84       , recvcounts(recvcounts)
  85       , send_type(send_type)
  86       , recv_type(recv_type){};
  87
  88   virtual ~TIData() {}
  89
  90   std::string getName() { return name_; }
  91   double getAmount() { return amount_; }
  92   virtual std::string print()        = 0;
  93   virtual std::string display_size() = 0;
  94 };
  95
  96 class NoOpTIData : public TIData {
  97 public:
  98   explicit NoOpTIData(std::string name) : TIData(name){};
  99   std::string print() override { return getName(); }
 100   std::string display_size() override { return ""; }
 101 };
 102
 103 class CpuTIData : public TIData {
 104 public:
 105   explicit CpuTIData(std::string name, double amount) : TIData(name, amount){};
 106   std::string print() override
 107   {
 108     std::stringstream stream;
 109     stream << getName() << " " << getAmount();
 110     return stream.str();
 111   }
 112   std::string display_size() override { return std::to_string(getAmount()); }
 113 };
 114
 115 class Pt2PtTIData : public TIData {
 116 public:
 117   explicit Pt2PtTIData(std::string name, int endpoint, int size, std::string datatype)
 118       : TIData(name, endpoint, size, datatype){};
 119   std::string print() override
 120   {
 121     std::stringstream stream;
 122     stream << getName() << " ";
 123     if (endpoint >= 0)
 124       stream << endpoint << " ";
 125     stream << send_size << " " << send_type;
 126     return stream.str();
 127   }
 128   std::string display_size() override { return std::to_string(send_size); }
 129 };
 130
 131 class CollTIData : public TIData {
 132 public:
 133   explicit CollTIData(std::string name, int root, double amount, int send_size, int recv_size, std::string send_type,
 134                       std::string recv_type)
 135       : TIData(name, root, amount, send_size, recv_size, send_type, recv_type){};
 136   std::string print() override
 137   {
 138     std::stringstream stream;
 139     stream << getName() << " " << send_size << " ";
 140     if (recv_size >= 0)
 141       stream << recv_size << " ";
 142     if (getAmount() >= 0.0)
 143       stream << getAmount() << " ";
 144     if (endpoint > 0 || (endpoint == 0 && not send_type.empty()))
 145       stream << endpoint << " ";
 146     stream << send_type << " " << recv_type;
 147
 148     return stream.str();
 149   }
 150   std::string display_size() override { return std::to_string(send_size); }
 151 };
 152
 153 class VarCollTIData : public TIData {
 154 public:
 155   explicit VarCollTIData(std::string name, int root, int send_size, std::vector<int>* sendcounts, int recv_size,
 156                          std::vector<int>* recvcounts, std::string send_type, std::string recv_type)
 157       : TIData(name, root, send_size, sendcounts, recv_size, recvcounts, send_type, recv_type){};
 158
 159   explicit VarCollTIData(std::string name, int root, int send_size, std::shared_ptr<std::vector<int>> sendcounts,
 160                          int recv_size, std::shared_ptr<std::vector<int>> recvcounts, std::string send_type,
 161                          std::string recv_type)
 162       : TIData(name, root, send_size, sendcounts, recv_size, recvcounts, send_type, recv_type){};
 163
 164   std::string print() override
 165   {
 166     std::stringstream stream;
 167     stream << getName() << " ";
 168     if (send_size >= 0)
 169       stream << send_size << " ";
 170     if (sendcounts != nullptr)
 171       for (auto count : *sendcounts)
 172         stream << count << " ";
 173     if (recv_size >= 0)
 174       stream << recv_size << " ";
 175     if (recvcounts != nullptr)
 176       for (auto count : *recvcounts)
 177         stream << count << " ";
 178     if (endpoint > 0 || (endpoint == 0 && not send_type.empty()))
 179       stream << endpoint << " ";
 180     stream << send_type << " " << recv_type;
 181
 182     return stream.str();
 183   }
 184   std::string display_size() override { return std::to_string(send_size > 0 ? send_size : recv_size); }
 185 };
 186 }
 187 }
 188
 189 XBT_PRIVATE std::string instr_pid(s4u_Actor* proc);
 190
 191 extern "C" {
 192
 193 extern XBT_PRIVATE std::set<std::string> created_categories;
 194 extern XBT_PRIVATE std::set<std::string> declared_marks;
 195 extern XBT_PRIVATE std::set<std::string> user_host_variables;
 196 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
 197 extern XBT_PRIVATE std::set<std::string> user_link_variables;
 198 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 199
 200 /* instr_paje_header.c */
 201 XBT_PRIVATE void TRACE_header(bool basic, int size);
 202
 203 /* from paje.c */
 204 XBT_PRIVATE void TRACE_paje_start();
 205 XBT_PRIVATE void TRACE_paje_end();
 206
 207 /* from instr_config.c */
 208 XBT_PRIVATE bool TRACE_needs_platform();
 209 XBT_PRIVATE bool TRACE_is_enabled();
 210 XBT_PRIVATE bool TRACE_platform();
 211 XBT_PRIVATE bool TRACE_platform_topology();
 212 XBT_PRIVATE bool TRACE_is_configured();
 213 XBT_PRIVATE bool TRACE_categorized();
 214 XBT_PRIVATE bool TRACE_uncategorized();
 215 XBT_PRIVATE bool TRACE_actor_is_enabled();
 216 XBT_PRIVATE bool TRACE_vm_is_enabled();
 217 XBT_PRIVATE bool TRACE_buffer();
 218 XBT_PRIVATE bool TRACE_disable_link();
 219 XBT_PRIVATE bool TRACE_disable_speed();
 220 XBT_PRIVATE bool TRACE_disable_destroy();
 221 XBT_PRIVATE bool TRACE_basic();
 222 XBT_PRIVATE bool TRACE_display_sizes();
 223 XBT_PRIVATE int TRACE_precision();
 224
 225 /* Public functions used in SMPI */
 226 XBT_PUBLIC bool TRACE_smpi_is_enabled();
 227 XBT_PUBLIC bool TRACE_smpi_is_grouped();
 228 XBT_PUBLIC bool TRACE_smpi_is_computing();
 229 XBT_PUBLIC bool TRACE_smpi_is_sleeping();
 230 XBT_PUBLIC bool TRACE_smpi_view_internals();
 231
 232 /* from resource_utilization.c */
 233 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char* resource, const char* category, double value, double now,
 234                                                  double delta);
 235 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char* resource, const char* category, double value, double now,
 236                                                  double delta);
 237
 238 /* instr_paje.c */
 239 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
 240 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
 241 XBT_PRIVATE long long int instr_new_paje_id();
 242 void instr_new_variable_type(std::string new_typename, std::string color);
 243 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color);
 244 void instr_new_user_state_type(std::string father_type, std::string new_typename);
 245 void instr_new_value_for_user_state_type(std::string new_typename, const char* value, std::string color);
 246
 247 /* instr_config.c */
 248 XBT_PRIVATE void TRACE_TI_start();
 249 XBT_PRIVATE void TRACE_TI_end();
 250
 251 XBT_PRIVATE void TRACE_paje_dump_buffer(bool force);
 252 XBT_PRIVATE void dump_comment_file(std::string filename);
 253 XBT_PRIVATE void dump_comment(std::string comment);
 254
 255 /* Format of TRACING output.
 256  *   - paje is the regular format, that we all know
 257  *   - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
 258  *     trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
 259  *     using the signal that we will create to cleanup the TRACING
 260  */
 261 enum instr_fmt_type_t { instr_fmt_paje, instr_fmt_TI };
 262 extern instr_fmt_type_t instr_fmt_type;
 263 }
 264 XBT_PRIVATE std::string TRACE_get_comment();
 265 XBT_PRIVATE std::string TRACE_get_comment_file();
 266 XBT_PRIVATE std::string TRACE_get_filename();
 267
 268 #endif