Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add the Storage::read_async and Storage::write_async methods
[simgrid.git] / src / instr / instr_private.hpp
index 97b9e9b..bf594db 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -8,15 +8,20 @@
 
 #include <xbt/base.h>
 
-#include "instr/instr_interface.h"
 #include "simgrid/instr.h"
-#include "simgrid_config.h"
+#include "simgrid/s4u/Actor.hpp"
 #include "src/instr/instr_paje_containers.hpp"
+#include "src/instr/instr_paje_events.hpp"
 #include "src/instr/instr_paje_types.hpp"
+#include "src/instr/instr_paje_values.hpp"
 #include "src/internal_config.h"
 #include "xbt/graph.h"
+
+#include <fstream>
 #include <iomanip> /** std::setprecision **/
+#include <iostream>
 #include <map>
+#include <memory>
 #include <set>
 #include <sstream>
 #include <string>
 #ifdef WIN32
 #include <direct.h> // _mkdir
 /* Need to define function drand48 for Windows */
-/* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
 #define drand48() (rand() / (RAND_MAX + 1.0))
 #endif
 
+typedef simgrid::instr::Container* container_t;
+
 namespace simgrid {
 namespace instr {
 
-class Container;
-class Type;
-class EntityValue;
-class ContainerType;
-class EventType;
-class LinkType;
-class StateType;
-class VariableType;
-
-enum e_event_type : unsigned int {
-  PAJE_DefineContainerType,
-  PAJE_DefineVariableType,
-  PAJE_DefineStateType,
-  PAJE_DefineEventType,
-  PAJE_DefineLinkType,
-  PAJE_DefineEntityValue,
-  PAJE_CreateContainer,
-  PAJE_DestroyContainer,
-  PAJE_SetVariable,
-  PAJE_AddVariable,
-  PAJE_SubVariable,
-  PAJE_SetState,
-  PAJE_PushState,
-  PAJE_PopState,
-  PAJE_ResetState,
-  PAJE_StartLink,
-  PAJE_EndLink,
-  PAJE_NewEvent
-};
+/* Format of TRACING output.
+ *   - paje is the regular format, that we all know
+ *   - 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. This trick should be removed and replaced by some code
+ *     using the signal that we will create to cleanup the TRACING
+ */
+enum class TraceFormat { Paje, /*TimeIndependent*/ Ti };
+extern TraceFormat trace_format;
 
