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 #include "include/xbt/config.hpp"
7 #include "simgrid/s4u/Engine.hpp"
8 #include "src/instr/instr_private.hpp"
9 #include "surf/surf.hpp"
10 #include "xbt/virtu.h" /* xbt_cmdline */
16 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
19 std::ofstream tracing_file;
21 #define OPT_TRACING_BASIC "tracing/basic"
22 #define OPT_TRACING_COMMENT_FILE "tracing/comment-file"
23 #define OPT_TRACING_DISABLE_DESTROY "tracing/disable-destroy"
24 #define OPT_TRACING_FORMAT_TI_ONEFILE "tracing/smpi/format/ti-one-file"
25 #define OPT_TRACING_SMPI_INTERNALS "tracing/smpi/internals"
26 #define OPT_TRACING_SMPI "tracing/smpi"
27 #define OPT_TRACING_TOPOLOGY "tracing/platform/topology"
29 static simgrid::config::Flag<bool> trace_enabled{
30 "tracing", "Enable the tracing system. You have to enable this option to use other tracing options.", false};
32 static simgrid::config::Flag<bool> trace_actor_enabled{
33 "tracing/msg/process", // FIXME rename this flag
34 "Trace the behavior of all categorized actors, grouping them by host. "
35 "Can be used to track actor location if the simulator does actor migration.",
38 static simgrid::config::Flag<bool> trace_vm_enabled{"tracing/vm", "Trace the behavior of all virtual machines.", false};
40 static simgrid::config::Flag<bool> trace_platform{"tracing/platform",
41 "Register the platform in the trace as a hierarchy.", false};
43 static simgrid::config::Flag<bool> trace_platform_topology{
44 OPT_TRACING_TOPOLOGY, "Register the platform topology in the trace as a graph.", true};
45 static simgrid::config::Flag<bool> trace_smpi_enabled{OPT_TRACING_SMPI, "Tracing of the SMPI interface.", false};
46 static simgrid::config::Flag<bool> trace_smpi_grouped{"tracing/smpi/group", "Group MPI processes by host.", false};
48 static simgrid::config::Flag<bool> trace_smpi_computing{
49 "tracing/smpi/computing", "Generate 'Computing' states to trace the out-of-SMPI parts of the application", false};
51 static simgrid::config::Flag<bool> trace_smpi_sleeping{
52 "tracing/smpi/sleeping", "Generate 'Sleeping' states for the sleeps in the application that do not pertain to SMPI",
55 static simgrid::config::Flag<bool> trace_view_internals{
56 "tracing/smpi/internals",
57 "Generate tracing events corresponding to point-to-point messages sent by SMPI collective communications", false};
59 static simgrid::config::Flag<bool> trace_categorized{
60 "tracing/categorized", "Trace categorized resource utilization of hosts and links.", false};
62 static simgrid::config::Flag<bool> trace_uncategorized{
63 "tracing/uncategorized",
64 "Trace uncategorized resource utilization of hosts and links. "
65 "To use if the simulator does not use tracing categories but resource utilization have to be traced.",
68 static simgrid::config::Flag<bool> trace_disable_destroy{
69 OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false};
70 static simgrid::config::Flag<bool> trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
73 static simgrid::config::Flag<bool> trace_display_sizes{
74 "tracing/smpi/display-sizes",
75 "Add message size information (in bytes) to the to links and states (SMPI only). "
76 "For collectives, it usually corresponds to the total number of bytes sent by a process.",
79 static simgrid::config::Flag<bool> trace_disable_link{"tracing/disable_link",
80 "Do not trace link bandwidth and latency.", false};
81 static simgrid::config::Flag<bool> trace_disable_power{"tracing/disable_power", "Do not trace host power.", false};
83 static bool trace_active = false;
85 simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje;
87 static void TRACE_start()
92 // tracing system must be:
93 // - enabled (with --cfg=tracing:yes)
94 // - already configured (TRACE_global_init already called)
95 if (TRACE_is_enabled()) {
96 instr_define_callbacks();
98 XBT_DEBUG("Tracing starts");
99 /* init the tracing module to generate the right output */
100 std::string format = simgrid::config::get_value<std::string>("tracing/smpi/format");
101 XBT_DEBUG("Tracing format %s", format.c_str());
103 /* open the trace file(s) */
104 std::string filename = TRACE_get_filename();
105 tracing_file.open(filename.c_str(), std::ofstream::out);
106 if (tracing_file.fail()) {
107 THROWF(system_error, 1, "Tracefile %s could not be opened for writing.", filename.c_str());
110 XBT_DEBUG("Filename %s is open for writing", filename.c_str());
112 if (format == "Paje") {
113 /* output generator version */
114 tracing_file << "#This file was generated using SimGrid-" << SIMGRID_VERSION_MAJOR << "." << SIMGRID_VERSION_MINOR
115 << "." << SIMGRID_VERSION_PATCH << std::endl;
116 tracing_file << "#[";
119 xbt_dynar_foreach (xbt_cmdline, cpt, str) {
120 tracing_file << str << " ";
122 tracing_file << "]" << std::endl;
125 /* output one line comment */
126 dump_comment(simgrid::config::get_value<std::string>("tracing/comment"));
128 /* output comment file */
129 dump_comment_file(simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT_FILE));
131 if (format == "Paje") {
132 /* output Pajé header */
133 TRACE_header(TRACE_basic(), TRACE_display_sizes());
135 simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti;
138 XBT_DEBUG("Tracing is on");
142 static void TRACE_end()
144 if (not trace_active)
147 /* dump trace buffer */
148 TRACE_last_timestamp_to_dump = surf_get_clock();
149 TRACE_paje_dump_buffer(true);
151 simgrid::instr::Type* root_type = simgrid::instr::Container::get_root()->type_;
152 /* destroy all data structures of tracing (and free) */
153 delete simgrid::instr::Container::get_root();
156 /* close the trace files */
157 tracing_file.close();
158 XBT_DEBUG("Filename %s is closed", TRACE_get_filename().c_str());
160 /* de-activate trace */
161 trace_active = false;
162 XBT_DEBUG("Tracing is off");
163 XBT_DEBUG("Tracing system is shutdown");
166 bool TRACE_needs_platform ()
168 return TRACE_actor_is_enabled() || TRACE_vm_is_enabled() || TRACE_categorized() || TRACE_uncategorized() ||
169 TRACE_platform() || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
172 bool TRACE_is_enabled()
174 return trace_enabled;
177 bool TRACE_platform()
179 return trace_platform;
182 bool TRACE_platform_topology()
184 return trace_platform_topology;
187 bool TRACE_smpi_is_enabled()
189 return (trace_smpi_enabled || TRACE_smpi_is_grouped()) && TRACE_is_enabled();
192 bool TRACE_smpi_is_grouped()
194 return trace_smpi_grouped;
197 bool TRACE_smpi_is_computing()
199 return trace_smpi_computing;
202 bool TRACE_smpi_is_sleeping()
204 return trace_smpi_sleeping;
207 bool TRACE_smpi_view_internals()
209 return trace_view_internals;
212 bool TRACE_categorized ()
214 return trace_categorized;
217 bool TRACE_uncategorized ()
219 return trace_uncategorized;
222 bool TRACE_actor_is_enabled()
224 return trace_actor_enabled && trace_enabled;
227 bool TRACE_vm_is_enabled()
229 return trace_vm_enabled && trace_enabled;
232 bool TRACE_disable_link()
234 return trace_disable_link && trace_enabled;
237 bool TRACE_disable_speed()
239 return trace_disable_power && trace_enabled;
242 bool TRACE_disable_destroy ()
244 return trace_disable_destroy && trace_enabled;
249 return trace_basic && trace_enabled;
252 bool TRACE_display_sizes ()
254 return trace_display_sizes && trace_smpi_enabled && trace_enabled;
257 int TRACE_precision ()
259 return simgrid::config::get_value<int>("tracing/precision");
262 std::string TRACE_get_filename()
264 return simgrid::config::get_value<std::string>("tracing/filename");
267 void TRACE_global_init()
269 static bool is_initialised = false;
273 is_initialised = true;
275 /* name of the tracefile */
276 simgrid::config::declare_flag<std::string>("tracing/filename", "Trace file created by the instrumented SimGrid.",
278 simgrid::config::declare_flag<std::string>(
279 "tracing/smpi/format", "Select trace output format used by SMPI. The default is the 'Paje' format. "
280 "The 'TI' (Time-Independent) format allows for trace replay.",
283 simgrid::config::declare_flag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
284 "(smpi only) For replay format only : output to one file only", false);
285 simgrid::config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"});
286 simgrid::config::declare_flag<std::string>("tracing/comment", "Add a comment line to the top of the trace file.", "");
287 simgrid::config::declare_flag<std::string>(OPT_TRACING_COMMENT_FILE,
288 "Add the contents of a file as comments to the top of the trace.", "");
289 simgrid::config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"});
290 simgrid::config::declare_flag<int>("tracing/precision", "Numerical precision used when timestamping events "
291 "(expressed in number of digits after decimal point)",
294 /* Connect callbacks */
295 simgrid::s4u::on_platform_creation.connect(TRACE_start);
296 simgrid::s4u::on_deadlock.connect(TRACE_end);
297 simgrid::s4u::on_simulation_end.connect(TRACE_end);
300 static void print_line(const char* option, const char* desc, const char* longdesc)
302 std::string str = std::string("--cfg=") + option + " ";
304 int len = str.size();
305 printf("%s%*.*s %s\n", str.c_str(), 30 - len, 30 - len, "", desc);
306 if (longdesc != nullptr) {
307 printf ("%s\n\n", longdesc);
313 printf("Description of the tracing options accepted by this simulator:\n\n");
314 print_line(OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
315 " This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
316 " interface and generates a trace that can be analyzed using Gantt-like\n"
317 " visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
318 " state, and point-to-point communications can be analyzed with arrows.");
319 print_line(OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
320 " Disable the destruction of containers at the end of simulation. This can be\n"
321 " used with simulators that have a different notion of time (different from\n"
322 " the simulated time).");
323 print_line(OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
324 " Some visualization tools are not able to parse correctly the Paje file format.\n"
325 " Use this option if you are using one of these tools to visualize the simulation\n"
326 " trace. Keep in mind that the trace might be incomplete, without all the\n"
327 " information that would be registered otherwise.");
328 print_line(OPT_TRACING_FORMAT_TI_ONEFILE, "Only works for SMPI now, and TI output format",
329 " By default, each process outputs to a separate file, inside a filename_files folder\n"
330 " By setting this option to yes, all processes will output to only one file\n"
331 " This is meant to avoid opening thousands of files with large simulations");
332 print_line(OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
333 " This option (enabled by default) can be used to disable the tracing of\n"
334 " the platform topology in the trace file. Sometimes, such task is really\n"
335 " time consuming, since it must get the route from each host to other hosts\n"
336 " within the same Autonomous System (AS).");