1 /* Copyright (c) 2010-2019. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef INSTR_PRIVATE_HPP
7 #define INSTR_PRIVATE_HPP
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"
20 #include <iomanip> /** std::setprecision **/
29 #include <direct.h> // _mkdir
30 /* Need to define function drand48 for Windows */
31 #define drand48() (rand() / (RAND_MAX + 1.0))
34 typedef simgrid::instr::Container* container_t;
39 /* Format of TRACING output.
40 * - paje is the regular format, that we all know
41 * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
42 * trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
43 * using the signal that we will create to cleanup the TRACING
45 enum class TraceFormat { Paje, /*TimeIndependent*/ Ti };
46 extern TraceFormat trace_format;
55 std::shared_ptr<std::vector<int>> sendcounts = nullptr;
57 std::shared_ptr<std::vector<int>> recvcounts = nullptr;
58 std::string send_type = "";
59 std::string recv_type = "";
61 // NoOpTI: init, finalize, test, wait, barrier
62 explicit TIData(std::string name) : name_(name){};
63 // CPuTI: compute, sleep (+ waitAny and waitall out of laziness)
64 explicit TIData(std::string name, double amount) : name_(name), amount_(amount){};
65 // Pt2PtTI: send, isend, sssend, issend, recv, irecv
66 explicit TIData(std::string name, int endpoint, int size, std::string datatype)
67 : name_(name), endpoint(endpoint), send_size(size), send_type(datatype){};
68 // CollTI: bcast, reduce, allreduce, gather, scatter, allgather, alltoall
69 explicit TIData(std::string name, int root, double amount, int send_size, int recv_size, std::string send_type,
70 std::string recv_type)
74 , send_size(send_size)
75 , recv_size(recv_size)
76 , send_type(send_type)
77 , recv_type(recv_type){};
78 // VarCollTI: gatherv, scatterv, allgatherv, alltoallv (+ reducescatter out of laziness)
79 explicit TIData(std::string name, int root, int send_size, std::vector<int>* sendcounts, int recv_size,
80 std::vector<int>* recvcounts, std::string send_type, std::string recv_type)
81 : TIData(name, root, send_size, std::shared_ptr<std::vector<int>>(sendcounts), recv_size,
82 std::shared_ptr<std::vector<int>>(recvcounts), send_type, recv_type){};
84 explicit TIData(std::string name, int root, int send_size, std::shared_ptr<std::vector<int>> sendcounts,
85 int recv_size, std::shared_ptr<std::vector<int>> recvcounts, std::string send_type,
86 std::string recv_type)
89 , send_size(send_size)
90 , sendcounts(sendcounts)
91 , recv_size(recv_size)
92 , recvcounts(recvcounts)
93 , send_type(send_type)
94 , recv_type(recv_type){};
98 std::string getName() { return name_; }
99 double getAmount() { return amount_; }
100 virtual std::string print() = 0;
101 virtual std::string display_size() = 0;
104 class NoOpTIData : public TIData {
106 explicit NoOpTIData(std::string name) : TIData(name){};
107 std::string print() override { return getName(); }
108 std::string display_size() override { return "NA"; }
111 class CpuTIData : public TIData {
113 explicit CpuTIData(std::string name, double amount) : TIData(name, amount){};
114 std::string print() override
116 std::stringstream stream;
117 stream << getName() << " " << getAmount();
120 std::string display_size() override { return std::to_string(getAmount()); }
123 class Pt2PtTIData : public TIData {
126 explicit Pt2PtTIData(std::string name, int endpoint, int size, int tag, std::string datatype)
127 : TIData(name, endpoint, size, datatype), tag(tag) {};
129 explicit Pt2PtTIData(std::string name, int endpoint, int size, std::string datatype)
130 : TIData(name, endpoint, size, datatype), tag(0) {};
131 std::string print() override
133 std::stringstream stream;
134 stream << getName() << " " << endpoint << " ";
135 stream << tag << " " << send_size << " " << send_type;
138 std::string display_size() override { return std::to_string(send_size); }
141 class CollTIData : public TIData {
143 explicit CollTIData(std::string name, int root, double amount, int send_size, int recv_size, std::string send_type,
144 std::string recv_type)
145 : TIData(name, root, amount, send_size, recv_size, send_type, recv_type){};
146 std::string print() override
148 std::stringstream stream;
149 stream << getName() << " " << send_size << " ";
151 stream << recv_size << " ";
152 if (getAmount() >= 0.0)
153 stream << getAmount() << " ";
154 if (endpoint > 0 || (endpoint == 0 && not send_type.empty()))
155 stream << endpoint << " ";
156 stream << send_type << " " << recv_type;
160 std::string display_size() override { return std::to_string(send_size); }
163 class VarCollTIData : public TIData {
165 explicit VarCollTIData(std::string name, int root, int send_size, std::vector<int>* sendcounts, int recv_size,
166 std::vector<int>* recvcounts, std::string send_type, std::string recv_type)
167 : TIData(name, root, send_size, sendcounts, recv_size, recvcounts, send_type, recv_type){};
169 explicit VarCollTIData(std::string name, int root, int send_size, std::shared_ptr<std::vector<int>> sendcounts,
170 int recv_size, std::shared_ptr<std::vector<int>> recvcounts, std::string send_type,
171 std::string recv_type)
172 : TIData(name, root, send_size, sendcounts, recv_size, recvcounts, send_type, recv_type){};
174 std::string print() override
176 std::stringstream stream;
177 stream << getName() << " ";
179 stream << send_size << " ";
180 if (sendcounts != nullptr)
181 for (auto count : *sendcounts)
182 stream << count << " ";
184 stream << recv_size << " ";
185 if (recvcounts != nullptr)
186 for (auto count : *recvcounts)
187 stream << count << " ";
188 if (endpoint > 0 || (endpoint == 0 && not send_type.empty()))
189 stream << endpoint << " ";
190 stream << send_type << " " << recv_type;
194 std::string display_size() override { return std::to_string(send_size > 0 ? send_size : recv_size); }
198 * If we want to wait for a request of asynchronous communication, we need to be able
199 * to identify this request. We do this by searching for a request identified by (src, dest, tag).
201 class WaitTIData : public TIData {
207 explicit WaitTIData(int src, int dest, int tag) : TIData("wait"), src(src), dest(dest), tag(tag){};
209 std::string print() override
211 std::stringstream stream;
212 stream << getName() << " " << src << " " << dest << " " << tag;
217 std::string display_size() override { return "NA"; }
220 class AmpiMigrateTIData : public TIData {
221 size_t memory_consumption;
223 explicit AmpiMigrateTIData(size_t memory_conso) : TIData("migrate"), memory_consumption(memory_conso) { };
225 std::string print() override
227 std::stringstream stream;
228 stream << getName() << " " << memory_consumption;
233 std::string display_size() override { return "NA"; }
238 XBT_PRIVATE std::string instr_pid(s4u_Actor* proc);
240 extern XBT_PRIVATE std::set<std::string> created_categories;
241 extern XBT_PRIVATE std::set<std::string> declared_marks;
242 extern XBT_PRIVATE std::set<std::string> user_host_variables;
243 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
244 extern XBT_PRIVATE std::set<std::string> user_link_variables;
245 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
247 /* instr_paje_header.c */
248 XBT_PRIVATE void TRACE_header(bool basic, bool size);
250 /* from instr_config.c */
251 XBT_PRIVATE bool TRACE_needs_platform();
252 XBT_PRIVATE bool TRACE_is_enabled();
253 XBT_PRIVATE bool TRACE_platform();
254 XBT_PRIVATE bool TRACE_platform_topology();
255 XBT_PRIVATE bool TRACE_categorized();
256 XBT_PRIVATE bool TRACE_uncategorized();
257 XBT_PRIVATE bool TRACE_actor_is_enabled();
258 XBT_PRIVATE bool TRACE_vm_is_enabled();
259 XBT_PRIVATE bool TRACE_disable_link();
260 XBT_PRIVATE bool TRACE_disable_speed();
261 XBT_PRIVATE bool TRACE_disable_destroy();
262 XBT_PRIVATE bool TRACE_basic();
263 XBT_PRIVATE bool TRACE_display_sizes();
264 XBT_PRIVATE int TRACE_precision();
266 /* Public functions used in SMPI */
267 XBT_PUBLIC bool TRACE_smpi_is_enabled();
268 XBT_PUBLIC bool TRACE_smpi_is_grouped();
269 XBT_PUBLIC bool TRACE_smpi_is_computing();
270 XBT_PUBLIC bool TRACE_smpi_is_sleeping();
271 XBT_PUBLIC bool TRACE_smpi_view_internals();
273 XBT_PRIVATE void TRACE_surf_resource_set_utilization(const char* type, const char* name, const char* resource,
274 std::string category, double value, double now, double delta);
277 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
278 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
279 XBT_PRIVATE long long int instr_new_paje_id();
280 XBT_PRIVATE void instr_define_callbacks();
281 void instr_new_variable_type(std::string new_typename, std::string color);
282 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color);
283 void instr_new_user_state_type(std::string father_type, std::string new_typename);
284 void instr_new_value_for_user_state_type(std::string new_typename, const char* value, std::string color);
286 XBT_PRIVATE void TRACE_global_init();
287 XBT_PRIVATE void TRACE_help();
289 XBT_PRIVATE void TRACE_paje_dump_buffer(bool force);
290 XBT_PRIVATE void dump_comment_file(std::string filename);
291 XBT_PRIVATE void dump_comment(std::string comment);
293 XBT_PRIVATE std::string TRACE_get_filename();
296 xbt_graph_t instr_routing_platform_graph();
297 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename);