Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
5fc516da3fbdb5a92ce05a5854cd75151714b01b
[simgrid.git] / doc / doxygen / options.doc
1 /*! \page options Configure SimGrid
2
3 A number of options can be given at runtime to change the default
4 SimGrid behavior. For a complete list of all configuration options
5 accepted by the SimGrid version used in your simulator, simply pass
6 the --help configuration flag to your program. If some of the options
7 are not documented on this page, this is a bug that you should please
8 report so that we can fix it. Note that some of the options presented
9 here may not be available in your simulators, depending on the
10 @ref install_src_config "compile-time options" that you used.
11
12 \tableofcontents
13
14 \section options_using Passing configuration options to the simulators
15
16 There is several way to pass configuration options to the simulators.
17 The most common way is to use the \c --cfg command line argument. For
18 example, to set the item \c Item to the value \c Value, simply
19 type the following: \verbatim
20 my_simulator --cfg=Item:Value (other arguments)
21 \endverbatim
22
23 Several \c `--cfg` command line arguments can naturally be used. If you
24 need to include spaces in the argument, don't forget to quote the
25 argument. You can even escape the included quotes (write \' for ' if
26 you have your argument between ').
27
28 Another solution is to use the \c \<config\> tag in the platform file. The
29 only restriction is that this tag must occure before the first
30 platform element (be it \c \<AS\>, \c \<cluster\>, \c \<peer\> or whatever).
31 The \c \<config\> tag takes an \c id attribute, but it is currently
32 ignored so you don't really need to pass it. The important par is that
33 within that tag, you can pass one or several \c \<prop\> tags to specify
34 the configuration to use. For example, setting \c Item to \c Value
35 can be done by adding the following to the beginning of your platform
36 file:
37 \verbatim
38 <config>
39   <prop id="Item" value="Value"/>
40 </config>
41 \endverbatim
42
43 A last solution is to pass your configuration directly using the C
44 interface. If you happen to use the MSG interface, this is very easy
45 with the MSG_config() function. If you do not use MSG, that's a bit
46 more complex, as you have to mess with the internal configuration set
47 directly as follows. Check the \ref XBT_config "relevant page" for
48 details on all the functions you can use in this context, \c
49 _sg_cfg_set being the only configuration set currently used in
50 SimGrid.
51
52 @code
53 #include <xbt/config.h>
54
55 extern xbt_cfg_t _sg_cfg_set;
56
57 int main(int argc, char *argv[]) {
58      SD_init(&argc, argv);
59
60      /* Prefer MSG_config() if you use MSG!! */
61      xbt_cfg_set_parse(_sg_cfg_set,"Item:Value");
62
63      // Rest of your code
64 }
65 @endcode
66
67 \section options_model Configuring the platform models
68
69 \anchor options_storage_model
70 \anchor options_vm_model
71 \subsection options_model_select Selecting the platform models
72
73 SimGrid comes with several network, CPU and storage models built in, and you
74 can change the used model at runtime by changing the passed
75 configuration. The three main configuration items are given below.
76 For each of these items, passing the special \c help value gives
77 you a short description of all possible values. Also, \c --help-models
78 should provide information about all models for all existing resources.
79    - \b network/model: specify the used network model
80    - \b cpu/model: specify the used CPU model
81    - \b host/model: specify the used host model
82    - \b storage/model: specify the used storage model (there is currently only one such model - this option is hence only useful for future releases)
83    - \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)
84
85 As of writing, the following network models are accepted. Over
86 the time new models can be added, and some experimental models can be
87 removed; check the values on your simulators for an uptodate
88 information. Note that the CM02 model is described in the research report
89 <a href="ftp://ftp.ens-lyon.fr/pub/LIP/Rapports/RR/RR2002/RR2002-40.ps.gz">A
90 Network Model for Simulation of Grid Application</a> while LV08 is
91 described in
92 <a href="http://mescal.imag.fr/membres/arnaud.legrand/articles/simutools09.pdf">Accuracy Study and Improvement of Network Simulation in the SimGrid Framework</a>.
93
94   - \b LV08 (default one): Realistic network analytic model
95     (slow-start modeled by multiplying latency by 10.4, bandwidth by
96     .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT)
97   - \anchor options_model_select_network_constant \b Constant: Simplistic network model where all communication
98     take a constant time (one second). This model provides the lowest
99     realism, but is (marginally) faster.
100   - \b SMPI: Realistic network model specifically tailored for HPC
101     settings (accurate modeling of slow start with correction factors on
102     three intervals: < 1KiB, < 64 KiB, >= 64 KiB). See also \ref
103     options_model_network_coefs "this section" for more info.
104   - \b IB: Realistic network model specifically tailored for HPC
105     settings with InfiniBand networks (accurate modeling contention
106     behavior, based on the model explained in
107     http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf).
108     See also \ref options_model_network_coefs "this section" for more info.
109   - \b CM02: Legacy network analytic model (Very similar to LV08, but
110     without corrective factors. The timings of small messages are thus
111     poorly modeled)
112   - \b Reno: Model from Steven H. Low using lagrange_solve instead of
113     lmm_solve (experts only; check the code for more info).
114   - \b Reno2: Model from Steven H. Low using lagrange_solve instead of
115     lmm_solve (experts only; check the code for more info).
116   - \b Vegas: Model from Steven H. Low using lagrange_solve instead of
117     lmm_solve (experts only; check the code for more info).
118
119 If you compiled SimGrid accordingly, you can use packet-level network
120 simulators as network models (see \ref pls_ns3). In that case, you have
121 two extra models, described below, and some \ref options_pls "specific
122 additional configuration flags".
123   - \b NS3: Network pseudo-model using the NS3 tcp model
124
125 Concerning the CPU, we have only one model for now:
126   - \b Cas01: Simplistic CPU model (time=size/power)
127
128 The host concept is the aggregation of a CPU with a network
129 card. Three models exists, but actually, only 2 of them are
130 interesting. The "compound" one is simply due to the way our internal
131 code is organized, and can easily be ignored. So at the end, you have
132 two host models: The default one allows to aggregate an
133 existing CPU model with an existing network model, but does not allow
134 parallel tasks because these beasts need some collaboration between
135 the network and CPU model. That is why, ptask_07 is used by default
136 when using SimDag.
137   - \b default: Default host model. Currently, CPU:Cas01 and
138     network:LV08 (with cross traffic enabled)
139   - \b compound: Host model that is automatically chosen if
140     you change the network and CPU models
141   - \b ptask_L07: Host model somehow similar to Cas01+CM02 but
142     allowing "parallel tasks", that are intended to model the moldable
143     tasks of the grid scheduling literature.
144
145 \subsection options_generic_plugin Plugins
146
147 SimGrid supports the use of plugins; currently, no known plugins
148 can be activated but there are use-cases where you may want to write
149 your own plugin (for instance, for logging).
150
151 Plugins can for instance define own classes that inherit from
152 existing classes (for instance, a class "CpuEnergy" inherits from
153 "Cpu" to assess energy consumption).
154
155 The plugin connects to the code by registering callbacks using
156 ``signal.connect(callback)`` (see file ``src/surf/plugins/energy.cpp`` for
157 details).
158
159 \verbatim
160     --cfg=plugin:Energy
161 \endverbatim
162
163 \note
164     This option is case-sensitive: Energy and energy are not the same!
165
166 \subsection options_model_optim Optimization level of the platform models
167
168 The network and CPU models that are based on lmm_solve (that
169 is, all our analytical models) accept specific optimization
170 configurations.
171   - items \b network/optim and \b cpu/optim (both default to 'Lazy'):
172     - \b Lazy: Lazy action management (partial invalidation in lmm +
173       heap in action remaining).
174     - \b TI: Trace integration. Highly optimized mode when using
175       availability traces (only available for the Cas01 CPU model for
176       now).
177     - \b Full: Full update of remaining and variables. Slow but may be
178       useful when debugging.
179   - items \b network/maxmin-selective-update and
180     \b cpu/maxmin-selective-update: configure whether the underlying
181     should be lazily updated or not. It should have no impact on the
182     computed timings, but should speed up the computation.
183
184 It is still possible to disable the \c maxmin-selective-update feature
185 because it can reveal counter-productive in very specific scenarios
186 where the interaction level is high. In particular, if all your
187 communication share a given backbone link, you should disable it:
188 without \c maxmin-selective-update, every communications are updated
189 at each step through a simple loop over them. With that feature
190 enabled, every communications will still get updated in this case
191 (because of the dependency induced by the backbone), but through a
192 complicated pattern aiming at following the actual dependencies.
193
194 \subsection options_model_precision Numerical precision of the platform models
195
196 The analytical models handle a lot of floating point values. It is
197 possible to change the epsilon used to update and compare them through
198 the \b maxmin/precision item (default value: 0.00001). Changing it
199 may speedup the simulation by discarding very small actions, at the
200 price of a reduced numerical precision.
201
202 \subsection options_concurrency_limit Concurrency limit
203
204 The maximum number of variables per resource can be tuned through
205 the \b maxmin/concurrency_limit item (default value: -1, meaning no such limitation). 
206 Setting a higher value can lift some limitations, such as the number of 
207 concurrent processes running on a single host.
208
209 \subsection options_model_network Configuring the Network model
210
211 \subsubsection options_model_network_gamma Maximal TCP window size
212
213 The analytical models need to know the maximal TCP window size to take
214 the TCP congestion mechanism into account. This is set to 20000 by
215 default, but can be changed using the \b network/TCP-gamma item.
216
217 On linux, this value can be retrieved using the following
218 commands. Both give a set of values, and you should use the last one,
219 which is the maximal size.\verbatim
220 cat /proc/sys/net/ipv4/tcp_rmem # gives the sender window
221 cat /proc/sys/net/ipv4/tcp_wmem # gives the receiver window
222 \endverbatim
223
224 \subsubsection options_model_network_coefs Correcting important network parameters
225
226 SimGrid can take network irregularities such as a slow startup or
227 changing behavior depending on the message size into account.
228 You should not change these values unless you really know what you're doing.
229
230 The corresponding values were computed through data fitting one the
231 timings of packet-level simulators.
232
233 See
234 <a href="http://mescal.imag.fr/membres/arnaud.legrand/articles/simutools09.pdf">Accuracy Study and Improvement of Network Simulation in the SimGrid Framework</a>
235 for more information about these parameters.
236
237 If you are using the SMPI model, these correction coefficients are
238 themselves corrected by constant values depending on the size of the
239 exchange. Again, only hardcore experts should bother about this fact.
240
241 InfiniBand network behavior can be modeled through 3 parameters, as explained in
242 <a href="http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf">this PhD thesis</a>.
243 These factors can be changed through the following option:
244
245 \verbatim
246 smpi/IB-penalty-factors:"βe;βs;γs"
247 \endverbatim
248
249 By default SMPI uses factors computed on the Stampede Supercomputer at TACC, with optimal
250 deployment of processes on nodes.
251
252 \subsubsection options_model_network_crosstraffic Simulating cross-traffic
253
254 As of SimGrid v3.7, cross-traffic effects can be taken into account in
255 analytical simulations. It means that ongoing and incoming
256 communication flows are treated independently. In addition, the LV08
257 model adds 0.05 of usage on the opposite direction for each new
258 created flow. This can be useful to simulate some important TCP
259 phenomena such as ack compression.
260
261 For that to work, your platform must have two links for each
262 pair of interconnected hosts. An example of usable platform is
263 available in <tt>examples/platforms/crosstraffic.xml</tt>.
264
265 This is activated through the \b network/crosstraffic item, that
266 can be set to 0 (disable this feature) or 1 (enable it).
267
268 Note that with the default host model this option is activated by default.
269
270 \subsubsection options_model_network_sendergap Simulating sender gap
271
272 (this configuration item is experimental and may change or disapear)
273
274 It is possible to specify a timing gap between consecutive emission on
275 the same network card through the \b network/sender-gap item. This
276 is still under investigation as of writting, and the default value is
277 to wait 10 microseconds (1e-5 seconds) between emissions.
278
279 \subsubsection options_model_network_asyncsend Simulating asyncronous send
280
281 (this configuration item is experimental and may change or disapear)
282
283 It is possible to specify that messages below a certain size will be sent
284 as soon as the call to MPI_Send is issued, without waiting for the
285 correspondant receive. This threshold can be configured through the
286 \b smpi/async-small-thresh item. The default value is 0. This behavior can also be
287 manually set for MSG mailboxes, by setting the receiving mode of the mailbox
288 with a call to \ref MSG_mailbox_set_async . For MSG, all messages sent to this
289 mailbox will have this behavior, so consider using two mailboxes if needed.
290
291 This value needs to be smaller than or equals to the threshold set at
292 \ref options_model_smpi_detached , because asynchronous messages are
293 meant to be detached as well.
294
295 \subsubsection options_pls Configuring packet-level pseudo-models
296
297 When using the packet-level pseudo-models, several specific
298 configuration flags are provided to configure the associated tools.
299 There is by far not enough such SimGrid flags to cover every aspects
300 of the associated tools, since we only added the items that we
301 needed ourselves. Feel free to request more items (or even better:
302 provide patches adding more items).
303
304 When using NS3, the only existing item is \b ns3/TcpModel,
305 corresponding to the ns3::TcpL4Protocol::SocketType configuration item
306 in NS3. The only valid values (enforced on the SimGrid side) are
307 'NewReno' or 'Reno' or 'Tahoe'.
308
309 \subsection options_model_storage Configuring the Storage model
310
311 \subsubsection option_model_storage_maxfd Maximum amount of file descriptors per host
312
313 Each host maintains a fixed-size array of its file descriptors. You
314 can change its size (1024 by default) through the \b
315 storage/max_file_descriptors item to either enlarge it if your
316 application requires it or to reduce it to save memory space.
317
318 \section options_modelchecking Configuring the Model-Checking
319
320 To enable the SimGrid model-checking support the program should
321 be executed using the simgrid-mc wrapper:
322 \verbatim
323 simgrid-mc ./my_program
324 \endverbatim
325
326 Safety properties are expressed as assertions using the function
327 \verbatim
328 void MC_assert(int prop);
329 \endverbatim
330
331 \subsection options_modelchecking_liveness Specifying a liveness property
332
333 If you want to specify liveness properties (beware, that's
334 experimental), you have to pass them on the command line, specifying
335 the name of the file containing the property, as formatted by the
336 ltl2ba program.
337
338 \verbatim
339 --cfg=model-check/property:<filename>
340 \endverbatim
341
342 \subsection options_modelchecking_steps Going for stateful verification
343
344 By default, the system is backtracked to its initial state to explore
345 another path instead of backtracking to the exact step before the fork
346 that we want to explore (this is called stateless verification). This
347 is done this way because saving intermediate states can rapidly
348 exhaust the available memory. If you want, you can change the value of
349 the <tt>model-check/checkpoint</tt> variable. For example, the
350 following configuration will ask to take a checkpoint every step.
351 Beware, this will certainly explode your memory. Larger values are
352 probably better, make sure to experiment a bit to find the right
353 setting for your specific system.
354
355 \verbatim
356 --cfg=model-check/checkpoint:1
357 \endverbatim
358
359 \subsection options_modelchecking_reduction Specifying the kind of reduction
360
361 The main issue when using the model-checking is the state space
362 explosion. To counter that problem, several exploration reduction
363 techniques can be used. There is unfortunately no silver bullet here,
364 and the most efficient reduction techniques cannot be applied to any
365 properties. In particular, the DPOR method cannot be applied on
366 liveness properties since it may break some cycles in the exploration
367 that are important to the property validity.
368
369 \verbatim
370 --cfg=model-check/reduction:<technique>
371 \endverbatim
372
373 For now, this configuration variable can take 2 values:
374  * none: Do not apply any kind of reduction (mandatory for now for
375    liveness properties)
376  * dpor: Apply Dynamic Partial Ordering Reduction. Only valid if you
377    verify local safety properties.
378
379 \subsection options_modelchecking_visited model-check/visited, Cycle detection
380
381 In order to detect cycles, the model-checker needs to check if a new explored
382 state is in fact the same state than a previous one. In order to do this,
383 the model-checker can take a snapshot of each visited state: this snapshot is
384 then used to compare it with subsequent states in the exploration graph.
385
386 The \b model-check/visited is the maximum number of states which are stored in
387 memory. If the maximum number of snapshotted state is reached some states will
388 be removed from the memory and some cycles might be missed.
389
390 By default, no state is snapshotted and cycles cannot be detected.
391
392 \subsection options_modelchecking_termination model-check/termination, Non termination detection
393
394 The \b model-check/termination configuration item can be used to report if a
395 non-termination execution path has been found. This is a path with a cycle
396 which means that the program might never terminate.
397
398 This only works in safety mode.
399
400 This options is disabled by default.
401
402 \subsection options_modelchecking_dot_output model-check/dot-output, Dot output
403
404 If set, the \b model-check/dot-output configuration item is the name of a file
405 in which to write a dot file of the path leading the found property (safety or
406 liveness violation) as well as the cycle for liveness properties. This dot file
407 can then fed to the graphviz dot tool to generate an corresponding graphical
408 representation.
409
410 \subsection options_modelchecking_max_depth model-check/max_depth, Depth limit
411
412 The \b model-checker/max-depth can set the maximum depth of the exploration
413 graph of the model-checker. If this limit is reached, a logging message is
414 sent and the results might not be exact.
415
416 By default, there is not depth limit.
417
418 \subsection options_modelchecking_timeout Handling of timeout
419
420 By default, the model-checker does not handle timeout conditions: the `wait`
421 operations never time out. With the \b model-check/timeout configuration item
422 set to \b yes, the model-checker will explore timeouts of `wait` operations.
423
424 \subsection options_modelchecking_comm_determinism Communication determinism
425
426 The \b model-check/communications-determinism and
427 \b model-check/send-determinism items can be used to select the communication
428 determinism mode of the model-checker which checks determinism properties of
429 the communications of an application.
430
431 \subsection options_modelchecking_sparse_checkpoint Per page checkpoints
432
433 When the model-checker is configured to take a snapshot of each explored state
434 (with the \b model-checker/visited item), the memory consumption can rapidly
435 reach GiB ou Tib of memory. However, for many workloads, the memory does not
436 change much between different snapshots and taking a complete copy of each
437 snapshot is a waste of memory.
438
439 The \b model-check/sparse-checkpoint option item can be set to \b yes in order
440 to avoid making a complete copy of each snapshot: instead, each snapshot will be
441 decomposed in blocks which will be stored separately.
442 If multiple snapshots share the same block (or if the same block
443 is used in the same snapshot), the same copy of the block will be shared leading
444 to a reduction of the memory footprint.
445
446 For many applications, this option considerably reduces the memory consumption.
447 In somes cases, the model-checker might be slightly slower because of the time
448 taken to manage the metadata about the blocks. In other cases however, this
449 snapshotting strategy will be much faster by reducing the cache consumption.
450 When the memory consumption is important, by avoiding to hit the swap or
451 reducing the swap usage, this option might be much faster than the basic
452 snapshotting strategy.
453
454 This option is currently disabled by default.
455
456 \subsection options_mc_perf Performance considerations for the model checker
457
458 The size of the stacks can have a huge impact on the memory
459 consumption when using model-checking. By default, each snapshot will
460 save a copy of the whole stacks and not only of the part which is
461 really meaningful: you should expect the contribution of the memory
462 consumption of the snapshots to be \f$ \mbox{number of processes}
463 \times \mbox{stack size} \times \mbox{number of states} \f$.
464
465 The \b model-check/sparse-checkpoint can be used to reduce the memory
466 consumption by trying to share memory between the different snapshots.
467
468 When compiled against the model checker, the stacks are not
469 protected with guards: if the stack size is too small for your
470 application, the stack will silently overflow on other parts of the
471 memory (see \ref options_virt_guard_size).
472
473 \subsection options_modelchecking_hash Hashing of the state (experimental)
474
475 Usually most of the time of the model-checker is spent comparing states. This
476 process is complicated and consumes a lot of bandwidth and cache.
477 In order to speedup the state comparison, the experimental \b model-checker/hash
478 configuration item enables the computation of a hash summarizing as much
479 information of the state as possible into a single value. This hash can be used
480 to avoid most of the comparisons: the costly comparison is then only used when
481 the hashes are identical.
482
483 Currently most of the state is not included in the hash because the
484 implementation was found to be buggy and this options is not as useful as
485 it could be. For this reason, it is currently disabled by default.
486
487 \subsection options_modelchecking_recordreplay Record/replay (experimental)
488
489 As the model-checker keeps jumping at different places in the execution graph,
490 it is difficult to understand what happens when trying to debug an application
491 under the model-checker. Event the output of the program is difficult to
492 interpret. Moreover, the model-checker does not behave nicely with advanced
493 debugging tools such as valgrind. For those reason, to identify a trajectory
494 in the execution graph with the model-checker and replay this trajcetory and
495 without the model-checker black-magic but with more standard tools
496 (such as a debugger, valgrind, etc.). For this reason, Simgrid implements an
497 experimental record/replay functionnality in order to record a trajectory with
498 the model-checker and replay it without the model-checker.
499
500 When the model-checker finds an interesting path in the application execution
501 graph (where a safety or liveness property is violated), it can generate an
502 identifier for this path. In order to enable this behavious the
503 \b model-check/record must be set to \b yes. By default, this behaviour is not
504 enabled.
505
506 This is an example of output:
507
508 <pre>
509 [  0.000000] (0:@) Check a safety property
510 [  0.000000] (0:@) **************************
511 [  0.000000] (0:@) *** PROPERTY NOT VALID ***
512 [  0.000000] (0:@) **************************
513 [  0.000000] (0:@) Counter-example execution trace:
514 [  0.000000] (0:@) Path = 1/3;1/4
515 [  0.000000] (0:@) [(1)Tremblay (app)] MC_RANDOM(3)
516 [  0.000000] (0:@) [(1)Tremblay (app)] MC_RANDOM(4)
517 [  0.000000] (0:@) Expanded states = 27
518 [  0.000000] (0:@) Visited states = 68
519 [  0.000000] (0:@) Executed transitions = 46
520 </pre>
521
522 This path can then be replayed outside of the model-checker (and even in
523 non-MC build of simgrid) by setting the \b model-check/replay item to the given
524 path. The other options should be the same (but the model-checker should
525 be disabled).
526
527 The format and meaning of the path may change between different releases so
528 the same release of Simgrid should be used for the record phase and the replay
529 phase.
530
531 \section options_virt Configuring the User Process Virtualization
532
533 \subsection options_virt_factory Selecting the virtualization factory
534
535 In SimGrid, the user code is virtualized in a specific mechanism
536 that allows the simulation kernel to control its execution: when a user
537 process requires a blocking action (such as sending a message), it is
538 interrupted, and only gets released when the simulated clock reaches
539 the point where the blocking operation is done.
540
541 In SimGrid, the containers in which user processes are virtualized are
542 called contexts. Several context factory are provided, and you can
543 select the one you want to use with the \b contexts/factory
544 configuration item. Some of the following may not exist on your
545 machine because of portability issues. In any case, the default one
546 should be the most effcient one (please report bugs if the
547 auto-detection fails for you). They are approximately sorted here from
548 the slowest to the most effient:
549
550  - \b thread: very slow factory using full featured threads (either
551    pthreads or windows native threads). They are slow but very
552    standard. Some debuggers or profilers only work with this factory.
553  - \b java: Java applications are virtualized onto java threads (that
554    are regular pthreads registered to the JVM)
555  - \b ucontext: fast factory using System V contexts (Linux and FreeBSD only)
556  - \b boost: This uses the [context implementation](http://www.boost.org/doc/libs/1_59_0/libs/context/doc/html/index.html)
557    of the boost library for a performance that is comparable to our
558    raw implementation.\nInstall the relevant library (e.g. with the
559    libboost-contexts-dev package on Debian/Ubuntu) and recompile
560    SimGrid. Note that our implementation is not compatible with recent
561    implementations of the library, and it will be hard to fix this since
562    the library's author decided to hide an API that we were using.
563  - \b raw: amazingly fast factory using a context switching mechanism
564    of our own, directly implemented in assembly (only available for x86
565    and amd64 platforms for now) and without any unneeded system call.
566
567 The main reason to change this setting is when the debugging tools get
568 fooled by the optimized context factories. Threads are the most
569 debugging-friendly contextes, as they allow to set breakpoints
570 anywhere with gdb and visualize backtraces for all processes, in order
571 to debug concurrency issues. Valgrind is also more comfortable with
572 threads, but it should be usable with all factories (but the callgrind
573 tool that really don't like raw and ucontext factories).
574
575 \subsection options_virt_stacksize Adapting the used stack size
576
577 Each virtualized used process is executed using a specific system
578 stack. The size of this stack has a huge impact on the simulation
579 scalability, but its default value is rather large. This is because
580 the error messages that you get when the stack size is too small are
581 rather disturbing: this leads to stack overflow (overwriting other
582 stacks), leading to segfaults with corrupted stack traces.
583
584 If you want to push the scalability limits of your code, you might
585 want to reduce the \b contexts/stack-size item. Its default value
586 is 8192 (in KiB), while our Chord simulation works with stacks as small
587 as 16 KiB, for example. For the thread factory, the default value
588 is the one of the system but you can still change it with this parameter.
589
590 The operating system should only allocate memory for the pages of the
591 stack which are actually used and you might not need to use this in
592 most cases. However, this setting is very important when using the
593 model checker (see \ref options_mc_perf).
594
595 \subsection options_virt_guard_size Disabling stack guard pages
596
597 A stack guard page is usually used which prevents the stack of a given
598 actor from overflowing on another stack. But the performance impact
599 may become prohibitive when the amount of actors increases.  The
600 option \b contexts:guard-size is the number of stack guard pages used.
601 By setting it to 0, no guard pages will be used: in this case, you
602 should avoid using small stacks (\b stack-size) as the stack will
603 silently overflow on other parts of the memory.
604
605 When no stack guard page is created, stacks may then silently overflow
606 on other parts of the memory if their size is too small for the
607 application. This happens:
608
609 - on Windows systems;
610 - when the model checker is enabled;
611 - and of course when guard pages are explicitely disabled (with \b contexts:guard-size=0).
612
613 \subsection options_virt_parallel Running user code in parallel
614
615 Parallel execution of the user code is only considered stable in
616 SimGrid v3.7 and higher, and mostly for MSG simulations. SMPI
617 simulations may well fail in parallel mode. It is described in
618 <a href="http://hal.inria.fr/inria-00602216/">INRIA RR-7653</a>.
619
620 If you are using the \c ucontext or \c raw context factories, you can
621 request to execute the user code in parallel. Several threads are
622 launched, each of them handling as much user contexts at each run. To
623 actiave this, set the \b contexts/nthreads item to the amount of
624 cores that you have in your computer (or lower than 1 to have
625 the amount of cores auto-detected).
626
627 Even if you asked several worker threads using the previous option,
628 you can request to start the parallel execution (and pay the
629 associated synchronization costs) only if the potential parallelism is
630 large enough. For that, set the \b contexts/parallel-threshold
631 item to the minimal amount of user contexts needed to start the
632 parallel execution. In any given simulation round, if that amount is
633 not reached, the contexts will be run sequentially directly by the
634 main thread (thus saving the synchronization costs). Note that this
635 option is mainly useful when the grain of the user code is very fine,
636 because our synchronization is now very efficient.
637
638 When parallel execution is activated, you can choose the
639 synchronization schema used with the \b contexts/synchro item,
640 which value is either:
641  - \b futex: ultra optimized synchronisation schema, based on futexes
642    (fast user-mode mutexes), and thus only available on Linux systems.
643    This is the default mode when available.
644  - \b posix: slow but portable synchronisation using only POSIX
645    primitives.
646  - \b busy_wait: not really a synchronisation: the worker threads
647    constantly request new contexts to execute. It should be the most
648    efficient synchronisation schema, but it loads all the cores of your
649    machine for no good reason. You probably prefer the other less
650    eager schemas.
651
652 \section options_tracing Configuring the tracing subsystem
653
654 The \ref outcomes_vizu "tracing subsystem" can be configured in several
655 different ways depending on the nature of the simulator (MSG, SimDag,
656 SMPI) and the kind of traces that need to be obtained. See the \ref
657 tracing_tracing_options "Tracing Configuration Options subsection" to
658 get a detailed description of each configuration option.
659
660 We detail here a simple way to get the traces working for you, even if
661 you never used the tracing API.
662
663
664 - Any SimGrid-based simulator (MSG, SimDag, SMPI, ...) and raw traces:
665 \verbatim
666 --cfg=tracing:yes --cfg=tracing/uncategorized:yes --cfg=triva/uncategorized:uncat.plist
667 \endverbatim
668     The first parameter activates the tracing subsystem, the second
669     tells it to trace host and link utilization (without any
670     categorization) and the third creates a graph configuration file
671     to configure Triva when analysing the resulting trace file.
672
673 - MSG or SimDag-based simulator and categorized traces (you need to declare categories and classify your tasks according to them)
674 \verbatim
675 --cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=triva/categorized:cat.plist
676 \endverbatim
677     The first parameter activates the tracing subsystem, the second
678     tells it to trace host and link categorized utilization and the
679     third creates a graph configuration file to configure Triva when
680     analysing the resulting trace file.
681
682 - SMPI simulator and traces for a space/time view:
683 \verbatim
684 smpirun -trace ...
685 \endverbatim
686     The <i>-trace</i> parameter for the smpirun script runs the
687 simulation with --cfg=tracing:yes and --cfg=tracing/smpi:yes. Check the
688 smpirun's <i>-help</i> parameter for additional tracing options.
689
690 Sometimes you might want to put additional information on the trace to
691 correctly identify them later, or to provide data that can be used to
692 reproduce an experiment. You have two ways to do that:
693
694 - Add a string on top of the trace file as comment:
695 \verbatim
696 --cfg=tracing/comment:my_simulation_identifier
697 \endverbatim
698
699 - Add the contents of a textual file on top of the trace file as comment:
700 \verbatim
701 --cfg=tracing/comment-file:my_file_with_additional_information.txt
702 \endverbatim
703
704 Please, use these two parameters (for comments) to make reproducible
705 simulations. For additional details about this and all tracing
706 options, check See the \ref tracing_tracing_options.
707
708 \section options_msg Configuring MSG
709
710 \subsection options_msg_debug_multiple_use Debugging MSG
711
712 Sometimes your application may try to send a task that is still being
713 executed somewhere else, making it impossible to send this task. However,
714 for debugging purposes, one may want to know what the other host is/was
715 doing. This option shows a backtrace of the other process.
716
717 Enable this option by adding
718
719 \verbatim
720 --cfg=msg/debug-multiple-use:on
721 \endverbatim
722
723 \section options_smpi Configuring SMPI
724
725 The SMPI interface provides several specific configuration items.
726 These are uneasy to see since the code is usually launched through the
727 \c smiprun script directly.
728
729 \subsection options_smpi_bench smpi/bench: Automatic benchmarking of SMPI code
730
731 In SMPI, the sequential code is automatically benchmarked, and these
732 computations are automatically reported to the simulator. That is to
733 say that if you have a large computation between a \c MPI_Recv() and a
734 \c MPI_Send(), SMPI will automatically benchmark the duration of this
735 code, and create an execution task within the simulator to take this
736 into account. For that, the actual duration is measured on the host
737 machine and then scaled to the power of the corresponding simulated
738 machine. The variable \b smpi/host-speed allows to specify the
739 computational speed of the host machine (in flop/s) to use when
740 scaling the execution times. It defaults to 20000, but you really want
741 to update it to get accurate simulation results.
742
743 When the code is constituted of numerous consecutive MPI calls, the
744 previous mechanism feeds the simulation kernel with numerous tiny
745 computations. The \b smpi/cpu-threshold item becomes handy when this
746 impacts badly the simulation performance. It specifies a threshold (in
747 seconds) below which the execution chunks are not reported to the
748 simulation kernel (default value: 1e-6).
749
750 \note
751     The option smpi/cpu-threshold ignores any computation time spent
752     below this threshold. SMPI does not consider the \a amount of these
753     computations; there is no offset for this. Hence, by using a
754     value that is too low, you may end up with unreliable simulation
755     results.
756
757 In some cases, however, one may wish to disable simulation of
758 application computation. This is the case when SMPI is used not to
759 simulate an MPI applications, but instead an MPI code that performs
760 "live replay" of another MPI app (e.g., ScalaTrace's replay tool,
761 various on-line simulators that run an app at scale). In this case the
762 computation of the replay/simulation logic should not be simulated by
763 SMPI. Instead, the replay tool or on-line simulator will issue
764 "computation events", which correspond to the actual MPI simulation
765 being replayed/simulated. At the moment, these computation events can
766 be simulated using SMPI by calling internal smpi_execute*() functions.
767
768 To disable the benchmarking/simulation of computation in the simulated
769 application, the variable \b smpi/simulate-computation should be set to no.
770
771 \note
772     This option just ignores the timings in your simulation; it still executes
773     the computations itself. If you want to stop SMPI from doing that,
774     you should check the SMPI_SAMPLE macros, documented in the section
775     \ref SMPI_adapting_speed.
776
777 Solution                           | Computations actually executed? | Computations simulated ?
778 ---------------------------------- | ------------------------------- | ------------------------
779 --cfg=smpi/simulate-computation:no | Yes                             | No, never
780 --cfg=smpi/cpu-threshold:42        | Yes, in all cases               | Only if it lasts more than 42 seconds
781 SMPI_SAMPLE() macro                | Only once per loop nest (see @ref SMPI_adapting_speed "documentation") | Always
782
783 \subsection options_model_smpi_adj_file smpi/comp-adjustment-file: Slow-down or speed-up parts of your code.
784
785 This option allows you to pass a file that contains two columns: The first column
786 defines the section that will be subject to a speedup; the second column is the speedup.
787
788 For instance:
789
790 \verbatim
791 "start:stop","ratio"
792 "exchange_1.f:30:exchange_1.f:130",1.18244559422142
793 \endverbatim
794
795 The first line is the header - you must include it.
796 The following line means that the code between two consecutive MPI calls on
797 line 30 in exchange_1.f and line 130 in exchange_1.f should receive a speedup
798 of 1.18244559422142. The value for the second column is therefore a speedup, if it is
799 larger than 1 and a slow-down if it is smaller than 1. Nothing will be changed if it is
800 equal to 1.
801
802 Of course, you can set any arbitrary filenames you want (so the start and end don't have to be
803 in the same file), but be aware that this mechanism only supports @em consecutive calls!
804
805 \note
806     Please note that you must pass the \b -trace-call-location flag to smpicc
807     or smpiff, respectively! This flag activates some macro definitions in our
808     mpi.h / mpi.f files that help with obtaining the call location.
809
810 \subsection options_model_smpi_bw_factor smpi/bw-factor: Bandwidth factors
811
812 The possible throughput of network links is often dependent on the
813 message sizes, as protocols may adapt to different message sizes. With
814 this option, a series of message sizes and factors are given, helping
815 the simulation to be more realistic. For instance, the current
816 default value is
817
818 \verbatim
819 65472:0.940694;15424:0.697866;9376:0.58729;5776:1.08739;3484:0.77493;1426:0.608902;732:0.341987;257:0.338112;0:0.812084
820 \endverbatim
821
822 So, messages with size 65472 and more will get a total of MAX_BANDWIDTH*0.940694,
823 messages of size 15424 to 65471 will get MAX_BANDWIDTH*0.697866 and so on.
824 Here, MAX_BANDWIDTH denotes the bandwidth of the link.
825
826 \note
827     The SimGrid-Team has developed a script to help you determine these
828     values. You can find more information and the download here:
829     1. http://simgrid.gforge.inria.fr/contrib/smpi-calibration-doc.html
830     2. http://simgrid.gforge.inria.fr/contrib/smpi-saturation-doc.html
831
832 \subsection options_smpi_timing smpi/display-timing: Reporting simulation time
833
834 \b Default: 0 (false)
835
836 Most of the time, you run MPI code with SMPI to compute the time it
837 would take to run it on a platform. But since the
838 code is run through the \c smpirun script, you don't have any control
839 on the launcher code, making it difficult to report the simulated time
840 when the simulation ends. If you set the \b smpi/display-timing item
841 to 1, \c smpirun will display this information when the simulation ends. \verbatim
842 Simulation time: 1e3 seconds.
843 \endverbatim
844
845 \subsection options_model_smpi_lat_factor smpi/lat-factor: Latency factors
846
847 The motivation and syntax for this option is identical to the motivation/syntax
848 of smpi/bw-factor, see \ref options_model_smpi_bw_factor for details.
849
850 There is an important difference, though: While smpi/bw-factor \a reduces the
851 actual bandwidth (i.e., values between 0 and 1 are valid), latency factors
852 increase the latency, i.e., values larger than or equal to 1 are valid here.
853
854 This is the default value:
855
856 \verbatim
857 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
858 \endverbatim
859
860 \note
861     The SimGrid-Team has developed a script to help you determine these
862     values. You can find more information and the download here:
863     1. http://simgrid.gforge.inria.fr/contrib/smpi-calibration-doc.html
864     2. http://simgrid.gforge.inria.fr/contrib/smpi-saturation-doc.html
865
866 \subsection options_smpi_papi_events smpi/papi-events: Trace hardware counters with PAPI
867
868 \warning 
869     This option is experimental and will be subject to change.
870     This feature currently requires superuser privileges, as registers are queried.
871     Only use this feature with code you trust! Call smpirun for instance via
872         smpirun -wrapper "sudo " <your-parameters>
873     or run sudo sh -c "echo 0 > /proc/sys/kernel/perf_event_paranoid"
874     In the later case, sudo will not be required.
875
876 \note
877     This option is only available when SimGrid was compiled with PAPI support.
878
879 This option takes the names of PAPI counters and adds their respective values
880 to the trace files. (See Section \ref tracing_tracing_options.)
881
882 It is planned to make this feature available on a per-process (or per-thread?) basis.
883 The first draft, however, just implements a "global" (i.e., for all processes) set
884 of counters, the "default" set.
885
886 \verbatim
887 --cfg=smpi/papi-events:"default:PAPI_L3_LDM:PAPI_L2_LDM"
888 \endverbatim
889
890 \subsection options_smpi_global smpi/privatize-global-variables: Automatic privatization of global variables
891
892 MPI executables are meant to be executed in separated processes, but SMPI is
893 executed in only one process. Global variables from executables will be placed
894 in the same memory zone and shared between processes, causing hard to find bugs.
895 To avoid this, several options are possible :
896   - Manual edition of the code, for example to add __thread keyword before data
897   declaration, which allows the resulting code to work with SMPI, but only
898   if the thread factory (see \ref options_virt_factory) is used, as global
899   variables are then placed in the TLS (thread local storage) segment.
900   - Source-to-source transformation, to add a level of indirection
901   to the global variables. SMPI does this for F77 codes compiled with smpiff,
902   and used to provide coccinelle scripts for C codes, which are not functional anymore.
903   - Compilation pass, to have the compiler automatically put the data in
904   an adapted zone.
905   - Runtime automatic switching of the data segments. SMPI stores a copy of
906   each global data segment for each process, and at each context switch replaces
907   the actual data with its copy from the right process. This mechanism uses mmap,
908   and is for now limited to systems supporting this functionnality (all Linux
909   and some BSD should be compatible).
910   Another limitation is that SMPI only accounts for global variables defined in
911   the executable. If the processes use external global variables from dynamic
912   libraries, they won't be switched correctly. To avoid this, using static
913   linking is advised (but not with the simgrid library, to avoid replicating
914   its own global variables).
915
916   To use this runtime automatic switching, the variable \b smpi/privatize-global-variables
917   should be set to yes
918
919 \warning
920   This configuration option cannot be set in your platform file. You can only
921   pass it as an argument to smpirun.
922
923
924 \subsection options_model_smpi_detached Simulating MPI detached send
925
926 This threshold specifies the size in bytes under which the send will return
927 immediately. This is different from the threshold detailed in  \ref options_model_network_asyncsend
928 because the message is not effectively sent when the send is posted. SMPI still waits for the
929 correspondant receive to be posted to perform the communication operation. This threshold can be set
930 by changing the \b smpi/send-is-detached-thresh item. The default value is 65536.
931
932 \subsection options_model_smpi_collectives Simulating MPI collective algorithms
933
934 SMPI implements more than 100 different algorithms for MPI collective communication, to accurately
935 simulate the behavior of most of the existing MPI libraries. The \b smpi/coll-selector item can be used
936  to use the decision logic of either OpenMPI or MPICH libraries (values: ompi or mpich, by default SMPI
937 uses naive version of collective operations). Each collective operation can be manually selected with a
938 \b smpi/collective_name:algo_name. Available algorithms are listed in \ref SMPI_use_colls .
939
940 \subsection options_model_smpi_iprobe smpi/iprobe: Inject constant times for calls to MPI_Iprobe
941
942 \b Default value: 0.0001
943
944 The behavior and motivation for this configuration option is identical with \a smpi/test, see
945 Section \ref options_model_smpi_test for details.
946
947 \subsection options_model_smpi_init smpi/init: Inject constant times for calls to MPI_Init
948
949 \b Default value: 0
950
951 The behavior for this configuration option is identical with \a smpi/test, see
952 Section \ref options_model_smpi_test for details.
953
954 \subsection options_model_smpi_ois smpi/ois: Inject constant times for asynchronous send operations
955
956 This configuration option works exactly as \a smpi/os, see Section \ref options_model_smpi_os.
957 Of course, \a smpi/ois is used to account for MPI_Isend instead of MPI_Send.
958
959 \subsection options_model_smpi_os smpi/os: Inject constant times for send operations
960
961 In several network models such as LogP, send (MPI_Send, MPI_Isend) and receive (MPI_Recv)
962 operations incur costs (i.e., they consume CPU time). SMPI can factor these costs in as well, but the
963 user has to configure SMPI accordingly as these values may vary by machine.
964 This can be done by using smpi/os for MPI_Send operations; for MPI_Isend and
965 MPI_Recv, use \a smpi/ois and \a smpi/or, respectively. These work exactly as
966 \a smpi/ois.
967
968 \a smpi/os can consist of multiple sections; each section takes three values, for example:
969
970 \verbatim
971     1:3:2;10:5:1
972 \endverbatim
973
974 Here, the sections are divided by ";" (that is, this example contains two sections).
975 Furthermore, each section consists of three values.
976
977 1. The first value denotes the minimum size for this section to take effect;
978    read it as "if message size is greater than this value (and other section has a larger
979    first value that is also smaller than the message size), use this".
980    In the first section above, this value is "1".
981
982 2. The second value is the startup time; this is a constant value that will always
983    be charged, no matter what the size of the message. In the first section above,
984    this value is "3".
985
986 3. The third value is the \a per-byte cost. That is, it is charged for every
987    byte of the message (incurring cost messageSize*cost_per_byte)
988    and hence accounts also for larger messages. In the first
989    section of the example above, this value is "2".
990
991 Now, SMPI always checks which section it should take for a given message; that is,
992 if a message of size 11 is sent with the configuration of the example above, only
993 the second section will be used, not the first, as the first value of the second
994 section is closer to the message size. Hence, a message of size 11 incurs the
995 following cost inside MPI_Send:
996
997 \verbatim
998     5+11*1
999 \endverbatim
1000
1001 As 5 is the startup cost and 1 is the cost per byte.
1002
1003 \note
1004     The order of sections can be arbitrary; they will be ordered internally.
1005
1006 \subsection options_model_smpi_or smpi/or: Inject constant times for receive operations
1007
1008 This configuration option works exactly as \a smpi/os, see Section \ref options_model_smpi_os.
1009 Of course, \a smpi/or is used to account for MPI_Recv instead of MPI_Send.
1010
1011 \subsection options_model_smpi_test smpi/test: Inject constant times for calls to MPI_Test
1012
1013 \b Default value: 0.0001
1014
1015 By setting this option, you can control the amount of time a process sleeps
1016 when MPI_Test() is called; this is important, because SimGrid normally only
1017 advances the time while communication is happening and thus,
1018 MPI_Test will not add to the time, resulting in a deadlock if used as a
1019 break-condition.
1020
1021 Here is an example:
1022
1023 \code{.unparsed}
1024     while(!flag) {
1025         MPI_Test(request, flag, status);
1026         ...
1027     }
1028 \endcode
1029
1030 \note
1031     Internally, in order to speed up execution, we use a counter to keep track
1032     on how often we already checked if the handle is now valid or not. Hence, we
1033     actually use counter*SLEEP_TIME, that is, the time MPI_Test() causes the process
1034     to sleep increases linearly with the number of previously failed tests. This 
1035     behavior can be disabled by setting smpi/grow-injected-times to no. This will
1036     also disable this behavior for MPI_Iprobe.
1037
1038
1039 \subsection options_model_smpi_use_shared_malloc smpi/use-shared-malloc: Factorize malloc()s
1040
1041 \b Default: 1
1042
1043 SMPI can use shared memory by calling shm_* functions; this might speed up the simulation.
1044 This opens or creates a new POSIX shared memory object, kept in RAM, in /dev/shm.
1045
1046 If you want to disable this behavior, set the value to 0.
1047
1048 \subsection options_model_smpi_wtime smpi/wtime: Inject constant times for calls to MPI_Wtime
1049
1050 \b Default value: 0
1051
1052 By setting this option, you can control the amount of time a process sleeps
1053 when MPI_Wtime() is called; this is important, because SimGrid normally only
1054 advances the time while communication is happening and thus,
1055 MPI_Wtime will not add to the time, resulting in a deadlock if used as a
1056 break-condition.
1057
1058 Here is an example:
1059
1060 \code{.unparsed}
1061     while(MPI_Wtime() < some_time_bound) {
1062         ...
1063     }
1064 \endcode
1065
1066 If the time is never advanced, this loop will clearly never end as MPI_Wtime()
1067 always returns the same value. Hence, pass a (small) value to the smpi/wtime
1068 option to force a call to MPI_Wtime to advance the time as well.
1069
1070
1071 \section options_generic Configuring other aspects of SimGrid
1072
1073 \subsection options_generic_clean_atexit Cleanup before termination
1074
1075 The C / C++ standard contains a function called \b [atexit](http://www.cplusplus.com/reference/cstdlib/atexit/).
1076 atexit registers callbacks, which are called just before the program terminates.
1077
1078 By setting the configuration option clean-atexit to 1 (true), a callback
1079 is registered and will clean up some variables and terminate/cleanup the tracing.
1080
1081 TODO: Add when this should be used.
1082
1083 \subsection options_generic_path XML file inclusion path
1084
1085 It is possible to specify a list of directories to search into for the
1086 \<include\> tag in XML files by using the \b path configuration
1087 item. To add several directory to the path, set the configuration
1088 item several times, as in \verbatim
1089 --cfg=path:toto --cfg=path:tutu
1090 \endverbatim
1091
1092 \subsection options_generic_exit Behavior on Ctrl-C
1093
1094 By default, when Ctrl-C is pressed, the status of all existing
1095 simulated processes is displayed before exiting the simulation. This is very useful to debug your
1096 code, but it can reveal troublesome in some cases (such as when the
1097 amount of processes becomes really big). This behavior is disabled
1098 when \b verbose-exit is set to 0 (it is to 1 by default).
1099
1100 \subsection options_exception_cutpath Truncate local path from exception backtrace
1101
1102 \verbatim
1103 --cfg=exceptions/cutpath:1
1104 \endverbatim
1105
1106 This configuration option is used to remove the path from the
1107 backtrace shown when an exception is thrown. This is mainly useful for
1108 the tests: the full file path makes the tests not reproducible, and
1109 thus failing as we are currently comparing output. Clearly, the path
1110 used on different machines are almost guaranteed to be different and
1111 hence, the output would mismatch, causing the test to fail.
1112
1113 \section options_log Logging Configuration
1114
1115 It can be done by using XBT. Go to \ref XBT_log for more details.
1116
1117 \section options_index Index of all existing configuration options
1118
1119 \note
1120   Almost all options are defined in <i>src/simgrid/sg_config.c</i>. You may
1121   want to check this file, too, but this index should be somewhat complete
1122   for the moment (May 2015).
1123
1124 \note
1125   \b Please \b note: You can also pass the command-line option "--help" and
1126      "--help-cfg" to an executable that uses simgrid.
1127
1128 - \c clean-atexit: \ref options_generic_clean_atexit
1129
1130 - \c contexts/factory: \ref options_virt_factory
1131 - \c contexts/guard-size: \ref options_virt_guard_size
1132 - \c contexts/nthreads: \ref options_virt_parallel
1133 - \c contexts/parallel_threshold: \ref options_virt_parallel
1134 - \c contexts/stack-size: \ref options_virt_stacksize
1135 - \c contexts/synchro: \ref options_virt_parallel
1136
1137 - \c cpu/maxmin-selective-update: \ref options_model_optim
1138 - \c cpu/model: \ref options_model_select
1139 - \c cpu/optim: \ref options_model_optim
1140
1141 - \c exception/cutpath: \ref options_exception_cutpath
1142
1143 - \c host/model: \ref options_model_select
1144
1145 - \c maxmin/precision: \ref options_model_precision
1146
1147 - \c msg/debug-multiple-use: \ref options_msg_debug_multiple_use
1148
1149 - \c model-check: \ref options_modelchecking
1150 - \c model-check/checkpoint: \ref options_modelchecking_steps
1151 - \c model-check/communications-determinism: \ref options_modelchecking_comm_determinism
1152 - \c model-check/dot-output: \ref options_modelchecking_dot_output
1153 - \c model-check/hash: \ref options_modelchecking_hash
1154 - \c model-check/property: \ref options_modelchecking_liveness
1155 - \c model-check/max-depth: \ref options_modelchecking_max_depth
1156 - \c model-check/record: \ref options_modelchecking_recordreplay
1157 - \c model-check/reduction: \ref options_modelchecking_reduction
1158 - \c model-check/replay: \ref options_modelchecking_recordreplay
1159 - \c model-check/send-determinism: \ref options_modelchecking_comm_determinism
1160 - \c model-check/sparse-checkpoint: \ref options_modelchecking_sparse_checkpoint
1161 - \c model-check/termination: \ref options_modelchecking_termination
1162 - \c model-check/timeout: \ref options_modelchecking_timeout
1163 - \c model-check/visited: \ref options_modelchecking_visited
1164
1165 - \c network/bandwidth-factor: \ref options_model_network_coefs
1166 - \c network/crosstraffic: \ref options_model_network_crosstraffic
1167 - \c network/latency-factor: \ref options_model_network_coefs
1168 - \c network/maxmin-selective-update: \ref options_model_optim
1169 - \c network/model: \ref options_model_select
1170 - \c network/optim: \ref options_model_optim
1171 - \c network/sender_gap: \ref options_model_network_sendergap
1172 - \c network/TCP-gamma: \ref options_model_network_gamma
1173 - \c network/weight-S: \ref options_model_network_coefs
1174
1175 - \c ns3/TcpModel: \ref options_pls
1176 - \c path: \ref options_generic_path
1177 - \c plugin: \ref options_generic_plugin
1178
1179 - \c storage/max_file_descriptors: \ref option_model_storage_maxfd
1180
1181 - \c surf/precision: \ref options_model_precision
1182
1183 - \c <b>For collective operations of SMPI, please refer to Section \ref options_index_smpi_coll</b>
1184 - \c smpi/async-small-thresh: \ref options_model_network_asyncsend
1185 - \c smpi/bw-factor: \ref options_model_smpi_bw_factor
1186 - \c smpi/coll-selector: \ref options_model_smpi_collectives
1187 - \c smpi/comp-adjustment-file: \ref options_model_smpi_adj_file
1188 - \c smpi/cpu-threshold: \ref options_smpi_bench
1189 - \c smpi/display-timing: \ref options_smpi_timing
1190 - \c smpi/grow-injected-times: \ref options_model_smpi_test
1191 - \c smpi/host-speed: \ref options_smpi_bench
1192 - \c smpi/IB-penalty-factors: \ref options_model_network_coefs
1193 - \c smpi/iprobe: \ref options_model_smpi_iprobe
1194 - \c smpi/init: \ref options_model_smpi_init
1195 - \c smpi/lat-factor: \ref options_model_smpi_lat_factor
1196 - \c smpi/ois: \ref options_model_smpi_ois
1197 - \c smpi/or: \ref options_model_smpi_or
1198 - \c smpi/os: \ref options_model_smpi_os
1199 - \c smpi/papi-events: \ref options_smpi_papi_events
1200 - \c smpi/privatize-global-variables: \ref options_smpi_global
1201 - \c smpi/send-is-detached-thresh: \ref options_model_smpi_detached
1202 - \c smpi/simulate-computation: \ref options_smpi_bench
1203 - \c smpi/test: \ref options_model_smpi_test
1204 - \c smpi/use-shared-malloc: \ref options_model_smpi_use_shared_malloc
1205 - \c smpi/wtime: \ref options_model_smpi_wtime
1206
1207 - \c <b>Tracing configuration options can be found in Section \ref tracing_tracing_options</b>.
1208
1209 - \c storage/model: \ref options_storage_model
1210 - \c verbose-exit: \ref options_generic_exit
1211
1212 - \c vm/model: \ref options_vm_model
1213
1214 \subsection options_index_smpi_coll Index of SMPI collective algorithms options
1215
1216 TODO: All available collective algorithms will be made available via the ``smpirun --help-coll`` command.
1217
1218 */