Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker: remove subcategory log unused
[simgrid.git] / doc / options.doc
index 54e34bc..85519c5 100644 (file)
@@ -163,6 +163,17 @@ the \b maxmin/precision item (default value: 1e-9). Changing it
 may speedup the simulation by discarding very small actions, at the
 price of a reduced numerical precision.
 
+\subsection options_model_nthreads Parallel threads for model updates
+
+By default, Surf computes the analytical models sequentially to share their
+resources and update their actions. It is possible to run them in parallel,
+using the \b surf/nthreads item (default value: 1). If you use a
+negative value, the amount of available cores is automatically
+detected  and used instead.
+
+Depending on the workload of the models and their complexity, you may get a
+speedup or a slowdown because of the synchronization costs of threads.
+
 \subsection options_model_network Configuring the Network model
 
 \subsubsection options_model_network_gamma Maximal TCP window size
@@ -205,7 +216,9 @@ pair of interconnected hosts. An example of usable platform is
 available in <tt>examples/msg/gtnets/crosstraffic-p.xml</tt>.
 
 This is activated through the \b network/crosstraffic item, that
-can be set to 0 (disable this feature) or 1 (enable it).
+can be set to 0 (disable this feature) or 1 (enable it). 
+
+Note that with the default workstation model this option is activated by default.
 
 \subsubsection options_model_network_coord Coordinated-based network models
 
@@ -312,7 +325,8 @@ If you are using the \c ucontext or \c raw context factories, you can
 request to execute the user code in parallel. Several threads are
 launched, each of them handling as much user contexts at each run. To
 actiave this, set the \b contexts/nthreads item to the amount of
-core that you have in your computer.
+cores that you have in your computer (or -1 to have the amount of cores
+auto-detected).
 
 Even if you asked several worker threads using the previous option,
 you can request to start the parallel execution (and pay the
@@ -465,6 +479,8 @@ when \b verbose-exit is set to 0 (it is to 1 by default).
 
 - \c ns3/TcpModel: \ref options_pls
 
+- \c surf/nthreads: \ref options_model_nthreads
+
 - \c smpi/running_power: \ref options_smpi_bench
 - \c smpi/display_timing: \ref options_smpi_timing
 - \c smpi/cpu_threshold: \ref options_smpi_bench