Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Ensure that the dict subsystem is initialized when creating a dict
[simgrid.git] / doc / doxygen / options.doc
index 528ecd5..b64faef 100644 (file)
@@ -1,4 +1,4 @@
-/*! \page options Simgrid options and configurations
+/*! \page options Configure SimGrid
 
 A number of options can be given at runtime to change the default
 SimGrid behavior. For a complete list of all configuration options
@@ -9,6 +9,8 @@ report so that we can fix it. Note that some of the options presented
 here may not be available in your simulators, depending on the
 @ref install_src_config "compile-time options" that you used.
 
+\tableofcontents
+
 \section options_using Passing configuration options to the simulators
 
 There is several way to pass configuration options to the simulators.
@@ -64,9 +66,11 @@ int main(int argc, char *argv[]) {
 
 \section options_model Configuring the platform models
 
+\anchor options_storage_model
+\anchor options_vm_model
 \subsection options_model_select Selecting the platform models
 
-SimGrid comes with several network and CPU models built in, and you
+SimGrid comes with several network, CPU and storage models built in, and you
 can change the used model at runtime by changing the passed
 configuration. The three main configuration items are given below.
 For each of these items, passing the special \c help value gives
@@ -74,7 +78,9 @@ you a short description of all possible values. Also, \c --help-models
 should provide information about all models for all existing resources.
    - \b network/model: specify the used network model
    - \b cpu/model: specify the used CPU model
-   - \b workstation/model: specify the used workstation model
+   - \b host/model: specify the used host model
+   - \b storage/model: specify the used storage model (there is currently only one such model - this option is hence only useful for future releases)
+   - \b vm/model: specify the model for virtual machines (there is currently only one such model - this option is hence only useful for future releases)
 
 %As of writing, the following network models are accepted. Over
 the time new models can be added, and some experimental models can be
@@ -88,7 +94,7 @@ described in
   - \b LV08 (default one): Realistic network analytic model
     (slow-start modeled by multiplying latency by 10.4, bandwidth by
     .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT)
-  - \b Constant: Simplistic network model where all communication
+  - \anchor options_model_select_network_constant \b Constant: Simplistic network model where all communication
     take a constant time (one second). This model provides the lowest
     realism, but is (marginally) faster.
   - \b SMPI: Realistic network model specifically tailored for HPC
@@ -114,30 +120,49 @@ If you compiled SimGrid accordingly, you can use packet-level network
 simulators as network models (see \ref pls). In that case, you have
 two extra models, described below, and some \ref options_pls "specific
 additional configuration flags".
-  - \b GTNets: Network pseudo-model using the GTNets simulator instead
-    of an analytic model
   - \b NS3: Network pseudo-model using the NS3 tcp model instead of an
     analytic model
 
 Concerning the CPU, we have only one model for now:
   - \b Cas01: Simplistic CPU model (time=size/power)
 
-The workstation concept is the aggregation of a CPU with a network
+The host concept is the aggregation of a CPU with a network
 card. Three models exists, but actually, only 2 of them are
 interesting. The "compound" one is simply due to the way our internal
 code is organized, and can easily be ignored. So at the end, you have
-two workstation models: The default one allows to aggregate an
+two host models: The default one allows to aggregate an
 existing CPU model with an existing network model, but does not allow
 parallel tasks because these beasts need some collaboration between
 the network and CPU model. That is why, ptask_07 is used by default
 when using SimDag.
-  - \b default: Default workstation model. Currently, CPU:Cas01 and
+  - \b default: Default host model. Currently, CPU:Cas01 and
     network:LV08 (with cross traffic enabled)
-  - \b compound: Workstation model that is automatically chosen if
+  - \b compound: Host model that is automatically chosen if
     you change the network and CPU models
-  - \b ptask_L07: Workstation model somehow similar to Cas01+CM02 but
+  - \b ptask_L07: Host model somehow similar to Cas01+CM02 but
     allowing parallel tasks
 
+\subsection options_generic_plugin Plugins
+
+SimGrid supports the use of plugins; currently, no known plugins
+can be activated but there are use-cases where you may want to write
+your own plugin (for instance, for logging).
+
+Plugins can for instance define own classes that inherit from
+existing classes (for instance, a class "CpuEnergy" inherits from
+"Cpu" to assess energy consumption).
+
+The plugin connects to the code by registering callbacks using
+``signal.connect(callback)`` (see file ``src/surf/plugins/energy.cpp`` for
+details).
+
+\verbatim
+    --cfg=plugin:Energy
+\endverbatim
+
+\note
+    This option is case-sensitive: Energy and energy are not the same!
+
 \subsection options_model_optim Optimization level of the platform models
 
 The network and CPU models that are based on lmm_solve (that
@@ -151,16 +176,16 @@ configurations.
       now).
     - \b Full: Full update of remaining and variables. Slow but may be
       useful when debugging.
-  - items \b network/maxmin_selective_update and
-    \b cpu/maxmin_selective_update: configure whether the underlying
+  - items \b network/maxmin-selective-update and
+    \b cpu/maxmin-selective-update: configure whether the underlying
     should be lazily updated or not. It should have no impact on the
     computed timings, but should speed up the computation.
 
-It is still possible to disable the \c maxmin_selective_update feature
+It is still possible to disable the \c maxmin-selective-update feature
 because it can reveal counter-productive in very specific scenarios
 where the interaction level is high. In particular, if all your
 communication share a given backbone link, you should disable it:
-without \c maxmin_selective_update, every communications are updated
+without \c maxmin-selective-update, every communications are updated
 at each step through a simple loop over them. With that feature
 enabled, every communications will still get updated in this case
 (because of the dependency induced by the backbone), but through a
@@ -191,7 +216,7 @@ speedup or a slowdown because of the synchronization costs of threads.
 
 The analytical models need to know the maximal TCP window size to take
 the TCP congestion mechanism into account. This is set to 20000 by
-default, but can be changed using the \b network/TCP_gamma item.
+default, but can be changed using the \b network/TCP-gamma item.
 
 On linux, this value can be retrieved using the following
 commands. Both give a set of values, and you should use the last one,
@@ -222,7 +247,7 @@ InfiniBand network behavior can be modeled through 3 parameters, as explained in
 These factors can be changed through the following option:
 
 \verbatim
-smpi/IB_penalty_factors:"βe;βs;γs"
+smpi/IB-penalty-factors:"βe;βs;γs"
 \endverbatim
 
 By default SMPI uses factors computed on the Stampede Supercomputer at TACC, with optimal
@@ -239,17 +264,18 @@ phenomena such as ack compression.
 
 For that to work, your platform must have two links for each
 pair of interconnected hosts. An example of usable platform is
-available in <tt>examples/msg/gtnets/crosstraffic-p.xml</tt>.
+available in <tt>examples/platforms/crosstraffic.xml</tt>.
 
 This is activated through the \b network/crosstraffic item, that
 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.
+Note that with the default host model this option is activated by default.
 
 \subsubsection options_model_network_coord Coordinated-based network models
 
 When you want to use network coordinates, as it happens when you use
-an \<AS\> in your platform file with \c Vivaldi as a routing, you must
+an \<AS\> in your platform file with \c Vivaldi as a routing (see also
+Section \ref pf_routing_model_vivaldi "Vivaldi Routing Model"), you must
 set the \b network/coordinates to \c yes so that all mandatory
 initialization are done in the simulator.
 
@@ -258,7 +284,7 @@ initialization are done in the simulator.
 (this configuration item is experimental and may change or disapear)
 
 It is possible to specify a timing gap between consecutive emission on
-the same network card through the \b network/sender_gap item. This
+the same network card through the \b network/sender-gap item. This
 is still under investigation as of writting, and the default value is
 to wait 10 microseconds (1e-5 seconds) between emissions.
 
@@ -269,7 +295,7 @@ to wait 10 microseconds (1e-5 seconds) between emissions.
 It is possible to specify that messages below a certain size will be sent
 as soon as the call to MPI_Send is issued, without waiting for the
 correspondant receive. This threshold can be configured through the
-\b smpi/async_small_thres item. The default value is 0. This behavior can also be
+\b smpi/async-small-thresh item. The default value is 0. This behavior can also be
 manually set for MSG mailboxes, by setting the receiving mode of the mailbox
 with a call to \ref MSG_mailbox_set_async . For MSG, all messages sent to this
 mailbox will have this behavior, so consider using two mailboxes if needed.
@@ -292,19 +318,12 @@ corresponding to the ns3::TcpL4Protocol::SocketType configuration item
 in NS3. The only valid values (enforced on the SimGrid side) are
 'NewReno' or 'Reno' or 'Tahoe'.
 
-When using GTNeTS, two items exist:
- - \b gtnets/jitter, that is a double value to oscillate
-   the link latency, uniformly in random interval
-   [-latency*gtnets_jitter,latency*gtnets_jitter). It defaults to 0.
- - \b gtnets/jitter_seed, the positive seed used to reproduce jitted
-   results. Its value must be in [1,1e8] and defaults to 10.
-
 \section options_modelchecking Configuring the Model-Checking
 
-To enable the experimental SimGrid model-checking support the program should
-be executed with the command line argument
+To enable the SimGrid model-checking support the program should
+be executed using the simgrid-mc wrapper:
 \verbatim
---cfg=model-check:1
+simgrid-mc ./my_program
 \endverbatim
 
 Safety properties are expressed as assertions using the function
@@ -323,10 +342,6 @@ ltl2ba program.
 --cfg=model-check/property:<filename>
 \endverbatim
 
-Of course, specifying a liveness property enables the model-checking
-so that you don't have to give <tt>--cfg=model-check:1</tt> in
-addition.
-
 \subsection options_modelchecking_steps Going for stateful verification
 
 By default, the system is backtracked to its initial state to explore
@@ -344,9 +359,6 @@ setting for your specific system.
 --cfg=model-check/checkpoint:1
 \endverbatim
 
-Of course, specifying this option enables the model-checking so that
-you don't have to give <tt>--cfg=model-check:1</tt> in addition.
-
 \subsection options_modelchecking_reduction Specifying the kind of reduction
 
 The main issue when using the model-checking is the state space
@@ -367,10 +379,6 @@ For now, this configuration variable can take 2 values:
  * dpor: Apply Dynamic Partial Ordering Reduction. Only valid if you
    verify local safety properties.
 
-Of course, specifying a reduction technique enables the model-checking
-so that you don't have to give <tt>--cfg=model-check:1</tt> in
-addition.
-
 \subsection options_modelchecking_visited model-check/visited, Cycle detection
 
 In order to detect cycles, the model-checker needs to check if a new explored
@@ -384,7 +392,7 @@ be removed from the memory and some cycles might be missed.
 
 By default, no state is snapshotted and cycles cannot be detected.
 
-\subsection options_modelchecking_termination, model-check/termination, Non termination detection
+\subsection options_modelchecking_termination model-check/termination, Non termination detection
 
 The \b model-check/termination configuration item can be used to report if a
 non-termination execution path has been found. This is a path with a cycle
@@ -394,9 +402,9 @@ This only works in safety mode.
 
 This options is disabled by default.
 
-\subsection options_modelchecking_dot_output model-check/dot_output, Dot output
+\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
+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
@@ -404,7 +412,7 @@ 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
+The \b model-checker/max-depth can set the maximum depth of the exploration
 graph of the model-checker. If this limit is reached, a logging message is
 sent and the results might not be exact.
 
@@ -418,8 +426,8 @@ set to \b yes, the model-checker will explore timeouts of `wait` operations.
 
 \subsection options_modelchecking_comm_determinism Communication determinism
 
-The \b model-check/communications_determinism and
-\b model-check/send_determinism items can be used to select the communication
+The \b model-check/communications-determinism and
+\b model-check/send-determinism items can be used to select the communication
 determinism mode of the model-checker which checks determinism properties of
 the communications of an application.
 
@@ -527,8 +535,8 @@ phase.
 
 \subsection options_virt_factory Selecting the virtualization factory
 
-In SimGrid, the user code is virtualized in a specific mecanism
-allowing the simulation kernel to control its execution: when a user
+In SimGrid, the user code is virtualized in a specific mechanism
+that allows the simulation kernel to control its execution: when a user
 process requires a blocking action (such as sending a message), it is
 interrupted, and only gets released when the simulated clock reaches
 the point where the blocking operation is done.
@@ -545,9 +553,13 @@ to the most effient:
    pthreads or windows native threads)
  - \b ucontext: fast factory using System V contexts (or a portability
    layer of our own on top of Windows fibers)
- - \b raw: amazingly fast factory using a context switching mecanism
+ - \b raw: amazingly fast factory using a context switching mechanism
    of our own, directly implemented in assembly (only available for x86
    and amd64 platforms for now)
+ - \b boost: This uses the [context implementation](http://www.boost.org/doc/libs/1_59_0/libs/context/doc/html/index.html)
+             of the boost library; you must have this library installed before
+             you compile SimGrid. (On Debian GNU/Linux based systems, this is
+             provided by the libboost-contexts-dev package.)
 
 The only reason to change this setting is when the debugging tools get
 fooled by the optimized context factories. Threads are the most
@@ -565,7 +577,7 @@ rather disturbing: this leads to stack overflow (overwriting other
 stacks), leading to segfaults with corrupted stack traces.
 
 If you want to push the scalability limits of your code, you might
-want to reduce the \b contexts/stack_size item. Its default value
+want to reduce the \b contexts/stack-size item. Its default value
 is 8192 (in KiB), while our Chord simulation works with stacks as small
 as 16 KiB, for example. For the thread factory, the default value
 is the one of the system, if it is too large/small, it has to be set
@@ -600,7 +612,7 @@ 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
 associated synchronization costs) only if the potential parallelism is
-large enough. For that, set the \b contexts/parallel_threshold
+large enough. For that, set the \b contexts/parallel-threshold
 item to the minimal amount of user contexts needed to start the
 parallel execution. In any given simulation round, if that amount is
 not reached, the contexts will be run sequentially directly by the
@@ -671,13 +683,28 @@ reproduce an experiment. You have two ways to do that:
 
 - Add the contents of a textual file on top of the trace file as comment:
 \verbatim
---cfg=tracing/comment_file:my_file_with_additional_information.txt
+--cfg=tracing/comment-file:my_file_with_additional_information.txt
 \endverbatim
 
 Please, use these two parameters (for comments) to make reproducible
 simulations. For additional details about this and all tracing
 options, check See the \ref tracing_tracing_options.
 
+\section options_msg Configuring MSG
+
+\subsection options_msg_debug_multiple_use Debugging MSG
+
+Sometimes your application may try to send a task that is still being
+executed somewhere else, making it impossible to send this task. However,
+for debugging purposes, one may want to know what the other host is/was
+doing. This option shows a backtrace of the other process.
+
+Enable this option by adding
+
+\verbatim
+--cfg=msg/debug-multiple-use:on
+\endverbatim
+
 \section options_smpi Configuring SMPI
 
 The SMPI interface provides several specific configuration items.
@@ -693,21 +720,21 @@ say that if you have a large computation between a \c MPI_Recv() and a
 code, and create an execution task within the simulator to take this
 into account. For that, the actual duration is measured on the host
 machine and then scaled to the power of the corresponding simulated
-machine. The variable \b smpi/running_power allows to specify the
+machine. The variable \b smpi/running-power allows to specify the
 computational power of the host machine (in flop/s) to use when
 scaling the execution times. It defaults to 20000, but you really want
 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
+computations. The \b smpi/cpu-threshold item becomes handy when this
 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
+    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
@@ -725,10 +752,17 @@ being replayed/simulated. At the moment, these computation events can
 be simulated using SMPI by calling internal smpi_execute*() functions.
 
 To disable the benchmarking/simulation of computation in the simulated
-application, the variable \b
-smpi/simulation_computation should be set to no
+application, the variable \b smpi/simulate-computation should be set to no.
+Equivalently, setting \b smpi/cpu-threshold to -1 also ignores all
+computation.
+
+\note
+    This option just ignores the timings in your simulation; it still executes
+    the computations itself. If you want to stop SMPI from doing that,
+    you should check the SMPI_SAMPLE macros, documented in the chapter
+    \ref SMPI_adapting_speed.
 
-\subsection options_model_smpi_bw_factor smpi/bw_factor: Bandwidth factors
+\subsection options_model_smpi_bw_factor smpi/bw-factor: Bandwidth factors
 
 The possible throughput of network links is often dependent on the
 message sizes, as protocols may adapt to different message sizes. With
@@ -744,25 +778,31 @@ So, messages with size 65472 and more will get a total of MAX_BANDWIDTH*0.940694
 messages of size 15424 to 65471 will get MAX_BANDWIDTH*0.697866 and so on.
 Here, MAX_BANDWIDTH denotes the bandwidth of the link.
 
-\subsection options_smpi_timing smpi/display_timing: Reporting simulation time
+\note
+    The SimGrid-Team has developed a script to help you determine these
+    values. You can find more information and the download here:
+    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_timing smpi/display-timing: Reporting simulation time
 
 \b Default: 0 (false)
 
-Most of the time, you run MPI code through SMPI to compute the time it
-would take to run it on a platform that you don't have. But since the
+Most of the time, you run MPI code with SMPI to compute the time it
+would take to run it on a platform. But since the
 code is run through the \c smpirun script, you don't have any control
-on the launcher code, making difficult to report the simulated time
-when the simulation ends. If you set the \b smpi/display_timing item
+on the launcher code, making it difficult to report the simulated time
+when the simulation ends. If you set the \b smpi/display-timing item
 to 1, \c smpirun will display this information when the simulation ends. \verbatim
 Simulation time: 1e3 seconds.
 \endverbatim
 
-\subsection options_model_smpi_lat_factor smpi/lat_factor: Latency factors
+\subsection options_model_smpi_lat_factor smpi/lat-factor: Latency factors
 
 The motivation and syntax for this option is identical to the motivation/syntax
-of smpi/bw_factor, see \ref options_model_smpi_bw_factor for details.
+of smpi/bw-factor, see \ref options_model_smpi_bw_factor for details.
 
-There is an important difference, though: While smpi/bw_factor \a reduces the
+There is an important difference, though: While smpi/bw-factor \a reduces the
 actual bandwidth (i.e., values between 0 and 1 are valid), latency factors
 increase the latency, i.e., values larger than or equal to 1 are valid here.
 
@@ -772,7 +812,13 @@ This is the default value:
 65472:11.6436;15424:3.48845;9376:2.59299;5776:2.18796;3484:1.88101;1426:1.61075;732:1.9503;257:1.95341;0:2.01467
 \endverbatim
 
-\subsection options_smpi_global smpi/privatize_global_variables: Automatic privatization of global variables
+\note
+    The SimGrid-Team has developed a script to help you determine these
+    values. You can find more information and the download here:
+    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_global smpi/privatize-global-variables: Automatic privatization of global variables
 
 MPI executables are meant to be executed in separated processes, but SMPI is
 executed in only one process. Global variables from executables will be placed
@@ -798,7 +844,7 @@ To avoid this, several options are possible :
   linking is advised (but not with the simgrid library, to avoid replicating
   its own global variables).
 
-  To use this runtime automatic switching, the variable \b smpi/privatize_global_variables
+  To use this runtime automatic switching, the variable \b smpi/privatize-global-variables
   should be set to yes
 
 
@@ -809,12 +855,12 @@ 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 item. The default value is 65536.
 
 \subsection options_model_smpi_collectives Simulating MPI collective algorithms
 
 SMPI implements more than 100 different algorithms for MPI collective communication, to accurately
-simulate the behavior of most of the existing MPI libraries. The \b smpi/coll_selector item can be used
+simulate the behavior of most of the existing MPI libraries. The \b smpi/coll-selector item can be used
  to use the decision logic of either OpenMPI or MPICH libraries (values: ompi or mpich, by default SMPI
 uses naive version of collective operations). Each collective operation can be manually selected with a
 \b smpi/collective_name:algo_name. Available algorithms are listed in \ref SMPI_collective_algorithms .
@@ -826,6 +872,63 @@ 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_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.
+Of course, \a smpi/ois is used to account for MPI_Isend instead of MPI_Send.
+
+\subsection options_model_smpi_os smpi/os: Inject constant times for send operations
+
+In several network models such as LogP, send (MPI_Send, MPI_Isend) and receive (MPI_Recv)
+operations incur costs (i.e., they consume CPU time). SMPI can factor these costs in as well, but the
+user has to configure SMPI accordingly as these values may vary by machine.
+This can be done by using smpi/os for MPI_Send operations; for MPI_Isend and
+MPI_Recv, use \a smpi/ois and \a smpi/or, respectively. These work exactly as
+\a smpi/ois.
+
+\a smpi/os can consist of multiple sections; each section takes three values, for example:
+
+\verbatim
+    1:3:2;10:5:1
+\endverbatim
+
+Here, the sections are divided by ";" (that is, this example contains two sections).
+Furthermore, each section consists of three values.
+
+1. The first value denotes the minimum size for this section to take effect;
+   read it as "if message size is greater than this value (and other section has a larger
+   first value that is also smaller than the message size), use this".
+   In the first section above, this value is "1".
+
+2. The second value is the startup time; this is a constant value that will always
+   be charged, no matter what the size of the message. In the first section above,
+   this value is "3".
+
+3. The third value is the \a per-byte cost. That is, it is charged for every
+   byte of the message (incurring cost messageSize*cost_per_byte)
+   and hence accounts also for larger messages. In the first
+   section of the example above, this value is "2".
+
+Now, SMPI always checks which section it should take for a given message; that is,
+if a message of size 11 is sent with the configuration of the example above, only
+the second section will be used, not the first, as the first value of the second
+section is closer to the message size. Hence, a message of size 11 incurs the
+following cost inside MPI_Send:
+
+\verbatim
+    5+11*1
+\endverbatim
+
+%As 5 is the startup cost and 1 is the cost per byte.
+
+\note
+    The order of sections can be arbitrary; they will be ordered internally.
+
+\subsection options_model_smpi_or smpi/or: Inject constant times for receive operations
+
+This configuration option works exactly as \a smpi/os, see Section \ref options_model_smpi_os.
+Of course, \a smpi/or is used to account for MPI_Recv instead of MPI_Send.
+
 \subsection options_model_smpi_test smpi/test: Inject constant times for calls to MPI_Test
 
 \b Default value: 0.0001
@@ -852,6 +955,15 @@ Here is an example:
     to sleep increases linearly with the number of previously failed testk.
 
 
+\subsection options_model_smpi_use_shared_malloc smpi/use-shared-malloc: Factorize malloc()s
+
+\b Default: 1
+
+SMPI can use shared memory by calling shm_* functions; this might speed up the simulation.
+This opens or creates a new POSIX shared memory object, kept in RAM, in /dev/shm.
+
+If you want to disable this behavior, set the value to 0.
+
 \subsection options_model_smpi_wtime smpi/wtime: Inject constant times for calls to MPI_Wtime
 
 \b Default value: 0
@@ -882,7 +994,7 @@ option to force a call to MPI_Wtime to advance the time as well.
 The C / C++ standard contains a function called \b [atexit](http://www.cplusplus.com/reference/cstdlib/atexit/).
 atexit registers callbacks, which are called just before the program terminates.
 
-By setting the configuration option clean_atexit to 1 (true), a callback
+By setting the configuration option clean-atexit to 1 (true), a callback
 is registered and will clean up some variables and terminate/cleanup the tracing.
 
 TODO: Add when this should be used.
@@ -931,9 +1043,9 @@ tasks. If it is not possible you might use ucontext instead.
 A stack guard page is usually used which prevents the stack from
 overflowing on other parts of the memory. However this might have a
 performance impact if a huge number of processes is created.  The
-option \b contexts:guard_size is the number of stack guard pages
+option \b contexts:guard-size is the number of stack guard pages
 used. By setting it to 0, no guard pages will be used: in this case,
-you should avoid using small stacks (\b stack_size) as the stack will
+you should avoid using small stacks (\b stack-size) as the stack will
 silently overflow on other parts of the memory.
 
 \section options_index Index of all existing configuration options
@@ -944,105 +1056,93 @@ silently overflow on other parts of the memory.
   for the moment (May 2015).
 
 \note
-  \b Please \b note: You can also pass the command-line option "\b --help" and
+  \b Please \b note: You can also pass the command-line option "--help" and
      "--help-cfg" to an executable that uses simgrid.
 
-- \c clean_atexit: \ref options_generic_clean_atexit
+- \c clean-atexit: \ref options_generic_clean_atexit
 
 - \c contexts/factory: \ref options_virt_factory
-- \c contexts/guard_size: \ref options_virt_parallel
+- \c contexts/guard-size: \ref options_virt_parallel
 - \c contexts/nthreads: \ref options_virt_parallel
 - \c contexts/parallel_threshold: \ref options_virt_parallel
-- \c contexts/stack_size: \ref options_virt_stacksize
+- \c contexts/stack-size: \ref options_virt_stacksize
 - \c contexts/synchro: \ref options_virt_parallel
 
-- \c cpu/maxmin_selective_update: \ref options_model_optim
+- \c cpu/maxmin-selective-update: \ref options_model_optim
 - \c cpu/model: \ref options_model_select
 - \c cpu/optim: \ref options_model_optim
 
 - \c exception/cutpath: \ref options_exception_cutpath
 
-- \c gtnets/jitter: \ref options_pls
-- \c gtnets/jitter_seed: \ref options_pls
+- \c host/model: \ref options_model_select
 
 - \c maxmin/precision: \ref options_model_precision
 
-- \c msg/debug_multiple_use: \ref options_msg_debug_multiple_use
+- \c msg/debug-multiple-use: \ref options_msg_debug_multiple_use
 
 - \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/send_determinism: \ref options_modelchecking_comm_determinism
-- \c model-check/dot_output: \ref options_modelchecking_dot_output
+- \c model-check/communications-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
-- \c model-check/max_depth: \ref options_modelchecking_max_depth
+- \c model-check/max-depth: \ref options_modelchecking_max_depth
 - \c model-check/record: \ref options_modelchecking_recordreplay
 - \c model-check/reduction: \ref options_modelchecking_reduction
 - \c model-check/replay: \ref options_modelchecking_recordreplay
-- \c model-check/send_determinism: \ref options_modelchecking_sparse_checkpoint
+- \c model-check/send-determinism: \ref options_modelchecking_comm_determinism
 - \c model-check/sparse-checkpoint: \ref options_modelchecking_sparse_checkpoint
 - \c model-check/termination: \ref options_modelchecking_termination
 - \c model-check/timeout: \ref options_modelchecking_timeout
 - \c model-check/visited: \ref options_modelchecking_visited
 
-- \c network/bandwidth_factor: \ref options_model_network_coefs
+- \c network/bandwidth-factor: \ref options_model_network_coefs
 - \c network/coordinates: \ref options_model_network_coord
 - \c network/crosstraffic: \ref options_model_network_crosstraffic
-- \c network/latency_factor: \ref options_model_network_coefs
-- \c network/maxmin_selective_update: \ref options_model_optim
+- \c network/latency-factor: \ref options_model_network_coefs
+- \c network/maxmin-selective-update: \ref options_model_optim
 - \c network/model: \ref options_model_select
 - \c network/optim: \ref options_model_optim
 - \c network/sender_gap: \ref options_model_network_sendergap
-- \c network/TCP_gamma: \ref options_model_network_gamma
-- \c network/weight_S: \ref options_model_network_coefs
+- \c network/TCP-gamma: \ref options_model_network_gamma
+- \c network/weight-S: \ref options_model_network_coefs
 
 - \c ns3/TcpModel: \ref options_pls
+- \c path: \ref options_generic_path
+- \c plugin: \ref options_generic_plugin
 
 - \c surf/nthreads: \ref options_model_nthreads
 - \c surf/precision: \ref options_model_precision
 
 - \c <b>For collective operations of SMPI, please refer to Section \ref options_index_smpi_coll</b>
-- \c smpi/async_small_thres: \ref options_model_network_asyncsend
-- \c smpi/bw_factor: \ref options_model_smpi_bw_factor
-- \c smpi/coll_selector: \ref options_model_smpi_collectives
-- \c smpi/cpu_threshold: \ref options_smpi_bench
-- \c smpi/display_timing: \ref options_smpi_timing
-- \c smpi/lat_factor: \ref options_model_smpi_lat_factor
-- \c smpi/IB_penalty_factors: \ref options_model_network_coefs
+- \c smpi/async-small-thresh: \ref options_model_network_asyncsend
+- \c smpi/bw-factor: \ref options_model_smpi_bw_factor
+- \c smpi/coll-selector: \ref options_model_smpi_collectives
+- \c smpi/cpu-threshold: \ref options_smpi_bench
+- \c smpi/display-timing: \ref options_smpi_timing
+- \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/ois: \ref options_model_smpi_ois
 - \c smpi/or: \ref options_model_smpi_or
 - \c smpi/os: \ref options_model_smpi_os
-- \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
-- \c smpi/simulation_computation: \ref options_smpi_bench
+- \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
+- \c smpi/simulate-computation: \ref options_smpi_bench
 - \c smpi/test: \ref options_model_smpi_test
-- \c smpi/use_shared_malloc: \ref options_model_smpi_use_shared_malloc
+- \c smpi/use-shared-malloc: \ref options_model_smpi_use_shared_malloc
 - \c smpi/wtime: \ref options_model_smpi_wtime
 
 - \c <b>Tracing configuration options can be found in Section \ref tracing_tracing_options</b>.
 
 - \c storage/model: \ref options_storage_model
-- \c path: \ref options_generic_path
-- \c plugin: \ref options_generic_plugin
 - \c verbose-exit: \ref options_generic_exit
 
-- \c vm_workstation/model: \ref options_vm_workstation_model
-- \c workstation/model: \ref options_model_select
+- \c vm/model: \ref options_vm_model
 
 \subsection options_index_smpi_coll Index of SMPI collective algorithms options
-- \c smpi/allgather: \ref options_model_smpi_coll_allgather
-- \c smpi/allgatherv: \ref options_model_smpi_coll_allgatherv
-- \c smpi/allreduce: \ref options_model_smpi_coll_allreduce
-- \c smpi/alltoall: \ref options_model_smpi_coll_alltoall
-- \c smpi/alltoallv: \ref options_model_smpi_coll_alltoallv
-- \c smpi/barrier: \ref options_model_smpi_coll_barrier
-- \c smpi/bcast: \ref options_model_smpi_coll_bcast
-- \c smpi/gather: \ref options_model_smpi_coll_gather
-- \c smpi/reduce: \ref options_model_smpi_coll_reduce
-- \c smpi/reduce_scatter: \ref options_model_smpi_coll_reduce_scatter
-- \c smpi/scatter: \ref options_model_smpi_coll_scatter
+
+TODO: All available collective algorithms will be made available via the ``smpirun --help-coll`` command.
 
 */