tracing-related features can be enabled and used during the
development of simulators using the SimGrid library.
-\section tracing_tracing_enabling Enabling using CMake
-
-With the sources of SimGrid, it is possible to enable the tracing
-using the parameter <b>-Denable_tracing=ON</b> when the cmake is
-executed. The sections \ref instr_category_functions, \ref
-instr_mark_functions, and \ref instr_uservariables_functions describe
-all the functions available when this Cmake options is
-activated. These functions will have no effect if SimGrid is
-configured without this option (they are wiped-out by the
-C-preprocessor).
-
-\verbatim
-$ cmake -Denable_tracing=ON .
-$ make
-\endverbatim
-
\section instr_category_functions Tracing categories functions
The SimGrid library is instrumented so users can trace the platform
\endverbatim
If you do not provide this parameter, the trace file will be named simgrid.trace.
-\li <b>\c
-tracing/onelink_only
-</b>:
- By default, the tracing system uses all routes in the platform file
- to re-create a "graph" of the platform and register it in the trace file.
- This option let the user tell the tracing system to use only the routes
- that are composed with just one link.
-\verbatim
---cfg=tracing/onelink_only:yes
-\endverbatim
-
\li <b>\c
tracing/smpi
</b>:
\endverbatim
\li <b>\c
-tracing/smpi/display_sizes
+tracing/smpi/display-sizes
</b>:
This option only has effect if this simulator is SMPI-based. Display the sizes of the messages
exchanged in the trace, both in the links and on the states. For collective, size means the global size of data sent by the process in general.
\verbatim
---cfg=tracing/smpi/display_sizes:yes
+--cfg=tracing/smpi/display-sizes:yes
+\endverbatim
+
+\li <b>\c
+tracing/smpi/sleeping
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/smpi/format
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/smpi/format/ti-one-file
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/msg/vm
+</b>:
+TODO
+\verbatim
+TODO
\endverbatim
\li <b>\c
\endverbatim
\li <b>\c
-tracing/onelink_only
+tracing/onelink-only
</b>:
This option changes the way SimGrid register its platform on the trace
file. Normally, the tracing considers all routes (no matter their
register the topology within an AS. Routes among AS continue to be
traced as usual.
\verbatim
---cfg=tracing/onelink_only:yes
+--cfg=tracing/onelink-only:yes
+\endverbatim
+
+\li <b>\c
+tracing/disable-link
+</b>:
+TODO
+\verbatim
+TODO
\endverbatim
\li <b>\c
-tracing/disable_destroy
+tracing/disable-power
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/disable-destroy
</b>:
Disable the destruction of containers at the end of simulation. This
can be used with simulators that have a different notion of time
(different from the simulated time).
\verbatim
---cfg=tracing/disable_destroy:yes
+--cfg=tracing/disable-destroy:yes
\endverbatim
\li <b>\c
\endverbatim
\li <b>\c
-tracing/comment_file
+tracing/comment-file
</b>:
Use this to add the contents of a file to the top of the trace file as comment.
\verbatim
---cfg=tracing/comment_file:textual_file.txt
+--cfg=tracing/comment-file:textual_file.txt
+\endverbatim
+
+\li <b>\c
+tracing/precision
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/platform
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/platform/topology
+</b>:
+TODO
+\verbatim
+TODO
\endverbatim
\li <b>\c
\subsubsection tracing_viva_graph Hierarchical Graph View
-As stated above (see section \ref tracing_tracing_analyzing), one
+%As stated above (see section \ref tracing_tracing_analyzing), one
possibility to analyze SimGrid traces is to use Viva's graph view with
a graph configuration to customize the graph according to the
traces. A valid graph configuration (we are using the non-XML <a
