1 /* Copyright (c) 2010-2018. 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" /* sg_cmdline */
15 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
18 std::ofstream tracing_file;
20 #define OPT_TRACING_BASIC "tracing/basic"
21 #define OPT_TRACING_COMMENT_FILE "tracing/comment-file"
22 #define OPT_TRACING_DISABLE_DESTROY "tracing/disable-destroy"
23 #define OPT_TRACING_FORMAT_TI_ONEFILE "tracing/smpi/format/ti-one-file"
24 #define OPT_TRACING_SMPI_INTERNALS "tracing/smpi/internals"
25 #define OPT_TRACING_SMPI "tracing/smpi"
26 #define OPT_TRACING_TOPOLOGY "tracing/platform/topology"
28 static simgrid::config::Flag<bool> trace_enabled{
29 "tracing", "Enable the tracing system. You have to enable this option to use other tracing options.", false};
31 static simgrid::config::Flag<bool> trace_actor_enabled{
32 "tracing/msg/process", // FIXME rename this flag
33 "Trace the behavior of all categorized actors, grouping them by host. "
34 "Can be used to track actor location if the simulator does actor migration.",
37 static simgrid::config::Flag<bool> trace_vm_enabled{"tracing/vm", "Trace the behavior of all virtual machines.", false};
39 static simgrid::config::Flag<bool> trace_platform{"tracing/platform",
40 "Register the platform in the trace as a hierarchy.", false};
42 static simgrid::config::Flag<bool> trace_platform_topology{
43 OPT_TRACING_TOPOLOGY, "Register the platform topology in the trace as a graph.", true};
44 static simgrid::config::Flag<bool> trace_smpi_enabled{OPT_TRACING_SMPI, "Tracing of the SMPI interface.", false};
45 static simgrid::config::Flag<bool> trace_smpi_grouped{"tracing/smpi/group", "Group MPI processes by host.", false};
47 static simgrid::config::Flag<bool> trace_smpi_computing{
48 "tracing/smpi/computing", "Generate 'Computing' states to trace the out-of-SMPI parts of the application", false};
50 static simgrid::config::Flag<bool> trace_smpi_sleeping{
51 "tracing/smpi/sleeping", "Generate 'Sleeping' states for the sleeps in the application that do not pertain to SMPI",
54 static simgrid::config::Flag<bool> trace_view_internals{
55 "tracing/smpi/internals",
56 "Generate tracing events corresponding to point-to-point messages sent by SMPI collective communications", false};
58 static simgrid::config::Flag<bool> trace_categorized{
59 "tracing/categorized", "Trace categorized resource utilization of hosts and links.", false};
61 static simgrid::config::Flag<bool> trace_uncategorized{
62 "tracing/uncategorized",
63 "Trace uncategorized resource utilization of hosts and links. "
64 "To use if the simulator does not use tracing categories but resource utilization have to be traced.",
67 static simgrid::config::Flag<bool> trace_disable_destroy{
68 OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false};
69 static simgrid::config::Flag<bool> trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
72 static simgrid::config::Flag<bool> trace_display_sizes{
73 "tracing/smpi/display-sizes",
74 "Add message size information (in bytes) to the to links and states (SMPI only). "
75 "For collectives, it usually corresponds to the total number of bytes sent by a process.",
78 static simgrid::config::Flag<bool> trace_disable_link{"tracing/disable_link",
79 "Do not trace link bandwidth and latency.", false};
80 static simgrid::config::Flag<bool> trace_disable_power{"tracing/disable_power", "Do not trace host power.", false};
82 static bool trace_active = false;
84 simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje;
86 static void TRACE_start()
91 // tracing system must be:
92 // - enabled (with --cfg=tracing:yes)
93 // - already configured (TRACE_global_init already called)
94 if (TRACE_is_enabled()) {
95 instr_define_callbacks();
97 XBT_DEBUG("Tracing starts");
98 /* init the tracing module to generate the right output */
99 std::string format = simgrid::config::get_value<std::string>("tracing/smpi/format");
100 XBT_DEBUG("Tracing format %s", format.c_str());
102 /* open the trace file(s) */
103 std::string filename = TRACE_get_filename();
104 tracing_file.open(filename.c_str(), std::ofstream::out);
105 if (tracing_file.fail()) {
106 THROWF(system_error, 1, "Tracefile %s could not be opened for writing.", filename.c_str());
109 XBT_DEBUG("Filename %s is open for writing", filename.c_str());
111 if (format == "Paje") {
112 /* output generator version */
113 tracing_file << "#This file was generated using SimGrid-" << SIMGRID_VERSION_MAJOR << "." << SIMGRID_VERSION_MINOR
114 << "." << SIMGRID_VERSION_PATCH << std::endl;
115 tracing_file << "#[";
118 xbt_dynar_foreach (xbt_cmdline, cpt, str) {
119 tracing_file << str << " ";
121 tracing_file << "]" << std::endl;
124 /* output one line comment */
125 dump_comment(simgrid::config::get_value<std::string>("tracing/comment"));
127 /* output comment file */
128 dump_comment_file(simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT_FILE));
130 if (format == "Paje") {
131 /* output Pajé header */
132 TRACE_header(TRACE_basic(), TRACE_display_sizes());
134 simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti;
137 XBT_DEBUG("Tracing is on");
141 static void TRACE_end()
143 if (not trace_active)
146 /* dump trace buffer */
147 TRACE_last_timestamp_to_dump = surf_get_clock();
148 TRACE_paje_dump_buffer(true);
150 simgrid::instr::Type* root_type = simgrid::instr::Container::get_root()->type_;
151 /* destroy all data structures of tracing (and free) */
152 delete simgrid::instr::Container::get_root();
155 /* close the trace files */
156 tracing_file.close();
157 XBT_DEBUG("Filename %s is closed", TRACE_get_filename().c_str());
159 /* de-activate trace */
160 trace_active = false;
161 XBT_DEBUG("Tracing is off");
162 XBT_DEBUG("Tracing system is shutdown");
165 bool TRACE_needs_platform ()
167 return TRACE_actor_is_enabled() || TRACE_vm_is_enabled() || TRACE_categorized() || TRACE_uncategorized() ||
168 TRACE_platform() || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
171 bool TRACE_is_enabled()
173 return trace_enabled;
176 bool TRACE_platform()
178 return trace_platform;
181 bool TRACE_platform_topology()
183 return trace_platform_topology;
186 bool TRACE_smpi_is_enabled()
188 return (trace_smpi_enabled || TRACE_smpi_is_grouped()) && TRACE_is_enabled();
191 bool TRACE_smpi_is_grouped()
193 return trace_smpi_grouped;
196 bool TRACE_smpi_is_computing()
198 return trace_smpi_computing;
201 bool TRACE_smpi_is_sleeping()
203 return trace_smpi_sleeping;
206 bool TRACE_smpi_view_internals()
208 return trace_view_internals;
211 bool TRACE_categorized ()
213 return trace_categorized;
216 bool TRACE_uncategorized ()
218 return trace_uncategorized;
221 bool TRACE_actor_is_enabled()
223 return trace_actor_enabled && trace_enabled;
226 bool TRACE_vm_is_enabled()
228 return trace_vm_enabled && trace_enabled;
231 bool TRACE_disable_link()
233 return trace_disable_link && trace_enabled;
236 bool TRACE_disable_speed()
238 return trace_disable_power && trace_enabled;
241 bool TRACE_disable_destroy ()
243 return trace_disable_destroy && trace_enabled;
248 return trace_basic && trace_enabled;
251 bool TRACE_display_sizes ()
253 return trace_display_sizes && trace_smpi_enabled && trace_enabled;
256 int TRACE_precision ()
258 return simgrid::config::get_value<int>("tracing/precision");
261 std::string TRACE_get_filename()
263 return simgrid::config::get_value<std::string>("tracing/filename");
266 void TRACE_global_init()
268 static bool is_initialised = false;
272 is_initialised = true;
274 /* name of the tracefile */
275 simgrid::config::declare_flag<std::string>("tracing/filename", "Trace file created by the instrumented SimGrid.",
277 simgrid::config::declare_flag<std::string>(
278 "tracing/smpi/format", "Select trace output format used by SMPI. The default is the 'Paje' format. "
279 "The 'TI' (Time-Independent) format allows for trace replay.",
282 simgrid::config::declare_flag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
283 "(smpi only) For replay format only : output to one file only", false);
284 simgrid::config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"});
285 simgrid::config::declare_flag<std::string>("tracing/comment", "Add a comment line to the top of the trace file.", "");
286 simgrid::config::declare_flag<std::string>(OPT_TRACING_COMMENT_FILE,
287 "Add the contents of a file as comments to the top of the trace.", "");
288 simgrid::config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"});
289 simgrid::config::declare_flag<int>("tracing/precision", "Numerical precision used when timestamping events "
290 "(expressed in number of digits after decimal point)",
293 /* Connect callbacks */
294 simgrid::s4u::on_platform_creation.connect(TRACE_start);
295 simgrid::s4u::on_deadlock.connect(TRACE_end);
296 simgrid::s4u::on_simulation_end.connect(TRACE_end);
299 static void print_line(const char* option, const char* desc, const char* longdesc)
301 std::string str = std::string("--cfg=") + option + " ";
303 int len = str.size();
304 printf("%s%*.*s %s\n", str.c_str(), 30 - len, 30 - len, "", desc);
305 if (longdesc != nullptr) {
306 printf ("%s\n\n", longdesc);
312 printf("Description of the tracing options accepted by this simulator:\n\n");
313 print_line(OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
314 " This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
315 " interface and generates a trace that can be analyzed using Gantt-like\n"
316 " visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
317 " state, and point-to-point communications can be analyzed with arrows.");
318 print_line(OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
319 " Disable the destruction of containers at the end of simulation. This can be\n"
320 " used with simulators that have a different notion of time (different from\n"
321 " the simulated time).");
322 print_line(OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
323 " Some visualization tools are not able to parse correctly the Paje file format.\n"
324 " Use this option if you are using one of these tools to visualize the simulation\n"
325 " trace. Keep in mind that the trace might be incomplete, without all the\n"
326 " information that would be registered otherwise.");
327 print_line(OPT_TRACING_FORMAT_TI_ONEFILE, "Only works for SMPI now, and TI output format",
328 " By default, each process outputs to a separate file, inside a filename_files folder\n"
329 " By setting this option to yes, all processes will output to only one file\n"
330 " This is meant to avoid opening thousands of files with large simulations");
331 print_line(OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
332 " This option (enabled by default) can be used to disable the tracing of\n"
333 " the platform topology in the trace file. Sometimes, such task is really\n"
334 " time consuming, since it must get the route from each host to other hosts\n"
335 " within the same Autonomous System (AS).");