Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[Documentation] Added a note for smpi/cpu_threshold
[simgrid.git] / doc / doxygen / options.doc
index b3d76a9..deb7509 100644 (file)
@@ -394,6 +394,14 @@ This only works in safety mode.
 
 This options is disabled by default.
 
+\subsection options_modelchecking_dot_output model-check/dot_output, Dot output
+
+If set, the \b model-check/dot_output configuration item is the name of a file
+in which to write a dot file of the path leading the found property (safety or
+liveness violation) as well as the cycle for liveness properties. This dot file
+can then fed to the graphviz dot tool to generate an corresponding graphical
+representation.
+
 \subsection options_modelchecking_max_depth model-check/max_depth, Depth limit
 
 The \b model-checker/max_depth can set the maximum depth of the exploration
@@ -471,7 +479,7 @@ Currently most of the state is not included in the hash because the
 implementation was found to be buggy and this options is not as useful as
 it could be. For this reason, it is currently disabled by default.
 
-\subsection options_recordreplay Record/replay (experimental)
+\subsection options_modelchecking_recordreplay Record/replay (experimental)
 
 As the model-checker keeps jumping at different places in the execution graph,
 it is difficult to understand what happens when trying to debug an application
@@ -693,10 +701,17 @@ to update it to get accurate simulation results.
 When the code is constituted of numerous consecutive MPI calls, the
 previous mechanism feeds the simulation kernel with numerous tiny
 computations. The \b smpi/cpu_threshold item becomes handy when this
-impacts badly the simulation performance. It specify a threshold (in
-second) under which the execution chunks are not reported to the
-simulation kernel (default value: 1e-6). Please note that in some
-circonstances, this optimization can hinder the simulation accuracy.
+impacts badly the simulation performance. It specifies a threshold (in
+seconds) below which the execution chunks are not reported to the
+simulation kernel (default value: 1e-6).
+
+
+\note
+    The option smpi/cpu_threshold ignores any computation time spent
+    below this threshold. SMPI does not consider the \a amount of these
+    computations; there is no offset for this. Hence, by using a
+    value that is too low, you may end up with unreliable simulation
+    results.
 
  In some cases, however, one may wish to disable simulation of
 application computation. This is the case when SMPI is used not to
@@ -955,7 +970,7 @@ silently overflow on other parts of the memory.
 - \c model-check: \ref options_modelchecking
 - \c model-check/checkpoint: \ref options_modelchecking_steps
 - \c model-check/communications_determinism: \ref options_modelchecking_comm_determinism
-- \c model-check/communications_determinism: \ref options_modelchecking_send_determinism
+- \c model-check/send_determinism: \ref options_modelchecking_comm_determinism
 - \c model-check/dot_output: \ref options_modelchecking_dot_output
 - \c model-check/hash: \ref options_modelchecking_hash
 - \c model-check/property: \ref options_modelchecking_liveness