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 **/
27 namespace simgrid::instr {
30 void dump_generator_version();
31 void dump_comment_file(const std::string& filename);
32 void dump_header(bool basic, bool display_sizes);
35 /* Format of TRACING output.
36 * - paje is the regular format, that we all know
37 * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such
38 * trace can easily be replayed with smpi_replay afterward. This trick should be removed and replaced by some code
39 * using the signal that we will create to cleanup the TRACING
41 enum class TraceFormat { Paje, /*TimeIndependent*/ Ti };
42 extern TraceFormat trace_format;
43 extern int trace_precision;
44 extern double last_timestamp_to_dump;
47 void define_callbacks();
49 void resource_set_utilization(const char* type, const char* name, const char* resource, const std::string& category,
50 double value, double now, double delta);
51 void dump_buffer(bool force);
58 explicit TIData(const std::string& name) : name_(name){};
59 explicit TIData(const std::string& name, double amount) : name_(name), amount_(amount){};
61 virtual ~TIData() = default;
63 const std::string& get_name() const { return name_; }
64 double get_amount() const { return amount_; }
65 virtual std::string print() = 0;
66 virtual std::string display_size() = 0;
69 // NoOpTI: init, finalize, test, wait, barrier
70 class NoOpTIData : public TIData {
71 explicit NoOpTIData(const std::string&, double); // disallow this constructor inherited from TIData
75 std::string print() override { return get_name(); }
76 std::string display_size() override { return "NA"; }
79 // CPuTI: compute, sleep (+ waitAny and waitall out of laziness)
80 class CpuTIData : public TIData {
81 explicit CpuTIData(const std::string&); // disallow this constructor inherited from TIData
85 std::string print() override
87 std::stringstream stream;
88 stream << get_name() << " " << get_amount();
91 std::string display_size() override { return std::to_string(get_amount()); }
94 // Pt2PtTI: send, isend, ssend, issend, recv, irecv
95 class Pt2PtTIData : public TIData {
102 Pt2PtTIData(const std::string& name, int endpoint, size_t size, const std::string& datatype)
103 : TIData(name), endpoint_(endpoint), size_(size), type_(datatype){};
104 Pt2PtTIData(const std::string& name, int endpoint, size_t size, int tag, const std::string& datatype)
105 : TIData(name), endpoint_(endpoint), size_(size), type_(datatype), tag_(tag){};
107 std::string print() override
109 std::stringstream stream;
110 stream << get_name() << " " << endpoint_ << " " << tag_ << " " << size_ << " " << type_;
113 std::string display_size() override { return std::to_string(size_); }
116 // CollTI: bcast, reduce, allreduce, gather, scatter, allgather, alltoall
117 class CollTIData : public TIData {
121 std::string send_type_;
122 std::string recv_type_;
125 CollTIData(const std::string& name, int root, double amount, size_t send_size, size_t recv_size,
126 const std::string& send_type, const std::string& recv_type)
127 : TIData(name, amount)
129 , send_size_(send_size)
130 , recv_size_(recv_size)
131 , send_type_(send_type)
132 , recv_type_(recv_type){};
134 std::string print() override
136 std::stringstream stream;
137 stream << get_name() << " " << send_size_ << " ";
139 stream << recv_size_ << " ";
140 if (get_amount() >= 0.0)
141 stream << get_amount() << " ";
142 if (root_ > 0 || (root_ == 0 && not send_type_.empty()))
143 stream << root_ << " ";
144 stream << send_type_ << " " << recv_type_;
148 std::string display_size() override { return std::to_string(send_size_); }
151 // VarCollTI: gatherv, scatterv, allgatherv, alltoallv (+ reducescatter out of laziness)
152 class VarCollTIData : public TIData {
155 std::shared_ptr<std::vector<int>> sendcounts_;
157 std::shared_ptr<std::vector<int>> recvcounts_;
158 std::string send_type_;
159 std::string recv_type_;
162 VarCollTIData(const std::string& name, int root, long int send_size, std::shared_ptr<std::vector<int>> sendcounts,
163 long int recv_size, std::shared_ptr<std::vector<int>> recvcounts, const std::string& send_type,
164 const std::string& recv_type)
167 , send_size_(send_size)
168 , sendcounts_(sendcounts)
169 , recv_size_(recv_size)
170 , recvcounts_(recvcounts)
171 , send_type_(send_type)
172 , recv_type_(recv_type){};
174 std::string print() override
176 std::stringstream stream;
177 stream << get_name() << " ";
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 (root_ > 0 || (root_ == 0 && not send_type_.empty()))
189 stream << root_ << " ";
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 WaitTIData(const std::string& name, int src, int dest, int tag) : TIData(name), src_(src), dest_(dest), tag_(tag){};
209 std::string print() override
211 std::stringstream stream;
212 stream << get_name() << " " << src_ << " " << dest_ << " " << tag_;
215 std::string display_size() override { return "NA"; }
218 class AmpiMigrateTIData : public TIData {
219 size_t memory_consumption_;
222 explicit AmpiMigrateTIData(size_t memory_conso) : TIData("migrate"), memory_consumption_(memory_conso){};
224 std::string print() override
226 std::stringstream stream;
227 stream << get_name() << " " << memory_consumption_;
230 std::string display_size() override { return "NA"; }
232 } // namespace simgrid::instr
234 XBT_PRIVATE std::string instr_pid(simgrid::s4u::Actor const& proc);
236 extern XBT_PRIVATE std::set<std::string, std::less<>> created_categories;
237 extern XBT_PRIVATE std::set<std::string, std::less<>> declared_marks;
238 extern XBT_PRIVATE std::set<std::string, std::less<>> user_host_variables;
239 extern XBT_PRIVATE std::set<std::string, std::less<>> user_vm_variables;
240 extern XBT_PRIVATE std::set<std::string, std::less<>> user_link_variables;
242 /* from instr_config.c */
243 XBT_PRIVATE bool TRACE_needs_platform();
244 XBT_PRIVATE bool TRACE_is_enabled();
245 XBT_PRIVATE bool TRACE_platform();
246 XBT_PRIVATE bool TRACE_platform_topology();
247 XBT_PRIVATE bool TRACE_categorized();
248 XBT_PRIVATE bool TRACE_uncategorized();
249 XBT_PRIVATE bool TRACE_actor_is_enabled();
250 XBT_PRIVATE bool TRACE_vm_is_enabled();
251 XBT_PRIVATE bool TRACE_disable_link();
252 XBT_PRIVATE bool TRACE_disable_speed();
253 XBT_PRIVATE bool TRACE_display_sizes();
255 /* Public functions used in SMPI */
256 XBT_PUBLIC bool TRACE_smpi_is_enabled();
257 XBT_PUBLIC bool TRACE_smpi_is_grouped();
258 XBT_PUBLIC bool TRACE_smpi_is_computing();
259 XBT_PUBLIC bool TRACE_smpi_is_sleeping();
260 XBT_PUBLIC bool TRACE_smpi_view_internals();
263 void instr_new_variable_type(const std::string& new_typename, const std::string& color);
264 void instr_new_user_variable_type(const std::string& parent_type, const std::string& new_typename,
265 const std::string& color);
266 void instr_new_user_state_type(const std::string& parent_type, const std::string& new_typename);
267 void instr_new_value_for_user_state_type(const std::string& new_typename, const char* value, const std::string& color);
269 XBT_PRIVATE void TRACE_help();