src/instr/instr_private.hpp

   1 /* Copyright (c) 2010-2020. 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 "simgrid/instr.h"
  12 #include "simgrid/s4u/Actor.hpp"
  13 #include "src/instr/instr_paje_containers.hpp"
  14 #include "src/instr/instr_paje_events.hpp"
  15 #include "src/instr/instr_paje_types.hpp"
  16 #include "src/instr/instr_paje_values.hpp"
  17 #include "xbt/graph.h"
  18
  19 #include <fstream>
  20 #include <iomanip> /** std::setprecision **/
  21 #include <iostream>
  22 #include <map>
  23 #include <memory>
  24 #include <set>
  25 #include <sstream>
  26 #include <string>
  27
  28 typedef simgrid::instr::Container* container_t;
  29
  30 namespace simgrid {
  31 namespace instr {
  32 void init();
  33 void define_callbacks();
  34
  35 void platform_graph_export_graphviz(const std::string& output_filename);
  36
  37 void resource_set_utilization(const char* type, const char* name, const char* resource, const std::string& category,
  38                               double value, double now, double delta);
  39
  40 /* Format of TRACING output.
  41  *   - paje is the regular format, that we all know
  42  *   - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
  43  *     trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
  44  *     using the signal that we will create to cleanup the TRACING
  45  */
  46 enum class TraceFormat { Paje, /*TimeIndependent*/ Ti };
  47 extern TraceFormat trace_format;
  48
  49 class TIData {
  50   std::string name_;
  51   double amount_ = 0;
  52
  53 public:
  54   int endpoint                 = 0;
  55   int send_size                = 0;
  56   std::shared_ptr<std::vector<int>> sendcounts = nullptr;
  57   int recv_size                = 0;
  58   std::shared_ptr<std::vector<int>> recvcounts = nullptr;
  59   std::string send_type        = "";
  60   std::string recv_type        = "";
  61
  62   // NoOpTI: init, finalize, test, wait, barrier
  63   explicit TIData(const std::string& name) : name_(name){};
  64   // CPuTI: compute, sleep (+ waitAny and waitall out of laziness)
  65   explicit TIData(const std::string& name, double amount) : name_(name), amount_(amount){};
  66   // Pt2PtTI: send, isend, ssend, issend, recv, irecv
  67   explicit TIData(const std::string& name, int endpoint, int size, const std::string& datatype)
  68       : name_(name), endpoint(endpoint), send_size(size), send_type(datatype){};
  69   // CollTI: bcast, reduce, allreduce, gather, scatter, allgather, alltoall
  70   explicit TIData(const std::string& name, int root, double amount, int send_size, int recv_size,
  71                   const std::string& send_type, const std::string& recv_type)
  72       : name_(name)
  73       , amount_(amount)
  74       , endpoint(root)
  75       , send_size(send_size)
  76       , recv_size(recv_size)
  77       , send_type(send_type)
  78       , recv_type(recv_type){};
  79   // VarCollTI: gatherv, scatterv, allgatherv, alltoallv (+ reducescatter out of laziness)
  80   explicit TIData(const std::string& name, int root, int send_size, std::vector<int>* sendcounts, int recv_size,
  81                   std::vector<int>* recvcounts, const std::string& send_type, const std::string& recv_type)
  82       : TIData(name, root, send_size, std::shared_ptr<std::vector<int>>(sendcounts), recv_size,
  83                std::shared_ptr<std::vector<int>>(recvcounts), send_type, recv_type){};
  84
  85   explicit TIData(const std::string& name, int root, int send_size, std::shared_ptr<std::vector<int>> sendcounts,
  86                   int recv_size, std::shared_ptr<std::vector<int>> recvcounts, const std::string& send_type,
  87                   const std::string& recv_type)
  88       : name_(name)
  89       , endpoint(root)
  90       , send_size(send_size)
  91       , sendcounts(sendcounts)
  92       , recv_size(recv_size)
  93       , recvcounts(recvcounts)
  94       , send_type(send_type)
  95       , recv_type(recv_type){};
  96
  97   virtual ~TIData() {}
  98
  99   const std::string& getName() const { return name_; }
 100   double getAmount() { return amount_; }
 101   virtual std::string print()        = 0;
 102   virtual std::string display_size() = 0;
 103 };
 104
 105 class NoOpTIData : public TIData {
 106 public:
 107   explicit NoOpTIData(const std::string& name) : TIData(name){};
 108   std::string print() override { return getName(); }
 109   std::string display_size() override { return "NA"; }
 110 };
 111
 112 class CpuTIData : public TIData {
 113 public:
 114   explicit CpuTIData(const std::string& name, double amount) : TIData(name, amount){};
 115   std::string print() override
 116   {
 117     std::stringstream stream;
 118     stream << getName() << " " << getAmount();
 119     return stream.str();
 120   }
 121   std::string display_size() override { return std::to_string(getAmount()); }
 122 };
 123
 124 class Pt2PtTIData : public TIData {
 125   int tag = 0;
 126
 127 public:
 128   explicit Pt2PtTIData(const std::string& name, int endpoint, int size, int tag, const std::string& datatype)
 129       : TIData(name, endpoint, size, datatype), tag(tag){};
 130
 131   explicit Pt2PtTIData(const std::string& name, int endpoint, int size, const std::string& datatype)
 132       : TIData(name, endpoint, size, datatype){};
 133   std::string print() override
 134   {
 135     std::stringstream stream;
 136     stream << getName() << " " << endpoint << " ";
 137     stream << tag << " " << send_size << " " << send_type;
 138     return stream.str();
 139   }
 140   std::string display_size() override { return std::to_string(send_size); }
 141 };
 142
 143 class CollTIData : public TIData {
 144 public:
 145   explicit CollTIData(const std::string& name, int root, double amount, int send_size, int recv_size,
 146                       const std::string& send_type, const std::string& recv_type)
 147       : TIData(name, root, amount, send_size, recv_size, send_type, recv_type){};
 148   std::string print() override
 149   {
 150     std::stringstream stream;
 151     stream << getName() << " " << send_size << " ";
 152     if (recv_size >= 0)
 153       stream << recv_size << " ";
 154     if (getAmount() >= 0.0)
 155       stream << getAmount() << " ";
 156     if (endpoint > 0 || (endpoint == 0 && not send_type.empty()))
 157       stream << endpoint << " ";
 158     stream << send_type << " " << recv_type;
 159
 160     return stream.str();
 161   }
 162   std::string display_size() override { return std::to_string(send_size); }
 163 };
 164
 165 class VarCollTIData : public TIData {
 166 public:
 167   explicit VarCollTIData(const std::string& name, int root, int send_size, std::vector<int>* sendcounts, int recv_size,
 168                          std::vector<int>* recvcounts, const std::string& send_type, const std::string& recv_type)
 169       : TIData(name, root, send_size, sendcounts, recv_size, recvcounts, send_type, recv_type){};
 170
 171   explicit VarCollTIData(const std::string& name, int root, int send_size, std::shared_ptr<std::vector<int>> sendcounts,
 172                          int recv_size, std::shared_ptr<std::vector<int>> recvcounts, const std::string& send_type,
 173                          const std::string& recv_type)
 174       : TIData(name, root, send_size, sendcounts, recv_size, recvcounts, send_type, recv_type){};
 175
 176   std::string print() override
 177   {
 178     std::stringstream stream;
 179     stream << getName() << " ";
 180     if (send_size >= 0)
 181       stream << send_size << " ";
 182     if (sendcounts != nullptr)
 183       for (auto count : *sendcounts)
 184         stream << count << " ";
 185     if (recv_size >= 0)
 186       stream << recv_size << " ";
 187     if (recvcounts != nullptr)
 188       for (auto count : *recvcounts)
 189         stream << count << " ";
 190     if (endpoint > 0 || (endpoint == 0 && not send_type.empty()))
 191       stream << endpoint << " ";
 192     stream << send_type << " " << recv_type;
 193
 194     return stream.str();
 195   }
 196   std::string display_size() override { return std::to_string(send_size > 0 ? send_size : recv_size); }
 197 };
 198
 199 /**
 200  * If we want to wait for a request of asynchronous communication, we need to be able
 201  * to identify this request. We do this by searching for a request identified by (src, dest, tag).
 202  */
 203 class WaitTIData : public TIData {
 204   int src;
 205   int dest;
 206   int tag;
 207
 208 public:
 209   explicit WaitTIData(int src, int dest, int tag) : TIData("wait"), src(src), dest(dest), tag(tag){};
 210
 211   std::string print() override
 212   {
 213     std::stringstream stream;
 214     stream << getName() << " " << src << " " << dest << " " << tag;
 215
 216     return stream.str();
 217   }
 218
 219   std::string display_size() override { return "NA"; }
 220 };
 221
 222 class AmpiMigrateTIData : public TIData {
 223   size_t memory_consumption;
 224 public:
 225   explicit AmpiMigrateTIData(size_t memory_conso) : TIData("migrate"), memory_consumption(memory_conso) { };
 226
 227   std::string print() override
 228   {
 229     std::stringstream stream;
 230     stream << getName() << " " << memory_consumption;
 231
 232     return stream.str();
 233   }
 234
 235   std::string display_size() override { return "NA"; }
 236 };
 237 }
 238 }
 239
 240 XBT_PRIVATE std::string instr_pid(simgrid::s4u::Actor const& proc);
 241
 242 extern XBT_PRIVATE std::set<std::string> created_categories;
 243 extern XBT_PRIVATE std::set<std::string> declared_marks;
 244 extern XBT_PRIVATE std::set<std::string> user_host_variables;
 245 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
 246 extern XBT_PRIVATE std::set<std::string> user_link_variables;
 247 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 248
 249 /* instr_paje_header.c */
 250 XBT_PRIVATE void TRACE_header(bool basic, bool size);
 251
 252 /* from instr_config.c */
 253 XBT_PRIVATE bool TRACE_needs_platform();
 254 XBT_PRIVATE bool TRACE_is_enabled();
 255 XBT_PRIVATE bool TRACE_platform();
 256 XBT_PRIVATE bool TRACE_platform_topology();
 257 XBT_PRIVATE bool TRACE_categorized();
 258 XBT_PRIVATE bool TRACE_uncategorized();
 259 XBT_PRIVATE bool TRACE_actor_is_enabled();
 260 XBT_PRIVATE bool TRACE_vm_is_enabled();
 261 XBT_PRIVATE bool TRACE_disable_link();
 262 XBT_PRIVATE bool TRACE_disable_speed();
 263 XBT_PRIVATE bool TRACE_basic();
 264 XBT_PRIVATE bool TRACE_display_sizes();
 265 XBT_PRIVATE int TRACE_precision();
 266
 267 /* Public functions used in SMPI */
 268 XBT_PUBLIC bool TRACE_smpi_is_enabled();
 269 XBT_PUBLIC bool TRACE_smpi_is_grouped();
 270 XBT_PUBLIC bool TRACE_smpi_is_computing();
 271 XBT_PUBLIC bool TRACE_smpi_is_sleeping();
 272 XBT_PUBLIC bool TRACE_smpi_view_internals();
 273
 274 /* instr_paje.c */
 275 XBT_PRIVATE long long int instr_new_paje_id();
 276 void instr_new_variable_type(const std::string& new_typename, const std::string& color);
 277 void instr_new_user_variable_type(const std::string& father_type, const std::string& new_typename,
 278                                   const std::string& color);
 279 void instr_new_user_state_type(const std::string& father_type, const std::string& new_typename);
 280 void instr_new_value_for_user_state_type(const std::string& new_typename, const char* value, const std::string& color);
 281
 282 XBT_PRIVATE void TRACE_help();
 283
 284 XBT_PRIVATE void TRACE_paje_dump_buffer(bool force);
 285 XBT_PRIVATE void dump_comment_file(const std::string& filename);
 286
 287 XBT_PRIVATE std::string TRACE_get_filename();
 288
 289
 290 #endif