Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
don't document an option that is long gone
[simgrid.git] / doc / doxygen / options.doc
index 27e205d..2f5f95f 100644 (file)
@@ -117,11 +117,10 @@ described in
     lmm_solve (experts only; check the code for more info).
 
 If you compiled SimGrid accordingly, you can use packet-level network
-simulators as network models (see \ref pls). In that case, you have
+simulators as network models (see \ref pls_ns3). In that case, you have
 two extra models, described below, and some \ref options_pls "specific
 additional configuration flags".
-  - \b NS3: Network pseudo-model using the NS3 tcp model instead of an
-    analytic model
+  - \b NS3: Network pseudo-model using the NS3 tcp model
 
 Concerning the CPU, we have only one model for now:
   - \b Cas01: Simplistic CPU model (time=size/power)
@@ -140,7 +139,8 @@ when using SimDag.
   - \b compound: Host model that is automatically chosen if
     you change the network and CPU models
   - \b ptask_L07: Host model somehow similar to Cas01+CM02 but
-    allowing parallel tasks
+    allowing "parallel tasks", that are intended to model the moldable
+    tasks of the grid scheduling literature.
 
 \subsection options_generic_plugin Plugins
 
@@ -199,17 +199,6 @@ the \b maxmin/precision item (default value: 0.00001). 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 or null 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
@@ -636,7 +625,7 @@ which value is either:
 
 \section options_tracing Configuring the tracing subsystem
 
-The \ref tracing "tracing subsystem" can be configured in several
+The \ref outcomes_vizu "tracing subsystem" can be configured in several
 different ways depending on the nature of the simulator (MSG, SimDag,
 SMPI) and the kind of traces that need to be obtained. See the \ref
 tracing_tracing_options "Tracing Configuration Options subsection" to
@@ -845,6 +834,30 @@ This is the default value:
     1. http://simgrid.gforge.inria.fr/contrib/smpi-calibration-doc.html
     2. http://simgrid.gforge.inria.fr/contrib/smpi-saturation-doc.html
 
+\subsection options_smpi_papi_events smpi/papi-events: Trace hardware counters with PAPI
+
+\warning 
+    This option is experimental and will be subject to change.
+    This feature currently requires superuser privileges, as registers are queried.
+    Only use this feature with code you trust! Call smpirun for instance via
+        smpirun -wrapper "sudo " <your-parameters>
+    or run sudo sh -c "echo 0 > /proc/sys/kernel/perf_event_paranoid"
+    In the later case, sudo will not be required.
+
+\note
+    This option is only available when SimGrid was compiled with PAPI support.
+
+This option takes the names of PAPI counters and adds their respective values
+to the trace files. (See Section \ref tracing_tracing_options.)
+
+It is planned to make this feature available on a per-process (or per-thread?) basis.
+The first draft, however, just implements a "global" (i.e., for all processes) set
+of counters, the "default" set.
+
+\verbatim
+--cfg=smpi/papi-events:"default:PAPI_L3_LDM:PAPI_L2_LDM"
+\endverbatim
+
 \subsection options_smpi_global smpi/privatize-global-variables: Automatic privatization of global variables
 
 MPI executables are meant to be executed in separated processes, but SMPI is
@@ -874,6 +887,9 @@ To avoid this, several options are possible :
   To use this runtime automatic switching, the variable \b smpi/privatize-global-variables
   should be set to yes
 
+\warning
+  This configuration option cannot be set in your platform file. You can only
+  pass it as an argument to smpirun.
 
 
 \subsection options_model_smpi_detached Simulating MPI detached send
@@ -882,7 +898,7 @@ This threshold specifies the size in bytes under which the send will return
 immediately. This is different from the threshold detailed in  \ref options_model_network_asyncsend
 because the message is not effectively sent when the send is posted. SMPI still waits for the
 correspondant receive to be posted to perform the communication operation. This threshold can be set
-by changing the \b smpi/send-is-detached item. The default value is 65536.
+by changing the \b smpi/send-is-detached-thresh item. The default value is 65536.
 
 \subsection options_model_smpi_collectives Simulating MPI collective algorithms
 
@@ -899,6 +915,13 @@ uses naive version of collective operations). Each collective operation can be m
 The behavior and motivation for this configuration option is identical with \a smpi/test, see
 Section \ref options_model_smpi_test for details.
 
+\subsection options_model_smpi_init smpi/init: Inject constant times for calls to MPI_Init
+
+\b Default value: 0
+
+The behavior for this configuration option is identical with \a smpi/test, see
+Section \ref options_model_smpi_test for details.
+
 \subsection options_model_smpi_ois smpi/ois: Inject constant times for asynchronous send operations
 
 This configuration option works exactly as \a smpi/os, see Section \ref options_model_smpi_os.
@@ -1045,13 +1068,16 @@ when \b verbose-exit is set to 0 (it is to 1 by default).
 
 \subsection options_exception_cutpath Truncate local path from exception backtrace
 
-<b>This configuration option is an internal option and should normally not be used
-by the user.</b> It is used to remove the path from the backtrace
-shown when an exception is thrown; if we didn't remove this part, the tests
-testing the exception parts of simgrid would fail on most machines, as we are
-currently comparing output. Clearly, the path used on different machines are almost
-guaranteed to be different and hence, the output would
-mismatch, causing the test to fail.
+\verbatim
+--cfg=exceptions/cutpath:1
+\endverbatim
+
+This configuration option is used to remove the path from the
+backtrace shown when an exception is thrown. This is mainly useful for
+the tests: the full file path makes the tests not reproducible, and
+thus failing as we are currently comparing output. Clearly, the path
+used on different machines are almost guaranteed to be different and
+hence, the output would mismatch, causing the test to fail.
 
 \section options_log Logging Configuration
 
@@ -1151,9 +1177,11 @@ silently overflow on other parts of the memory.
 - \c smpi/lat-factor: \ref options_model_smpi_lat_factor
 - \c smpi/IB-penalty-factors: \ref options_model_network_coefs
 - \c smpi/iprobe: \ref options_model_smpi_iprobe
+- \c smpi/init: \ref options_model_smpi_init
 - \c smpi/ois: \ref options_model_smpi_ois
 - \c smpi/or: \ref options_model_smpi_or
 - \c smpi/os: \ref options_model_smpi_os
+- \c smpi/papi-events: \ref options_smpi_papi_events
 - \c smpi/privatize-global-variables: \ref options_smpi_global
 - \c smpi/running-power: \ref options_smpi_bench
 - \c smpi/send-is-detached-thresh: \ref options_model_smpi_detached