Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / doc / doxygen / options.doc
index 89af676..9f675d7 100644 (file)
@@ -1,4 +1,4 @@
-/*! \page options Simgrid options and configurations
+/*! \page options Step 2: 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.
@@ -92,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
@@ -252,7 +254,7 @@ deployment of processes on nodes.
 
 \subsubsection options_model_network_crosstraffic Simulating cross-traffic
 
-As of SimGrid v3.7, cross-traffic effects can be taken into account in
+%As of SimGrid v3.7, cross-traffic effects can be taken into account in
 analytical simulations. It means that ongoing and incoming
 communication flows are treated independently. In addition, the LV08
 model adds 0.05 of usage on the opposite direction for each new
@@ -271,7 +273,8 @@ 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.
 
@@ -531,8 +534,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.
@@ -552,6 +555,10 @@ to the most effient:
  - \b raw: amazingly fast factory using a context switching mecanism
    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
@@ -745,7 +752,7 @@ 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
+smpi/simulate_computation should be set to no
 
 \subsection options_model_smpi_bw_factor smpi/bw_factor: Bandwidth factors
 
@@ -773,10 +780,10 @@ Here, MAX_BANDWIDTH denotes the bandwidth of the link.
 
 \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
+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.
@@ -1115,7 +1122,7 @@ silently overflow on other parts of the memory.
 - \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/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/wtime: \ref options_model_smpi_wtime