-class EntityValue {
-  long long int id_;
+class TIData {
   std::string name_;
-  std::string color_;
-  Type* father_;
+  double amount_ = 0;
 
 public:
-  explicit EntityValue(std::string name, std::string color, Type* father);
-  ~EntityValue() = default;
-  const char* getCname() { return name_.c_str(); }
-  long long int getId() { return id_; }
-  void print();
+  int endpoint                 = 0;
+  int send_size                = 0;
+  std::shared_ptr<std::vector<int>> sendcounts = nullptr;
+  int recv_size                = 0;
+  std::shared_ptr<std::vector<int>> recvcounts = nullptr;
+  std::string send_type        = "";
+  std::string recv_type        = "";
+
+  // NoOpTI: init, finalize, test, wait, barrier
+  explicit TIData(std::string name) : name_(name){};
+  // CPuTI: compute, sleep (+ waitAny and waitall out of laziness)
+  explicit TIData(std::string name, double amount) : name_(name), amount_(amount){};
+  // Pt2PtTI: send, isend, sssend, issend, recv, irecv
+  explicit TIData(std::string name, int endpoint, int size, std::string datatype)
+      : name_(name), endpoint(endpoint), send_size(size), send_type(datatype){};
+  // CollTI: bcast, reduce, allreduce, gather, scatter, allgather, alltoall
+  explicit TIData(std::string name, int root, double amount, int send_size, int recv_size, std::string send_type,
+                  std::string recv_type)
+      : name_(name)
+      , amount_(amount)
+      , endpoint(root)
+      , send_size(send_size)
+      , recv_size(recv_size)
+      , send_type(send_type)
+      , recv_type(recv_type){};
+  // VarCollTI: gatherv, scatterv, allgatherv, alltoallv (+ reducescatter out of laziness)
+  explicit TIData(std::string name, int root, int send_size, std::vector<int>* sendcounts, int recv_size,
+                  std::vector<int>* recvcounts, std::string send_type, std::string recv_type)
+      : TIData(name, root, send_size, std::shared_ptr<std::vector<int>>(sendcounts), recv_size,
+               std::shared_ptr<std::vector<int>>(recvcounts), send_type, recv_type){};
+
+  explicit TIData(std::string name, int root, int send_size, std::shared_ptr<std::vector<int>> sendcounts,
+                  int recv_size, std::shared_ptr<std::vector<int>> recvcounts, std::string send_type,
+                  std::string recv_type)
+      : name_(name)
+      , endpoint(root)
+      , send_size(send_size)
+      , sendcounts(sendcounts)
+      , recv_size(recv_size)
+      , recvcounts(recvcounts)
+      , send_type(send_type)
+      , recv_type(recv_type){};
+
+  virtual ~TIData() {}
+
+  std::string getName() { return name_; }
+  double getAmount() { return amount_; }
+  virtual std::string print()        = 0;
+  virtual std::string display_size() = 0;
 };
 
-class PajeEvent {
-protected:
-  Container* container;
-  Type* type;
-
+class NoOpTIData : public TIData {
 public:
-  double timestamp_;
-  e_event_type eventType_;
-  PajeEvent(Container* container, Type* type, double timestamp, e_event_type eventType)
-      : container(container), type(type), timestamp_(timestamp), eventType_(eventType){};
-  virtual ~PajeEvent();
-  virtual void print() = 0;
-  void insertIntoBuffer();
+  explicit NoOpTIData(std::string name) : TIData(name){};
+  std::string print() override { return getName(); }
+  std::string display_size() override { return ""; }
 };
 
-class VariableEvent : public PajeEvent {
-  double value;
-
+class CpuTIData : public TIData {
 public:
-  VariableEvent(double timestamp, Container* container, Type* type, e_event_type event_type, double value);
-  void print() override;
+  explicit CpuTIData(std::string name, double amount) : TIData(name, amount){};
+  std::string print() override
+  {
+    std::stringstream stream;
+    stream << getName() << " " << getAmount();
+    return stream.str();
+  }
+  std::string display_size() override { return std::to_string(getAmount()); }
 };
 
-class StateEvent : public PajeEvent {
-  EntityValue* value;
-  std::string filename;
-  int linenumber;
-  void* extra_ = nullptr;
-
+class Pt2PtTIData : public TIData {
+  int tag;
 public:
-  StateEvent(double timestamp, Container* container, Type* type, e_event_type event_type, EntityValue* value);
-  StateEvent(double timestamp, Container* container, Type* type, e_event_type event_type, EntityValue* value,
-             void* extra);
-  void print() override;
+  explicit Pt2PtTIData(std::string name, int endpoint, int size, int tag, std::string datatype)
+      : TIData(name, endpoint, size, datatype), tag(tag) {};
+
+  explicit Pt2PtTIData(std::string name, int endpoint, int size, std::string datatype)
+      : TIData(name, endpoint, size, datatype), tag(0) {};
+  std::string print() override
+  {
+    std::stringstream stream;
+    stream << getName() << " ";
+    if (endpoint >= 0)
+      stream << endpoint << " ";
+    stream << tag << " " << send_size << " " << send_type;
+    return stream.str();
+  }
+  std::string display_size() override { return std::to_string(send_size); }
 };
 
-class StartLinkEvent : public PajeEvent {
-  Container* sourceContainer_;
-  std::string value_;
-  std::string key_;
-  int size_;
+class CollTIData : public TIData {
+public:
+  explicit CollTIData(std::string name, int root, double amount, int send_size, int recv_size, std::string send_type,
+                      std::string recv_type)
+      : TIData(name, root, amount, send_size, recv_size, send_type, recv_type){};
+  std::string print() override
+  {
+    std::stringstream stream;
+    stream << getName() << " " << send_size << " ";
+    if (recv_size >= 0)
+      stream << recv_size << " ";
+    if (getAmount() >= 0.0)
+      stream << getAmount() << " ";
+    if (endpoint > 0 || (endpoint == 0 && not send_type.empty()))
+      stream << endpoint << " ";
+    stream << send_type << " " << recv_type;
+
+    return stream.str();
+  }
+  std::string display_size() override { return std::to_string(send_size); }
+};
 
+class VarCollTIData : public TIData {
 public:
-  StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
-                 std::string key);
-  StartLinkEvent(double timestamp, Container* container, Type* type, Container* sourceContainer, std::string value,
-                 std::string key, int size);
-  void print() override;
+  explicit VarCollTIData(std::string name, int root, int send_size, std::vector<int>* sendcounts, int recv_size,
+                         std::vector<int>* recvcounts, std::string send_type, std::string recv_type)
+      : TIData(name, root, send_size, sendcounts, recv_size, recvcounts, send_type, recv_type){};
+
+  explicit VarCollTIData(std::string name, int root, int send_size, std::shared_ptr<std::vector<int>> sendcounts,
+                         int recv_size, std::shared_ptr<std::vector<int>> recvcounts, std::string send_type,
+                         std::string recv_type)
+      : TIData(name, root, send_size, sendcounts, recv_size, recvcounts, send_type, recv_type){};
+
+  std::string print() override
+  {
+    std::stringstream stream;
+    stream << getName() << " ";
+    if (send_size >= 0)
+      stream << send_size << " ";
+    if (sendcounts != nullptr)
+      for (auto count : *sendcounts)
+        stream << count << " ";
+    if (recv_size >= 0)
+      stream << recv_size << " ";
+    if (recvcounts != nullptr)
+      for (auto count : *recvcounts)
+        stream << count << " ";
+    if (endpoint > 0 || (endpoint == 0 && not send_type.empty()))
+      stream << endpoint << " ";
+    stream << send_type << " " << recv_type;
+
+    return stream.str();
+  }
+  std::string display_size() override { return std::to_string(send_size > 0 ? send_size : recv_size); }
 };
 
-class EndLinkEvent : public PajeEvent {
-  Container* destContainer;
-  std::string value;
-  std::string key;
+/**
+ * If we want to wait for a request of asynchronous communication, we need to be able
+ * to identify this request. We do this by searching for a request identified by (src, dest, tag).
+ */
+class WaitTIData : public TIData {
+  int src;
+  int dest;
+  int tag;
 
 public:
-  EndLinkEvent(double timestamp, Container* container, Type* type, Container* destContainer, std::string value,
-               std::string key);
-  ~EndLinkEvent() = default;
-  void print() override;
-};
+  explicit WaitTIData(int src, int dest, int tag) : TIData("wait"), src(src), dest(dest), tag(tag){};
 
-class NewEvent : public PajeEvent {
-  EntityValue* val;
+  std::string print() override
+  {
+    std::stringstream stream;
+    stream << getName() << " " << src << " " << dest << " " << tag;
 
+    return stream.str();
+  }
+
+  std::string display_size() override { return ""; }
+};
+
+class AmpiMigrateTIData : public TIData {
+  size_t memory_consumption;
 public:
-  NewEvent(double timestamp, Container* container, Type* type, EntityValue* val);
-  void print() override;
+  explicit AmpiMigrateTIData(size_t memory_conso) : TIData("migrate"), memory_consumption(memory_conso) { };
+
+  std::string print() override
+  {
+    std::stringstream stream;
+    stream << getName() << " " << memory_consumption;
+
+    return stream.str();
+  }
+
+  std::string display_size() override { return ""; }
 };
 }
-} // namespace simgrid::instr
-typedef simgrid::instr::Container* container_t;
+}
 
-extern "C" {
+XBT_PRIVATE std::string instr_pid(s4u_Actor* proc);
 
 extern XBT_PRIVATE std::set<std::string> created_categories;
 extern XBT_PRIVATE std::set<std::string> declared_marks;
@@ -158,132 +248,55 @@ extern XBT_PRIVATE std::set<std::string> user_link_variables;
 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
 
 /* instr_paje_header.c */
-XBT_PRIVATE void TRACE_header(bool basic, int size);
-
-/* from paje.c */
-XBT_PRIVATE void TRACE_paje_start();
-XBT_PRIVATE void TRACE_paje_end();
+XBT_PRIVATE void TRACE_header(bool basic, bool size);
 
 /* from instr_config.c */
 XBT_PRIVATE bool TRACE_needs_platform();
 XBT_PRIVATE bool TRACE_is_enabled();
 XBT_PRIVATE bool TRACE_platform();
 XBT_PRIVATE bool TRACE_platform_topology();
-XBT_PRIVATE bool TRACE_is_configured();
 XBT_PRIVATE bool TRACE_categorized();
 XBT_PRIVATE bool TRACE_uncategorized();
-XBT_PRIVATE bool TRACE_msg_process_is_enabled();
-XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
-XBT_PRIVATE bool TRACE_buffer();
+XBT_PRIVATE bool TRACE_actor_is_enabled();
+XBT_PRIVATE bool TRACE_vm_is_enabled();
 XBT_PRIVATE bool TRACE_disable_link();
 XBT_PRIVATE bool TRACE_disable_speed();
-XBT_PRIVATE bool TRACE_onelink_only();
 XBT_PRIVATE bool TRACE_disable_destroy();
 XBT_PRIVATE bool TRACE_basic();
 XBT_PRIVATE bool TRACE_display_sizes();
-XBT_PRIVATE char* TRACE_get_comment();
-XBT_PRIVATE char* TRACE_get_comment_file();
 XBT_PRIVATE int TRACE_precision();
-XBT_PRIVATE char* TRACE_get_filename();
-XBT_PRIVATE char* TRACE_get_viva_uncat_conf();
-XBT_PRIVATE char* TRACE_get_viva_cat_conf();
-XBT_PRIVATE void TRACE_generate_viva_uncat_conf();
-XBT_PRIVATE void TRACE_generate_viva_cat_conf();
-XBT_PRIVATE void instr_pause_tracing();
-XBT_PRIVATE void instr_resume_tracing();
 
 /* Public functions used in SMPI */
-XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
-XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
-XBT_PUBLIC(bool) TRACE_smpi_is_computing();
-XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
-XBT_PUBLIC(bool) TRACE_smpi_view_internals();
-
-/* from resource_utilization.c */
-XBT_PRIVATE void TRACE_surf_host_set_utilization(const char* resource, const char* category, double value, double now,
-                                                 double delta);
-XBT_PRIVATE void TRACE_surf_link_set_utilization(const char* resource, const char* category, double value, double now,
-                                                 double delta);
-XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
+XBT_PUBLIC bool TRACE_smpi_is_enabled();
+XBT_PUBLIC bool TRACE_smpi_is_grouped();
+XBT_PUBLIC bool TRACE_smpi_is_computing();
+XBT_PUBLIC bool TRACE_smpi_is_sleeping();
+XBT_PUBLIC bool TRACE_smpi_view_internals();
+
+XBT_PRIVATE void TRACE_surf_resource_set_utilization(const char* type, const char* name, const char* resource,
+                                                     std::string category, double value, double now, double delta);
 
 /* instr_paje.c */
 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
 XBT_PRIVATE long long int instr_new_paje_id();
+XBT_PRIVATE void instr_define_callbacks();
 void instr_new_variable_type(std::string new_typename, std::string color);
 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color);
 void instr_new_user_state_type(std::string father_type, std::string new_typename);
 void instr_new_value_for_user_state_type(std::string new_typename, const char* value, std::string color);
 
-/* instr_config.c */
-XBT_PRIVATE void TRACE_TI_start();
-XBT_PRIVATE void TRACE_TI_end();
+XBT_PRIVATE void TRACE_global_init();
+XBT_PRIVATE void TRACE_help();
 
 XBT_PRIVATE void TRACE_paje_dump_buffer(bool force);
 XBT_PRIVATE void dump_comment_file(std::string filename);
 XBT_PRIVATE void dump_comment(std::string comment);
 
-enum e_caller_type {
-  TRACING_INIT,
-  TRACING_FINALIZE,
-  TRACING_COMM_SIZE,
-  TRACING_COMM_SPLIT,
-  TRACING_COMM_DUP,
-  TRACING_SEND,
-  TRACING_ISEND,
-  TRACING_SSEND,
-  TRACING_ISSEND,
-  TRACING_RECV,
-  TRACING_IRECV,
-  TRACING_SENDRECV,
-  TRACING_TEST,
-  TRACING_WAIT,
-  TRACING_WAITALL,
-  TRACING_WAITANY,
-  TRACING_BARRIER,
-  TRACING_BCAST,
-  TRACING_REDUCE,
-  TRACING_ALLREDUCE,
-  TRACING_ALLTOALL,
-  TRACING_ALLTOALLV,
-  TRACING_GATHER,
-  TRACING_GATHERV,
-  TRACING_SCATTER,
-  TRACING_SCATTERV,
-  TRACING_ALLGATHER,
-  TRACING_ALLGATHERV,
-  TRACING_REDUCE_SCATTER,
-  TRACING_COMPUTING,
-  TRACING_SLEEPING,
-  TRACING_SCAN,
-  TRACING_EXSCAN
-};
+XBT_PRIVATE std::string TRACE_get_filename();
 
-struct s_instr_extra_data_t {
-  e_caller_type type;
-  int send_size;
-  int recv_size;
-  double comp_size;
-  double sleep_duration;
-  int src;
-  int dst;
-  int root;
-  const char* datatype1;
-  const char* datatype2;
-  int* sendcounts;
-  int* recvcounts;
-  int num_processes;
-};
-typedef s_instr_extra_data_t* instr_extra_data;
-
-/* Format of TRACING output.
- *   - paje is the regular format, that we all know
- *   - 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. This trick should be removed and replaced by some code
- *     using the signal that we will create to cleanup the TRACING
- */
-enum instr_fmt_type_t { instr_fmt_paje, instr_fmt_TI };
-extern instr_fmt_type_t instr_fmt_type;
-}
+/* instr_platform */
+xbt_graph_t instr_routing_platform_graph();
+void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename);
 
 #endif