Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mv version related things from config.h.in to version.h.in
[simgrid.git] / src / instr / instr_config.cpp
1 /* Copyright (c) 2010-2019. 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 #include "include/xbt/config.hpp"
7 #include "simgrid/Exception.hpp"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "simgrid/version.h"
10 #include "src/instr/instr_private.hpp"
11 #include "surf/surf.hpp"
12 #include "xbt/virtu.h" /* xbt_cmdline */
13
14 #include <fstream>
15 #include <string>
16 #include <vector>
17
18 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
20
21 std::ofstream tracing_file;
22
23 constexpr char OPT_TRACING_BASIC[]             = "tracing/basic";
24 constexpr char OPT_TRACING_COMMENT_FILE[]      = "tracing/comment-file";
25 constexpr char OPT_TRACING_DISABLE_DESTROY[]   = "tracing/disable-destroy";
26 constexpr char OPT_TRACING_FORMAT_TI_ONEFILE[] = "tracing/smpi/format/ti-one-file";
27 constexpr char OPT_TRACING_SMPI[]              = "tracing/smpi";
28 constexpr char OPT_TRACING_TOPOLOGY[]          = "tracing/platform/topology";
29
30 static simgrid::config::Flag<bool> trace_enabled{
31     "tracing", "Enable the tracing system. You have to enable this option to use other tracing options.", false};
32
33 static simgrid::config::Flag<bool> trace_actor_enabled{
34     "tracing/msg/process", // FIXME rename this flag
35     "Trace the behavior of all categorized actors, grouping them by host. "
36     "Can be used to track actor location if the simulator does actor migration.",
37     false};
38
39 static simgrid::config::Flag<bool> trace_vm_enabled{"tracing/vm", "Trace the behavior of all virtual machines.", false};
40
41 static simgrid::config::Flag<bool> trace_platform{"tracing/platform",
42                                                   "Register the platform in the trace as a hierarchy.", false};
43
44 static simgrid::config::Flag<bool> trace_platform_topology{
45     OPT_TRACING_TOPOLOGY, "Register the platform topology in the trace as a graph.", true};
46 static simgrid::config::Flag<bool> trace_smpi_enabled{OPT_TRACING_SMPI, "Tracing of the SMPI interface.", false};
47 static simgrid::config::Flag<bool> trace_smpi_grouped{"tracing/smpi/group", "Group MPI processes by host.", false};
48
49 static simgrid::config::Flag<bool> trace_smpi_computing{
50     "tracing/smpi/computing", "Generate 'Computing' states to trace the out-of-SMPI parts of the application", false};
51
52 static simgrid::config::Flag<bool> trace_smpi_sleeping{
53     "tracing/smpi/sleeping", "Generate 'Sleeping' states for the sleeps in the application that do not pertain to SMPI",
54     false};
55
56 static simgrid::config::Flag<bool> trace_view_internals{
57     "tracing/smpi/internals",
58     "Generate tracing events corresponding to point-to-point messages sent by SMPI collective communications", false};
59
60 static simgrid::config::Flag<bool> trace_categorized{
61     "tracing/categorized", "Trace categorized resource utilization of hosts and links.", false};
62
63 static simgrid::config::Flag<bool> trace_uncategorized{
64     "tracing/uncategorized",
65     "Trace uncategorized resource utilization of hosts and links. "
66     "To use if the simulator does not use tracing categories but resource utilization have to be traced.",
67     false};
68
69 static simgrid::config::Flag<bool> trace_disable_destroy{
70     OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false};
71 static simgrid::config::Flag<bool> trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
72                                                false};
73
74 static simgrid::config::Flag<bool> trace_display_sizes{
75     "tracing/smpi/display-sizes",
76     "Add message size information (in bytes) to the to links and states (SMPI only). "
77     "For collectives, it usually corresponds to the total number of bytes sent by a process.",
78     false};
79
80 static simgrid::config::Flag<bool> trace_disable_link{"tracing/disable_link",
81                                                       "Do not trace link bandwidth and latency.", false};
82 static simgrid::config::Flag<bool> trace_disable_power{"tracing/disable_power", "Do not trace host power.", false};
83
84 static bool trace_active     = false;
85
86 simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje;
87
88 static void TRACE_start()
89 {
90   if (trace_active)
91     return;
92
93   // tracing system must be:
94   //    - enabled (with --cfg=tracing:yes)
95   //    - already configured (TRACE_global_init already called)
96   if (TRACE_is_enabled()) {
97     instr_define_callbacks();
98
99     XBT_DEBUG("Tracing starts");
100     /* init the tracing module to generate the right output */
101     std::string format = simgrid::config::get_value<std::string>("tracing/smpi/format");
102     XBT_DEBUG("Tracing format %s", format.c_str());
103
104     /* open the trace file(s) */
105     std::string filename = TRACE_get_filename();
106     tracing_file.open(filename.c_str(), std::ofstream::out);
107     if (tracing_file.fail()) {
108       throw simgrid::TracingError(
109           XBT_THROW_POINT,
110           simgrid::xbt::string_printf("Tracefile %s could not be opened for writing.", filename.c_str()));
111     }
112
113     XBT_DEBUG("Filename %s is open for writing", filename.c_str());
114
115     if (format == "Paje") {
116       /* output generator version */
117       tracing_file << "#This file was generated using SimGrid-" << SIMGRID_VERSION_MAJOR << "." << SIMGRID_VERSION_MINOR
118                    << "." << SIMGRID_VERSION_PATCH << std::endl;
119       tracing_file << "#[";
120       unsigned int cpt;
121       char* str;
122       xbt_dynar_foreach (xbt_cmdline, cpt, str) {
123         tracing_file << str << " ";
124       }
125       tracing_file << "]" << std::endl;
126     }
127
128     /* output one line comment */
129     dump_comment(simgrid::config::get_value<std::string>("tracing/comment"));
130
131     /* output comment file */
132     dump_comment_file(simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT_FILE));
133
134     if (format == "Paje") {
135       /* output Paj√© header */
136       TRACE_header(TRACE_basic(), TRACE_display_sizes());
137     } else
138       simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti;
139
140     trace_active = true;
141     XBT_DEBUG("Tracing is on");
142   }
143 }
144
145 static void TRACE_end()
146 {
147   if (not trace_active)
148     return;
149
150   /* dump trace buffer */
151   TRACE_last_timestamp_to_dump = surf_get_clock();
152   TRACE_paje_dump_buffer(true);
153
154   simgrid::instr::Type* root_type = simgrid::instr::Container::get_root()->type_;
155   /* destroy all data structures of tracing (and free) */
156   delete simgrid::instr::Container::get_root();
157   delete root_type;
158
159   /* close the trace files */
160   tracing_file.close();
161   XBT_DEBUG("Filename %s is closed", TRACE_get_filename().c_str());
162
163   /* de-activate trace */
164   trace_active = false;
165   XBT_DEBUG("Tracing is off");
166   XBT_DEBUG("Tracing system is shutdown");
167 }
168
169 bool TRACE_needs_platform ()
170 {
171   return TRACE_actor_is_enabled() || TRACE_vm_is_enabled() || TRACE_categorized() || TRACE_uncategorized() ||
172          TRACE_platform() || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
173 }
174
175 bool TRACE_is_enabled()
176 {
177   return trace_enabled;
178 }
179
180 bool TRACE_platform()
181 {
182   return trace_platform;
183 }
184
185 bool TRACE_platform_topology()
186 {
187   return trace_platform_topology;
188 }
189
190 bool TRACE_smpi_is_enabled()
191 {
192   return (trace_smpi_enabled || TRACE_smpi_is_grouped()) && TRACE_is_enabled();
193 }
194
195 bool TRACE_smpi_is_grouped()
196 {
197   return trace_smpi_grouped;
198 }
199
200 bool TRACE_smpi_is_computing()
201 {
202   return trace_smpi_computing;
203 }
204
205 bool TRACE_smpi_is_sleeping()
206 {
207   return trace_smpi_sleeping;
208 }
209
210 bool TRACE_smpi_view_internals()
211 {
212   return trace_view_internals;
213 }
214
215 bool TRACE_categorized ()
216 {
217   return trace_categorized;
218 }
219
220 bool TRACE_uncategorized ()
221 {
222   return trace_uncategorized;
223 }
224
225 bool TRACE_actor_is_enabled()
226 {
227   return trace_actor_enabled && trace_enabled;
228 }
229
230 bool TRACE_vm_is_enabled()
231 {
232   return trace_vm_enabled && trace_enabled;
233 }
234
235 bool TRACE_disable_link()
236 {
237   return trace_disable_link && trace_enabled;
238 }
239
240 bool TRACE_disable_speed()
241 {
242   return trace_disable_power && trace_enabled;
243 }
244
245 bool TRACE_disable_destroy ()
246 {
247   return trace_disable_destroy && trace_enabled;
248 }
249
250 bool TRACE_basic ()
251 {
252   return trace_basic && trace_enabled;
253 }
254
255 bool TRACE_display_sizes ()
256 {
257   return trace_display_sizes && trace_smpi_enabled && trace_enabled;
258 }
259
260 int TRACE_precision ()
261 {
262   return simgrid::config::get_value<int>("tracing/precision");
263 }
264
265 std::string TRACE_get_filename()
266 {
267   return simgrid::config::get_value<std::string>("tracing/filename");
268 }
269
270 void TRACE_global_init()
271 {
272   static bool is_initialized = false;
273   if (is_initialized)
274     return;
275
276   is_initialized = true;
277
278   /* name of the tracefile */
279   simgrid::config::declare_flag<std::string>("tracing/filename", "Trace file created by the instrumented SimGrid.",
280                                              "simgrid.trace");
281   simgrid::config::declare_flag<std::string>(
282       "tracing/smpi/format", "Select trace output format used by SMPI. The default is the 'Paje' format. "
283                              "The 'TI' (Time-Independent) format allows for trace replay.",
284       "Paje");
285
286   simgrid::config::declare_flag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
287                                       "(smpi only) For replay format only : output to one file only", false);
288   simgrid::config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"});
289   simgrid::config::declare_flag<std::string>("tracing/comment", "Add a comment line to the top of the trace file.", "");
290   simgrid::config::declare_flag<std::string>(OPT_TRACING_COMMENT_FILE,
291                                              "Add the contents of a file as comments to the top of the trace.", "");
292   simgrid::config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"});
293   simgrid::config::declare_flag<int>("tracing/precision", "Numerical precision used when timestamping events "
294                                                           "(expressed in number of digits after decimal point)",
295                                      6);
296
297   /* Connect callbacks */
298   simgrid::s4u::Engine::on_platform_creation.connect(TRACE_start);
299   simgrid::s4u::Engine::on_deadlock.connect(TRACE_end);
300   simgrid::s4u::Engine::on_simulation_end.connect(TRACE_end);
301 }
302
303 static void print_line(const char* option, const char* desc, const char* longdesc)
304 {
305   std::string str = std::string("--cfg=") + option + " ";
306
307   int len = str.size();
308   XBT_HELP("%s%*.*s %s", str.c_str(), 30 - len, 30 - len, "", desc);
309   if (longdesc != nullptr) {
310     XBT_HELP("%s\n", longdesc);
311   }
312 }
313
314 void TRACE_help()
315 {
316   XBT_HELP("Description of the tracing options accepted by this simulator:\n");
317   print_line(OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
318              "  This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
319              "  interface and generates a trace that can be analyzed using Gantt-like\n"
320              "  visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
321              "  state, and point-to-point communications can be analyzed with arrows.");
322   print_line(OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
323              "  Disable the destruction of containers at the end of simulation. This can be\n"
324              "  used with simulators that have a different notion of time (different from\n"
325              "  the simulated time).");
326   print_line(OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
327              "  Some visualization tools are not able to parse correctly the Paje file format.\n"
328              "  Use this option if you are using one of these tools to visualize the simulation\n"
329              "  trace. Keep in mind that the trace might be incomplete, without all the\n"
330              "  information that would be registered otherwise.");
331   print_line(OPT_TRACING_FORMAT_TI_ONEFILE, "Only works for SMPI now, and TI output format",
332              "  By default, each process outputs to a separate file, inside a filename_files folder\n"
333              "  By setting this option to yes, all processes will output to only one file\n"
334              "  This is meant to avoid opening thousands of files with large simulations");
335   print_line(OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
336              "  This option (enabled by default) can be used to disable the tracing of\n"
337              "  the platform topology in the trace file. Sometimes, such task is really\n"
338              "  time consuming, since it must get the route from each host to other hosts\n"
339              "  within the same Autonomous System (AS).");
340 }