1 /* Copyright (c) 2010-2022. 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"
19 #include <iomanip> /** std::setprecision **/
31 void dump_generator_version();
32 void dump_comment_file(const std::string& filename);
33 void dump_header(bool basic, bool display_sizes);
36 /* Format of TRACING output.
37 * - paje is the regular format, that we all know
38 * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
39 * trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
40 * using the signal that we will create to cleanup the TRACING
42 enum class TraceFormat { Paje, /*TimeIndependent*/ Ti };
43 extern TraceFormat trace_format;
44 extern int trace_precision;
45 extern double last_timestamp_to_dump;
48 void define_callbacks();
50 void resource_set_utilization(const char* type, const char* name, const char* resource, const std::string& category,
51 double value, double now, double delta);
52 void dump_buffer(bool force);
59 explicit TIData(const std::string& name) : name_(name){};
60 explicit TIData(const std::string& name, double amount) : name_(name), amount_(amount){};
62 virtual ~TIData() = default;
64 const std::string& get_name() const { return name_; }
65 double get_amount() const { return amount_; }
66 virtual std::string print() = 0;
67 virtual std::string display_size() = 0;
70 // NoOpTI: init, finalize, test, wait, barrier
71 class NoOpTIData : public TIData {
72 explicit NoOpTIData(const std::string&, double); // disallow this constructor inherited from TIData
76 std::string print() override { return get_name(); }
77 std::string display_size() override { return "NA"; }
80 // CPuTI: compute, sleep (+ waitAny and waitall out of laziness)
81 class CpuTIData : public TIData {
82 explicit CpuTIData(const std::string&); // disallow this constructor inherited from TIData
86 std::string print() override
88 std::stringstream stream;
89 stream << get_name() << " " << get_amount();
92 std::string display_size() override { return std::to_string(get_amount()); }
95 // Pt2PtTI: send, isend, ssend, issend, recv, irecv
96 class Pt2PtTIData : public TIData {
103 Pt2PtTIData(const std::string& name, int endpoint, size_t size, const std::string& datatype)
104 : TIData(name), endpoint_(endpoint), size_(size), type_(datatype){};
105 Pt2PtTIData(const std::string& name, int endpoint, size_t size, int tag, const std::string& datatype)
106 : TIData(name), endpoint_(endpoint), size_(size), type_(datatype), tag_(tag){};
108 std::string print() override
110 std::stringstream stream;
111 stream << get_name() << " " << endpoint_ << " " << tag_ << " " << size_ << " " << type_;
114 std::string display_size() override { return std::to_string(size_); }
117 // CollTI: bcast, reduce, allreduce, gather, scatter, allgather, alltoall
118 class CollTIData : public TIData {
122 std::string send_type_;
123 std::string recv_type_;
126 CollTIData(const std::string& name, int root, double amount, size_t send_size, size_t recv_size,
127 const std::string& send_type, const std::string& recv_type)
128 : TIData(name, amount)
130 , send_size_(send_size)
131 , recv_size_(recv_size)
132 , send_type_(send_type)
133 , recv_type_(recv_type){};
135 std::string print() override
137 std::stringstream stream;
138 stream << get_name() << " " << send_size_ << " ";
140 stream << recv_size_ << " ";
141 if (get_amount() >= 0.0)
142 stream << get_amount() << " ";
143 if (root_ > 0 || (root_ == 0 && not send_type_.empty()))
144 stream << root_ << " ";
145 stream << send_type_ << " " << recv_type_;
149 std::string display_size() override { return std::to_string(send_size_); }
152 // VarCollTI: gatherv, scatterv, allgatherv, alltoallv (+ reducescatter out of laziness)
153 class VarCollTIData : public TIData {
156 std::shared_ptr<std::vector<int>> sendcounts_;
158 std::shared_ptr<std::vector<int>> recvcounts_;
159 std::string send_type_;
160 std::string recv_type_;
163 VarCollTIData(const std::string& name, int root, long int send_size, std::shared_ptr<std::vector<int>> sendcounts,
164 long int recv_size, std::shared_ptr<std::vector<int>> recvcounts, const std::string& send_type,
165 const std::string& recv_type)
168 , send_size_(send_size)
169 , sendcounts_(sendcounts)
170 , recv_size_(recv_size)
171 , recvcounts_(recvcounts)
172 , send_type_(send_type)
173 , recv_type_(recv_type){};
175 std::string print() override
177 std::stringstream stream;
178 stream << get_name() << " ";
180 stream << send_size_ << " ";
181 if (sendcounts_ != nullptr)
182 for (auto count : *sendcounts_)
183 stream << count << " ";
185 stream << recv_size_ << " ";
186 if (recvcounts_ != nullptr)
187 for (auto count : *recvcounts_)
188 stream << count << " ";
189 if (root_ > 0 || (root_ == 0 && not send_type_.empty()))
190 stream << root_ << " ";
191 stream << send_type_ << " " << recv_type_;
195 std::string display_size() override { return std::to_string(send_size_ > 0 ? send_size_ : recv_size_); }
199 * If we want to wait for a request of asynchronous communication, we need to be able
200 * to identify this request. We do this by searching for a request identified by (src, dest, tag).
202 class WaitTIData : public TIData {
208 WaitTIData(std::string name, int src, int dest, int tag) : TIData(name), src_(src), dest_(dest), tag_(tag){};
210 std::string print() override
212 std::stringstream stream;
213 stream << get_name() << " " << src_ << " " << dest_ << " " << tag_;
216 std::string display_size() override { return "NA"; }
219 class AmpiMigrateTIData : public TIData {
220 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 << get_name() << " " << memory_consumption_;
231 std::string display_size() override { return "NA"; }
234 } // namespace simgrid
236 XBT_PRIVATE std::string instr_pid(simgrid::s4u::Actor const& proc);
238 extern XBT_PRIVATE std::set<std::string, std::less<>> created_categories;
239 extern XBT_PRIVATE std::set<std::string, std::less<>> declared_marks;
240 extern XBT_PRIVATE std::set<std::string, std::less<>> user_host_variables;
241 extern XBT_PRIVATE std::set<std::string, std::less<>> user_vm_variables;
242 extern XBT_PRIVATE std::set<std::string, std::less<>> user_link_variables;
244 /* from instr_config.c */
245 XBT_PRIVATE bool TRACE_needs_platform();
246 XBT_PRIVATE bool TRACE_is_enabled();
247 XBT_PRIVATE bool TRACE_platform();
248 XBT_PRIVATE bool TRACE_platform_topology();
249 XBT_PRIVATE bool TRACE_categorized();
250 XBT_PRIVATE bool TRACE_uncategorized();
251 XBT_PRIVATE bool TRACE_actor_is_enabled();
252 XBT_PRIVATE bool TRACE_vm_is_enabled();
253 XBT_PRIVATE bool TRACE_disable_link();
254 XBT_PRIVATE bool TRACE_disable_speed();
255 XBT_PRIVATE bool TRACE_display_sizes();
257 /* Public functions used in SMPI */
258 XBT_PUBLIC bool TRACE_smpi_is_enabled();
259 XBT_PUBLIC bool TRACE_smpi_is_grouped();
260 XBT_PUBLIC bool TRACE_smpi_is_computing();
261 XBT_PUBLIC bool TRACE_smpi_is_sleeping();
262 XBT_PUBLIC bool TRACE_smpi_view_internals();
265 void instr_new_variable_type(const std::string& new_typename, const std::string& color);
266 void instr_new_user_variable_type(const std::string& parent_type, const std::string& new_typename,
267 const std::string& color);
268 void instr_new_user_state_type(const std::string& parent_type, const std::string& new_typename);
269 void instr_new_value_for_user_state_type(const std::string& new_typename, const char* value, const std::string& color);
271 XBT_PRIVATE void TRACE_help();