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"
13 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
16 #define OPT_TRACING_BASIC "tracing/basic"
17 #define OPT_TRACING_BUFFER "tracing/buffer"
18 #define OPT_TRACING_CATEGORIZED "tracing/categorized"
19 #define OPT_TRACING_COMMENT_FILE "tracing/comment-file"
20 #define OPT_TRACING_COMMENT "tracing/comment"
21 #define OPT_TRACING_DISABLE_DESTROY "tracing/disable-destroy"
22 #define OPT_TRACING_DISABLE_LINK "tracing/disable-link"
23 #define OPT_TRACING_DISABLE_POWER "tracing/disable-power"
24 #define OPT_TRACING_DISPLAY_SIZES "tracing/smpi/display-sizes"
25 #define OPT_TRACING_FILENAME "tracing/filename"
26 #define OPT_TRACING_FORMAT_TI_ONEFILE "tracing/smpi/format/ti-one-file"
27 #define OPT_TRACING_FORMAT "tracing/smpi/format"
28 #define OPT_TRACING_ACTOR "tracing/msg/process"
29 #define OPT_TRACING_VM "tracing/vm"
30 #define OPT_TRACING_PLATFORM "tracing/platform"
31 #define OPT_TRACING_PRECISION "tracing/precision"
32 #define OPT_TRACING_SMPI_COMPUTING "tracing/smpi/computing"
33 #define OPT_TRACING_SMPI_GROUP "tracing/smpi/group"
34 #define OPT_TRACING_SMPI_INTERNALS "tracing/smpi/internals"
35 #define OPT_TRACING_SMPI_SLEEPING "tracing/smpi/sleeping"
36 #define OPT_TRACING_SMPI "tracing/smpi"
37 #define OPT_TRACING_TOPOLOGY "tracing/platform/topology"
38 #define OPT_TRACING "tracing"
39 #define OPT_TRACING_UNCATEGORIZED "tracing/uncategorized"
41 static simgrid::config::Flag<bool> trace_enabled{OPT_TRACING, "Enable Tracing.", false};
42 static simgrid::config::Flag<bool> trace_platform{OPT_TRACING_PLATFORM,
43 "Register the platform in the trace as a hierarchy.", false};
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{OPT_TRACING_SMPI_GROUP, "Group MPI processes by host.", false};
48 static simgrid::config::Flag<bool> trace_smpi_computing{
49 OPT_TRACING_SMPI_COMPUTING, "Generate states for timing out of SMPI parts of the application", false};
50 static simgrid::config::Flag<bool> trace_smpi_sleeping{
51 OPT_TRACING_SMPI_SLEEPING, "Generate states for timing out of SMPI parts of the application", false};
52 static simgrid::config::Flag<bool> trace_view_internals{
53 OPT_TRACING_SMPI_INTERNALS, "View internal messages sent by Collective communications in SMPI", false};
54 static simgrid::config::Flag<bool> trace_categorized{
55 OPT_TRACING_CATEGORIZED, "Tracing categorized resource utilization of hosts and links.", false};
56 static simgrid::config::Flag<bool> trace_uncategorized{
57 OPT_TRACING_UNCATEGORIZED, "Tracing uncategorized resource utilization of hosts and links.", false};
58 static simgrid::config::Flag<bool> trace_actor_enabled{OPT_TRACING_ACTOR, "Tracing of actor behavior.", false};
59 static simgrid::config::Flag<bool> trace_vm_enabled{OPT_TRACING_VM, "Tracing of virtual machine behavior.", false};
60 static simgrid::config::Flag<bool> trace_buffer{OPT_TRACING_BUFFER,
61 "Buffer trace events to put them in temporal order.", true};
62 static simgrid::config::Flag<bool> trace_disable_destroy{
63 OPT_TRACING_DISABLE_DESTROY, {"tracing/disable_destroy"}, "Disable platform containers destruction.", false};
64 static simgrid::config::Flag<bool> trace_basic{OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
66 static simgrid::config::Flag<bool> trace_display_sizes{OPT_TRACING_DISPLAY_SIZES,
67 {"tracing/smpi/display_sizes"},
68 "(smpi only) Extended events with message size information",
70 static simgrid::config::Flag<bool> trace_disable_link{
71 OPT_TRACING_DISABLE_LINK, {"tracing/disable_link"}, "Do not trace link bandwidth and latency.", false};
72 static simgrid::config::Flag<bool> trace_disable_power{
73 OPT_TRACING_DISABLE_POWER, {"tracing/disable_power"}, "Do not trace host power.", false};
75 static bool trace_active = false;
77 simgrid::instr::TraceFormat simgrid::instr::trace_format = simgrid::instr::TraceFormat::Paje;
79 static void TRACE_start()
84 // tracing system must be:
85 // - enabled (with --cfg=tracing:yes)
86 // - already configured (TRACE_global_init already called)
87 if (TRACE_is_enabled()) {
88 instr_define_callbacks();
90 XBT_DEBUG("Tracing starts");
91 /* init the tracing module to generate the right output */
93 /* open the trace file(s) */
94 std::string format = simgrid::config::get_value<std::string>(OPT_TRACING_FORMAT);
95 XBT_DEBUG("Tracing format %s", format.c_str());
96 if (format == "Paje") {
98 } else if (format == "TI") {
99 simgrid::instr::trace_format = simgrid::instr::TraceFormat::Ti;
102 xbt_die("Unknown trace format :%s ", format.c_str());
106 XBT_DEBUG("Tracing is on");
110 static void TRACE_end()
112 if (not trace_active)
115 /* dump trace buffer */
116 TRACE_last_timestamp_to_dump = surf_get_clock();
117 TRACE_paje_dump_buffer(true);
119 simgrid::instr::Type* root_type = simgrid::instr::Container::getRoot()->type_;
120 /* destroy all data structures of tracing (and free) */
121 delete simgrid::instr::Container::getRoot();
124 /* close the trace files */
125 std::string format = simgrid::config::get_value<std::string>(OPT_TRACING_FORMAT);
126 XBT_DEBUG("Tracing format %s\n", format.c_str());
127 if (format == "Paje") {
129 } else if (format == "TI") {
132 xbt_die("Unknown trace format :%s ", format.c_str());
135 /* de-activate trace */
136 trace_active = false;
137 XBT_DEBUG("Tracing is off");
138 XBT_DEBUG("Tracing system is shutdown");
141 bool TRACE_needs_platform ()
143 return TRACE_actor_is_enabled() || TRACE_vm_is_enabled() || TRACE_categorized() || TRACE_uncategorized() ||
144 TRACE_platform() || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
147 bool TRACE_is_enabled()
149 return trace_enabled;
152 bool TRACE_platform()
154 return trace_platform;
157 bool TRACE_platform_topology()
159 return trace_platform_topology;
162 bool TRACE_smpi_is_enabled()
164 return (trace_smpi_enabled || TRACE_smpi_is_grouped()) && TRACE_is_enabled();
167 bool TRACE_smpi_is_grouped()
169 return trace_smpi_grouped;
172 bool TRACE_smpi_is_computing()
174 return trace_smpi_computing;
177 bool TRACE_smpi_is_sleeping()
179 return trace_smpi_sleeping;
182 bool TRACE_smpi_view_internals()
184 return trace_view_internals;
187 bool TRACE_categorized ()
189 return trace_categorized;
192 bool TRACE_uncategorized ()
194 return trace_uncategorized;
197 bool TRACE_actor_is_enabled()
199 return trace_actor_enabled && trace_enabled;
202 bool TRACE_vm_is_enabled()
204 return trace_vm_enabled && trace_enabled;
207 bool TRACE_disable_link()
209 return trace_disable_link && trace_enabled;
212 bool TRACE_disable_speed()
214 return trace_disable_power && trace_enabled;
219 return trace_buffer && trace_enabled;
222 bool TRACE_disable_destroy ()
224 return trace_disable_destroy && trace_enabled;
229 return trace_basic && trace_enabled;
232 bool TRACE_display_sizes ()
234 return trace_display_sizes && trace_smpi_enabled && trace_enabled;
237 std::string TRACE_get_comment()
239 return simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT);
242 std::string TRACE_get_comment_file()
244 return simgrid::config::get_value<std::string>(OPT_TRACING_COMMENT_FILE);
247 int TRACE_precision ()
249 return simgrid::config::get_value<int>(OPT_TRACING_PRECISION);
252 std::string TRACE_get_filename()
254 return simgrid::config::get_value<std::string>(OPT_TRACING_FILENAME);
257 void TRACE_global_init()
259 static bool is_initialised = false;
263 is_initialised = true;
265 /* name of the tracefile */
266 simgrid::config::declare_flag<std::string>(OPT_TRACING_FILENAME, "Trace file created by the instrumented SimGrid.",
268 simgrid::config::declare_flag<std::string>(OPT_TRACING_FORMAT, "(smpi only) Switch the output format of Tracing",
270 simgrid::config::declare_flag<bool>(OPT_TRACING_FORMAT_TI_ONEFILE,
271 "(smpi only) For replay format only : output to one file only", false);
272 simgrid::config::alias(OPT_TRACING_FORMAT_TI_ONEFILE, {"tracing/smpi/format/ti_one_file"});
273 simgrid::config::declare_flag<std::string>(OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
275 simgrid::config::declare_flag<std::string>(
276 OPT_TRACING_COMMENT_FILE, "The contents of the file are added to the top of the trace file as comment.", "");
277 simgrid::config::alias(OPT_TRACING_COMMENT_FILE, {"tracing/comment_file"});
278 simgrid::config::declare_flag<int>(OPT_TRACING_PRECISION, "Numerical precision used when timestamping events "
279 "(expressed in number of digits after decimal point)",
282 /* Connect callbacks */
283 simgrid::s4u::on_platform_creation.connect(TRACE_start);
284 simgrid::s4u::on_deadlock.connect(TRACE_end);
285 simgrid::s4u::on_simulation_end.connect(TRACE_end);
288 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
290 std::string str = std::string("--cfg=") + option + " ";
292 int len = str.size();
293 printf("%s%*.*s %s\n", str.c_str(), 30 - len, 30 - len, "", desc);
294 if (longdesc != nullptr && detailed){
295 printf ("%s\n\n", longdesc);
299 void TRACE_help (int detailed)
301 printf("Description of the tracing options accepted by this simulator:\n\n");
302 print_line (OPT_TRACING, "Enable the tracing system",
303 " It activates the tracing system and register the simulation platform\n"
304 " in the trace file. You have to enable this option to others take effect.", detailed);
305 print_line (OPT_TRACING_CATEGORIZED, "Trace categorized resource utilization",
306 " It activates the categorized resource utilization tracing. It should\n"
307 " be enabled if tracing categories are used by this simulator.", detailed);
308 print_line (OPT_TRACING_UNCATEGORIZED, "Trace uncategorized resource utilization",
309 " It activates the uncategorized resource utilization tracing. Use it if\n"
310 " this simulator do not use tracing categories and resource use have to be\n"
311 " traced.", detailed);
312 print_line(OPT_TRACING_FILENAME, "Filename to register traces",
313 " A file with this name will be created to register the simulation. The file\n"
314 " is in the Paje format and can be analyzed using Paje, and PajeNG visualization\n"
315 " tools. More information can be found in these webpages:\n"
316 " http://github.com/schnorr/pajeng/\n"
317 " http://paje.sourceforge.net/",
319 print_line (OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
320 " This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
321 " interface and generates a trace that can be analyzed using Gantt-like\n"
322 " visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
323 " state, and point-to-point communications can be analyzed with arrows.", detailed);
324 print_line (OPT_TRACING_SMPI_GROUP, "Group MPI processes by host (SMPI)",
325 " This option only has effect if this simulator is SMPI-based. The processes\n"
326 " are grouped by the hosts where they were executed.", detailed);
327 print_line (OPT_TRACING_SMPI_COMPUTING, "Generates a \" Computing \" State",
328 " This option aims at tracing computations in the application, outside SMPI\n"
329 " to allow further study of simulated or real computation time", detailed);
330 print_line (OPT_TRACING_SMPI_SLEEPING, "Generates a \" Sleeping \" State",
331 " This option aims at tracing sleeps in the application, outside SMPI\n"
332 " to allow further study of simulated or real sleep time", detailed);
333 print_line (OPT_TRACING_SMPI_INTERNALS, "Generates tracing events corresponding",
334 " to point-to-point messages sent by collective communications", detailed);
335 print_line(OPT_TRACING_ACTOR, "Trace actor behavior",
336 " This option traces the behavior of all categorized actors, grouping them\n"
337 " by hosts. This option can be used to track actor location if the simulator\n"
338 " does actor migration.",
340 print_line (OPT_TRACING_BUFFER, "Buffer events to put them in temporal order",
341 " This option put some events in a time-ordered buffer using the insertion\n"
342 " sort algorithm. The process of acquiring and releasing locks to access this\n"
343 " buffer and the cost of the sorting algorithm make this process slow. The\n"
344 " simulator performance can be severely impacted if this option is activated,\n"
345 " but you are sure to get a trace file with events sorted.", detailed);
346 print_line (OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
347 " Disable the destruction of containers at the end of simulation. This can be\n"
348 " used with simulators that have a different notion of time (different from\n"
349 " the simulated time).", detailed);
350 print_line (OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
351 " Some visualization tools are not able to parse correctly the Paje file format.\n"
352 " Use this option if you are using one of these tools to visualize the simulation\n"
353 " trace. Keep in mind that the trace might be incomplete, without all the\n"
354 " information that would be registered otherwise.", detailed);
355 print_line (OPT_TRACING_DISPLAY_SIZES, "Only works for SMPI now. Add message size information",
356 " Message size (in bytes) is added to links, and to states. For collectives,\n"
357 " the displayed value is the more relevant to the collective (total sent by\n"
358 " the process, usually)", detailed);
359 print_line (OPT_TRACING_FORMAT, "Only works for SMPI now. Switch output format",
360 " Default format is Paje. Time independent traces are also supported,\n"
361 " to output traces that can later be used by the trace replay tool", detailed);
362 print_line (OPT_TRACING_FORMAT_TI_ONEFILE, "Only works for SMPI now, and TI output format",
363 " By default, each process outputs to a separate file, inside a filename_files folder\n"
364 " By setting this option to yes, all processes will output to only one file\n"
365 " This is meant to avoid opening thousands of files with large simulations", detailed);
366 print_line (OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
367 " Use this to add a comment line to the top of the trace file.", detailed);
368 print_line (OPT_TRACING_COMMENT_FILE, "File contents added to trace file as comment.",
369 " Use this to add the contents of a file to the top of the trace file as comment.", detailed);
370 print_line (OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
371 " This option (enabled by default) can be used to disable the tracing of\n"
372 " the platform topology in the trace file. Sometimes, such task is really\n"
373 " time consuming, since it must get the route from each host to other hosts\n"
374 " within the same Autonomous System (AS).", detailed);