Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
979f2c3de13c6b13075345794a3dbe92a2e29030
[simgrid.git] / doc / doxygen / options.doc
1 /*! \page options Step 2: 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 \section options_using Passing configuration options to the simulators
13
14 There is several way to pass configuration options to the simulators.
15 The most common way is to use the \c --cfg command line argument. For
16 example, to set the item \c Item to the value \c Value, simply
17 type the following: \verbatim
18 my_simulator --cfg=Item:Value (other arguments)
19 \endverbatim
20
21 Several \c `--cfg` command line arguments can naturally be used. If you
22 need to include spaces in the argument, don't forget to quote the
23 argument. You can even escape the included quotes (write \' for ' if
24 you have your argument between ').
25
26 Another solution is to use the \c \<config\> tag in the platform file. The
27 only restriction is that this tag must occure before the first
28 platform element (be it \c \<AS\>, \c \<cluster\>, \c \<peer\> or whatever).
29 The \c \<config\> tag takes an \c id attribute, but it is currently
30 ignored so you don't really need to pass it. The important par is that
31 within that tag, you can pass one or several \c \<prop\> tags to specify
32 the configuration to use. For example, setting \c Item to \c Value
33 can be done by adding the following to the beginning of your platform
34 file:
35 \verbatim
36 <config>
37   <prop id="Item" value="Value"/>
38 </config>
39 \endverbatim
40
41 A last solution is to pass your configuration directly using the C
42 interface. If you happen to use the MSG interface, this is very easy
43 with the MSG_config() function. If you do not use MSG, that's a bit
44 more complex, as you have to mess with the internal configuration set
45 directly as follows. Check the \ref XBT_config "relevant page" for
46 details on all the functions you can use in this context, \c
47 _sg_cfg_set being the only configuration set currently used in
48 SimGrid.
49
50 @code
51 #include <xbt/config.h>
52
53 extern xbt_cfg_t _sg_cfg_set;
54
55 int main(int argc, char *argv[]) {
56      SD_init(&argc, argv);
57
58      /* Prefer MSG_config() if you use MSG!! */
59      xbt_cfg_set_parse(_sg_cfg_set,"Item:Value");
60
61      // Rest of your code
62 }
63 @endcode
64
65 \section options_model Configuring the platform models
66
67 \anchor options_storage_model
68 \anchor options_vm_model
69 \subsection options_model_select Selecting the platform models
70
71 SimGrid comes with several network, CPU and storage models built in, and you
72 can change the used model at runtime by changing the passed
73 configuration. The three main configuration items are given below.
74 For each of these items, passing the special \c help value gives
75 you a short description of all possible values. Also, \c --help-models
76 should provide information about all models for all existing resources.
77    - \b network/model: specify the used network model
78    - \b cpu/model: specify the used CPU model
79    - \b host/model: specify the used host model
80    - \b storage/model: specify the used storage model (there is currently only one such model - this option is hence only useful for future releases)
81    - \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)
82
83 %As of writing, the following network models are accepted. Over
84 the time new models can be added, and some experimental models can be
85 removed; check the values on your simulators for an uptodate
86 information. Note that the CM02 model is described in the research report
87 <a href="ftp://ftp.ens-lyon.fr/pub/LIP/Rapports/RR/RR2002/RR2002-40.ps.gz">A
88 Network Model for Simulation of Grid Application</a> while LV08 is
89 described in
90 <a href="http://mescal.imag.fr/membres/arnaud.legrand/articles/simutools09.pdf">Accuracy Study and Improvement of Network Simulation in the SimGrid Framework</a>.
91
92   - \b LV08 (default one): Realistic network analytic model
93     (slow-start modeled by multiplying latency by 10.4, bandwidth by
94     .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT)
95   - \anchor options_model_select_network_constant \b Constant: Simplistic network model where all communication
96     take a constant time (one second). This model provides the lowest
97     realism, but is (marginally) faster.
98   - \b SMPI: Realistic network model specifically tailored for HPC
99     settings (accurate modeling of slow start with correction factors on
100     three intervals: < 1KiB, < 64 KiB, >= 64 KiB). See also \ref
101     options_model_network_coefs "this section" for more info.
102   - \b IB: Realistic network model specifically tailored for HPC
103     settings with InfiniBand networks (accurate modeling contention
104     behavior, based on the model explained in
105     http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf).
106     See also \ref options_model_network_coefs "this section" for more info.
107   - \b CM02: Legacy network analytic model (Very similar to LV08, but
108     without corrective factors. The timings of small messages are thus
109     poorly modeled)
110   - \b Reno: Model from Steven H. Low using lagrange_solve instead of
111     lmm_solve (experts only; check the code for more info).
112   - \b Reno2: Model from Steven H. Low using lagrange_solve instead of
113     lmm_solve (experts only; check the code for more info).
114   - \b Vegas: Model from Steven H. Low using lagrange_solve instead of
115     lmm_solve (experts only; check the code for more info).
116
117 If you compiled SimGrid accordingly, you can use packet-level network
118 simulators as network models (see \ref pls). In that case, you have
119 two extra models, described below, and some \ref options_pls "specific
120 additional configuration flags".
121   - \b NS3: Network pseudo-model using the NS3 tcp model instead of an
122     analytic model
123
124 Concerning the CPU, we have only one model for now:
125   - \b Cas01: Simplistic CPU model (time=size/power)
126
127 The host concept is the aggregation of a CPU with a network
128 card. Three models exists, but actually, only 2 of them are
129 interesting. The "compound" one is simply due to the way our internal
130 code is organized, and can easily be ignored. So at the end, you have
131 two host models: The default one allows to aggregate an
132 existing CPU model with an existing network model, but does not allow
133 parallel tasks because these beasts need some collaboration between
134 the network and CPU model. That is why, ptask_07 is used by default
135 when using SimDag.
136   - \b default: Default host model. Currently, CPU:Cas01 and
137     network:LV08 (with cross traffic enabled)
138   - \b compound: Host model that is automatically chosen if
139     you change the network and CPU models
140   - \b ptask_L07: Host model somehow similar to Cas01+CM02 but
141     allowing parallel tasks
142
143 \subsection options_generic_plugin Plugins
144
145 SimGrid supports the use of plugins; currently, no known plugins
146 can be activated but there are use-cases where you may want to write
147 your own plugin (for instance, for logging).
148
149 Plugins can for instance define own classes that inherit from
150 existing classes (for instance, a class "CpuEnergy" inherits from
151 "Cpu" to assess energy consumption).
152
153 The plugin connects to the code by registering callbacks using
154 ``surf_callback_register`` (see file ``src/surf/plugins/energy.cpp`` for details).
155
156 \verbatim
157     --cfg=plugin:Energy
158 \endverbatim
159
160 \note
161     This option is case-sensitive: Energy and energy are not the same!
162
163 \subsection options_model_optim Optimization level of the platform models
164
165 The network and CPU models that are based on lmm_solve (that
166 is, all our analytical models) accept specific optimization
167 configurations.
168   - items \b network/optim and \b CPU/optim (both default to 'Lazy'):
169     - \b Lazy: Lazy action management (partial invalidation in lmm +
170       heap in action remaining).
171     - \b TI: Trace integration. Highly optimized mode when using
172       availability traces (only available for the Cas01 CPU model for
173       now).
174     - \b Full: Full update of remaining and variables. Slow but may be
175       useful when debugging.
176   - items \b network/maxmin_selective_update and
177     \b cpu/maxmin_selective_update: configure whether the underlying
178     should be lazily updated or not. It should have no impact on the
179     computed timings, but should speed up the computation.
180
181 It is still possible to disable the \c maxmin_selective_update feature
182 because it can reveal counter-productive in very specific scenarios
183 where the interaction level is high. In particular, if all your
184 communication share a given backbone link, you should disable it:
185 without \c maxmin_selective_update, every communications are updated
186 at each step through a simple loop over them. With that feature
187 enabled, every communications will still get updated in this case
188 (because of the dependency induced by the backbone), but through a
189 complicated pattern aiming at following the actual dependencies.
190
191 \subsection options_model_precision Numerical precision of the platform models
192
193 The analytical models handle a lot of floating point values. It is
194 possible to change the epsilon used to update and compare them through
195 the \b maxmin/precision item (default value: 0.00001). Changing it
196 may speedup the simulation by discarding very small actions, at the
197 price of a reduced numerical precision.
198
199 \subsection options_model_nthreads Parallel threads for model updates
200
201 By default, Surf computes the analytical models sequentially to share their
202 resources and update their actions. It is possible to run them in parallel,
203 using the \b surf/nthreads item (default value: 1). If you use a
204 negative or null value, the amount of available cores is automatically
205 detected  and used instead.
206
207 Depending on the workload of the models and their complexity, you may get a
208 speedup or a slowdown because of the synchronization costs of threads.
209
210 \subsection options_model_network Configuring the Network model
211
212 \subsubsection options_model_network_gamma Maximal TCP window size
213
214 The analytical models need to know the maximal TCP window size to take
215 the TCP congestion mechanism into account. This is set to 20000 by
216 default, but can be changed using the \b network/TCP_gamma item.
217
218 On linux, this value can be retrieved using the following
219 commands. Both give a set of values, and you should use the last one,
220 which is the maximal size.\verbatim
221 cat /proc/sys/net/ipv4/tcp_rmem # gives the sender window
222 cat /proc/sys/net/ipv4/tcp_wmem # gives the receiver window
223 \endverbatim
224
225 \subsubsection options_model_network_coefs Correcting important network parameters
226
227 SimGrid can take network irregularities such as a slow startup or
228 changing behavior depending on the message size into account.
229 You should not change these values unless you really know what you're doing.
230
231 The corresponding values were computed through data fitting one the
232 timings of packet-level simulators.
233
234 See
235 <a href="http://mescal.imag.fr/membres/arnaud.legrand/articles/simutools09.pdf">Accuracy Study and Improvement of Network Simulation in the SimGrid Framework</a>
236 for more information about these parameters.
237
238 If you are using the SMPI model, these correction coefficients are
239 themselves corrected by constant values depending on the size of the
240 exchange. Again, only hardcore experts should bother about this fact.
241
242 InfiniBand network behavior can be modeled through 3 parameters, as explained in
243 <a href="http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf">this PhD thesis</a>.
244 These factors can be changed through the following option:
245
246 \verbatim
247 smpi/IB_penalty_factors:"βe;βs;γs"
248 \endverbatim
249
250 By default SMPI uses factors computed on the Stampede Supercomputer at TACC, with optimal
251 deployment of processes on nodes.
252
253 \subsubsection options_model_network_crosstraffic Simulating cross-traffic
254
255 As of SimGrid v3.7, cross-traffic effects can be taken into account in
256 analytical simulations. It means that ongoing and incoming
257 communication flows are treated independently. In addition, the LV08
258 model adds 0.05 of usage on the opposite direction for each new
259 created flow. This can be useful to simulate some important TCP
260 phenomena such as ack compression.
261
262 For that to work, your platform must have two links for each
263 pair of interconnected hosts. An example of usable platform is
264 available in <tt>examples/platforms/crosstraffic.xml</tt>.
265
266 This is activated through the \b network/crosstraffic item, that
267 can be set to 0 (disable this feature) or 1 (enable it).
268
269 Note that with the default host model this option is activated by default.
270
271 \subsubsection options_model_network_coord Coordinated-based network models
272
273 When you want to use network coordinates, as it happens when you use
274 an \<AS\> in your platform file with \c Vivaldi as a routing (see also
275 Section \ref pf_routing_model_vivaldi "Vivaldi Routing Model"), you must
276 set the \b network/coordinates to \c yes so that all mandatory
277 initialization are done in the simulator.
278
279 \subsubsection options_model_network_sendergap Simulating sender gap
280
281 (this configuration item is experimental and may change or disapear)
282
283 It is possible to specify a timing gap between consecutive emission on
284 the same network card through the \b network/sender_gap item. This
285 is still under investigation as of writting, and the default value is
286 to wait 10 microseconds (1e-5 seconds) between emissions.
287
288 \subsubsection options_model_network_asyncsend Simulating asyncronous send
289
290 (this configuration item is experimental and may change or disapear)
291
292 It is possible to specify that messages below a certain size will be sent
293 as soon as the call to MPI_Send is issued, without waiting for the
294 correspondant receive. This threshold can be configured through the
295 \b smpi/async_small_thres item. The default value is 0. This behavior can also be
296 manually set for MSG mailboxes, by setting the receiving mode of the mailbox
297 with a call to \ref MSG_mailbox_set_async . For MSG, all messages sent to this
298 mailbox will have this behavior, so consider using two mailboxes if needed.
299
300 This value needs to be smaller than or equals to the threshold set at
301 \ref options_model_smpi_detached , because asynchronous messages are
302 meant to be detached as well.
303
304 \subsubsection options_pls Configuring packet-level pseudo-models
305
306 When using the packet-level pseudo-models, several specific
307 configuration flags are provided to configure the associated tools.
308 There is by far not enough such SimGrid flags to cover every aspects
309 of the associated tools, since we only added the items that we
310 needed ourselves. Feel free to request more items (or even better:
311 provide patches adding more items).
312
313 When using NS3, the only existing item is \b ns3/TcpModel,
314 corresponding to the ns3::TcpL4Protocol::SocketType configuration item
315 in NS3. The only valid values (enforced on the SimGrid side) are
316 'NewReno' or 'Reno' or 'Tahoe'.
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.
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 mecanism
536 allowing 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 sorted here from the slowest
548 to the most effient:
549  - \b thread: very slow factory using full featured threads (either
550    pthreads or windows native threads)
551  - \b ucontext: fast factory using System V contexts (or a portability
552    layer of our own on top of Windows fibers)
553  - \b raw: amazingly fast factory using a context switching mecanism
554    of our own, directly implemented in assembly (only available for x86
555    and amd64 platforms for now)
556
557 The only reason to change this setting is when the debugging tools get
558 fooled by the optimized context factories. Threads are the most
559 debugging-friendly contextes, as they allow to set breakpoints anywhere with gdb
560  and visualize backtraces for all processes, in order to debug concurrency issues.
561 Valgrind is also more comfortable with threads, but it should be usable with all factories.
562
563 \subsection options_virt_stacksize Adapting the used stack size
564
565 Each virtualized used process is executed using a specific system
566 stack. The size of this stack has a huge impact on the simulation
567 scalability, but its default value is rather large. This is because
568 the error messages that you get when the stack size is too small are
569 rather disturbing: this leads to stack overflow (overwriting other
570 stacks), leading to segfaults with corrupted stack traces.
571
572 If you want to push the scalability limits of your code, you might
573 want to reduce the \b contexts/stack_size item. Its default value
574 is 8192 (in KiB), while our Chord simulation works with stacks as small
575 as 16 KiB, for example. For the thread factory, the default value
576 is the one of the system, if it is too large/small, it has to be set
577 with this parameter.
578
579 The operating system should only allocate memory for the pages of the
580 stack which are actually used and you might not need to use this in
581 most cases. However, this setting is very important when using the
582 model checker (see \ref options_mc_perf).
583
584 In some cases, no stack guard page is used and the stack will silently
585 overflow on other parts of the memory if the stack size is too small
586 for your application. This happens :
587
588 - on Windows systems;
589 - when the model checker is enabled;
590 - when stack guard pages are explicitely disabled (see \ref  options_perf_guard_size).
591
592 \subsection options_virt_parallel Running user code in parallel
593
594 Parallel execution of the user code is only considered stable in
595 SimGrid v3.7 and higher. It is described in
596 <a href="http://hal.inria.fr/inria-00602216/">INRIA RR-7653</a>.
597
598 If you are using the \c ucontext or \c raw context factories, you can
599 request to execute the user code in parallel. Several threads are
600 launched, each of them handling as much user contexts at each run. To
601 actiave this, set the \b contexts/nthreads item to the amount of
602 cores that you have in your computer (or lower than 1 to have
603 the amount of cores auto-detected).
604
605 Even if you asked several worker threads using the previous option,
606 you can request to start the parallel execution (and pay the
607 associated synchronization costs) only if the potential parallelism is
608 large enough. For that, set the \b contexts/parallel_threshold
609 item to the minimal amount of user contexts needed to start the
610 parallel execution. In any given simulation round, if that amount is
611 not reached, the contexts will be run sequentially directly by the
612 main thread (thus saving the synchronization costs). Note that this
613 option is mainly useful when the grain of the user code is very fine,
614 because our synchronization is now very efficient.
615
616 When parallel execution is activated, you can choose the
617 synchronization schema used with the \b contexts/synchro item,
618 which value is either:
619  - \b futex: ultra optimized synchronisation schema, based on futexes
620    (fast user-mode mutexes), and thus only available on Linux systems.
621    This is the default mode when available.
622  - \b posix: slow but portable synchronisation using only POSIX
623    primitives.
624  - \b busy_wait: not really a synchronisation: the worker threads
625    constantly request new contexts to execute. It should be the most
626    efficient synchronisation schema, but it loads all the cores of your
627    machine for no good reason. You probably prefer the other less
628    eager schemas.
629
630 \section options_tracing Configuring the tracing subsystem
631
632 The \ref tracing "tracing subsystem" can be configured in several
633 different ways depending on the nature of the simulator (MSG, SimDag,
634 SMPI) and the kind of traces that need to be obtained. See the \ref
635 tracing_tracing_options "Tracing Configuration Options subsection" to
636 get a detailed description of each configuration option.
637
638 We detail here a simple way to get the traces working for you, even if
639 you never used the tracing API.
640
641
642 - Any SimGrid-based simulator (MSG, SimDag, SMPI, ...) and raw traces:
643 \verbatim
644 --cfg=tracing:yes --cfg=tracing/uncategorized:yes --cfg=triva/uncategorized:uncat.plist
645 \endverbatim
646     The first parameter activates the tracing subsystem, the second
647     tells it to trace host and link utilization (without any
648     categorization) and the third creates a graph configuration file
649     to configure Triva when analysing the resulting trace file.
650
651 - MSG or SimDag-based simulator and categorized traces (you need to declare categories and classify your tasks according to them)
652 \verbatim
653 --cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=triva/categorized:cat.plist
654 \endverbatim
655     The first parameter activates the tracing subsystem, the second
656     tells it to trace host and link categorized utilization and the
657     third creates a graph configuration file to configure Triva when
658     analysing the resulting trace file.
659
660 - SMPI simulator and traces for a space/time view:
661 \verbatim
662 smpirun -trace ...
663 \endverbatim
664     The <i>-trace</i> parameter for the smpirun script runs the
665 simulation with --cfg=tracing:yes and --cfg=tracing/smpi:yes. Check the
666 smpirun's <i>-help</i> parameter for additional tracing options.
667
668 Sometimes you might want to put additional information on the trace to
669 correctly identify them later, or to provide data that can be used to
670 reproduce an experiment. You have two ways to do that:
671
672 - Add a string on top of the trace file as comment:
673 \verbatim
674 --cfg=tracing/comment:my_simulation_identifier
675 \endverbatim
676
677 - Add the contents of a textual file on top of the trace file as comment:
678 \verbatim
679 --cfg=tracing/comment_file:my_file_with_additional_information.txt
680 \endverbatim
681
682 Please, use these two parameters (for comments) to make reproducible
683 simulations. For additional details about this and all tracing
684 options, check See the \ref tracing_tracing_options.
685
686 \section options_msg Configuring MSG
687
688 \subsection options_msg_debug_multiple_use Debugging MSG
689
690 Sometimes your application may try to send a task that is still being
691 executed somewhere else, making it impossible to send this task. However,
692 for debugging purposes, one may want to know what the other host is/was
693 doing. This option shows a backtrace of the other process.
694
695 Enable this option by adding
696
697 \verbatim
698 --cfg=msg/debug_multiple_use:on
699 \endverbatim
700
701 \section options_smpi Configuring SMPI
702
703 The SMPI interface provides several specific configuration items.
704 These are uneasy to see since the code is usually launched through the
705 \c smiprun script directly.
706
707 \subsection options_smpi_bench smpi/bench: Automatic benchmarking of SMPI code
708
709 In SMPI, the sequential code is automatically benchmarked, and these
710 computations are automatically reported to the simulator. That is to
711 say that if you have a large computation between a \c MPI_Recv() and a
712 \c MPI_Send(), SMPI will automatically benchmark the duration of this
713 code, and create an execution task within the simulator to take this
714 into account. For that, the actual duration is measured on the host
715 machine and then scaled to the power of the corresponding simulated
716 machine. The variable \b smpi/running_power allows to specify the
717 computational power of the host machine (in flop/s) to use when
718 scaling the execution times. It defaults to 20000, but you really want
719 to update it to get accurate simulation results.
720
721 When the code is constituted of numerous consecutive MPI calls, the
722 previous mechanism feeds the simulation kernel with numerous tiny
723 computations. The \b smpi/cpu_threshold item becomes handy when this
724 impacts badly the simulation performance. It specifies a threshold (in
725 seconds) below which the execution chunks are not reported to the
726 simulation kernel (default value: 1e-6).
727
728
729 \note
730     The option smpi/cpu_threshold ignores any computation time spent
731     below this threshold. SMPI does not consider the \a amount of these
732     computations; there is no offset for this. Hence, by using a
733     value that is too low, you may end up with unreliable simulation
734     results.
735
736  In some cases, however, one may wish to disable simulation of
737 application computation. This is the case when SMPI is used not to
738 simulate an MPI applications, but instead an MPI code that performs
739 "live replay" of another MPI app (e.g., ScalaTrace's replay tool,
740 various on-line simulators that run an app at scale). In this case the
741 computation of the replay/simulation logic should not be simulated by
742 SMPI. Instead, the replay tool or on-line simulator will issue
743 "computation events", which correspond to the actual MPI simulation
744 being replayed/simulated. At the moment, these computation events can
745 be simulated using SMPI by calling internal smpi_execute*() functions.
746
747 To disable the benchmarking/simulation of computation in the simulated
748 application, the variable \b
749 smpi/simulation_computation should be set to no
750
751 \subsection options_model_smpi_bw_factor smpi/bw_factor: Bandwidth factors
752
753 The possible throughput of network links is often dependent on the
754 message sizes, as protocols may adapt to different message sizes. With
755 this option, a series of message sizes and factors are given, helping
756 the simulation to be more realistic. For instance, the current
757 default value is
758
759 \verbatim
760 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
761 \endverbatim
762
763 So, messages with size 65472 and more will get a total of MAX_BANDWIDTH*0.940694,
764 messages of size 15424 to 65471 will get MAX_BANDWIDTH*0.697866 and so on.
765 Here, MAX_BANDWIDTH denotes the bandwidth of the link.
766
767 \note
768     The SimGrid-Team has developed a script to help you determine these
769     values. You can find more information and the download here:
770     1. http://simgrid.gforge.inria.fr/contrib/smpi-calibration-doc.html
771     2. http://simgrid.gforge.inria.fr/contrib/smpi-saturation-doc.html
772
773 \subsection options_smpi_timing smpi/display_timing: Reporting simulation time
774
775 \b Default: 0 (false)
776
777 Most of the time, you run MPI code through SMPI to compute the time it
778 would take to run it on a platform that you don't have. But since the
779 code is run through the \c smpirun script, you don't have any control
780 on the launcher code, making difficult to report the simulated time
781 when the simulation ends. If you set the \b smpi/display_timing item
782 to 1, \c smpirun will display this information when the simulation ends. \verbatim
783 Simulation time: 1e3 seconds.
784 \endverbatim
785
786 \subsection options_model_smpi_lat_factor smpi/lat_factor: Latency factors
787
788 The motivation and syntax for this option is identical to the motivation/syntax
789 of smpi/bw_factor, see \ref options_model_smpi_bw_factor for details.
790
791 There is an important difference, though: While smpi/bw_factor \a reduces the
792 actual bandwidth (i.e., values between 0 and 1 are valid), latency factors
793 increase the latency, i.e., values larger than or equal to 1 are valid here.
794
795 This is the default value:
796
797 \verbatim
798 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
799 \endverbatim
800
801 \note
802     The SimGrid-Team has developed a script to help you determine these
803     values. You can find more information and the download here:
804     1. http://simgrid.gforge.inria.fr/contrib/smpi-calibration-doc.html
805     2. http://simgrid.gforge.inria.fr/contrib/smpi-saturation-doc.html
806
807 \subsection options_smpi_global smpi/privatize_global_variables: Automatic privatization of global variables
808
809 MPI executables are meant to be executed in separated processes, but SMPI is
810 executed in only one process. Global variables from executables will be placed
811 in the same memory zone and shared between processes, causing hard to find bugs.
812 To avoid this, several options are possible :
813   - Manual edition of the code, for example to add __thread keyword before data
814   declaration, which allows the resulting code to work with SMPI, but only
815   if the thread factory (see \ref options_virt_factory) is used, as global
816   variables are then placed in the TLS (thread local storage) segment.
817   - Source-to-source transformation, to add a level of indirection
818   to the global variables. SMPI does this for F77 codes compiled with smpiff,
819   and used to provide coccinelle scripts for C codes, which are not functional anymore.
820   - Compilation pass, to have the compiler automatically put the data in
821   an adapted zone.
822   - Runtime automatic switching of the data segments. SMPI stores a copy of
823   each global data segment for each process, and at each context switch replaces
824   the actual data with its copy from the right process. This mechanism uses mmap,
825   and is for now limited to systems supporting this functionnality (all Linux
826   and some BSD should be compatible).
827   Another limitation is that SMPI only accounts for global variables defined in
828   the executable. If the processes use external global variables from dynamic
829   libraries, they won't be switched correctly. To avoid this, using static
830   linking is advised (but not with the simgrid library, to avoid replicating
831   its own global variables).
832
833   To use this runtime automatic switching, the variable \b smpi/privatize_global_variables
834   should be set to yes
835
836
837
838 \subsection options_model_smpi_detached Simulating MPI detached send
839
840 This threshold specifies the size in bytes under which the send will return
841 immediately. This is different from the threshold detailed in  \ref options_model_network_asyncsend
842 because the message is not effectively sent when the send is posted. SMPI still waits for the
843 correspondant receive to be posted to perform the communication operation. This threshold can be set
844 by changing the \b smpi/send_is_detached item. The default value is 65536.
845
846 \subsection options_model_smpi_collectives Simulating MPI collective algorithms
847
848 SMPI implements more than 100 different algorithms for MPI collective communication, to accurately
849 simulate the behavior of most of the existing MPI libraries. The \b smpi/coll_selector item can be used
850  to use the decision logic of either OpenMPI or MPICH libraries (values: ompi or mpich, by default SMPI
851 uses naive version of collective operations). Each collective operation can be manually selected with a
852 \b smpi/collective_name:algo_name. Available algorithms are listed in \ref SMPI_collective_algorithms .
853
854 \subsection options_model_smpi_iprobe smpi/iprobe: Inject constant times for calls to MPI_Iprobe
855
856 \b Default value: 0.0001
857
858 The behavior and motivation for this configuration option is identical with \a smpi/test, see
859 Section \ref options_model_smpi_test for details.
860
861 \subsection options_model_smpi_ois smpi/ois: Inject constant times for asynchronous send operations
862
863 This configuration option works exactly as \a smpi/os, see Section \ref options_model_smpi_os.
864 Of course, \a smpi/ois is used to account for MPI_Isend instead of MPI_Send.
865
866 \subsection options_model_smpi_os smpi/os: Inject constant times for send operations
867
868 In several network models such as LogP, send (MPI_Send, MPI_Isend) and receive (MPI_Recv)
869 operations incur costs (i.e., they consume CPU time). SMPI can factor these costs in as well, but the
870 user has to configure SMPI accordingly as these values may vary by machine.
871 This can be done by using smpi/os for MPI_Send operations; for MPI_Isend and
872 MPI_Recv, use \a smpi/ois and \a smpi/or, respectively. These work exactly as
873 \a smpi/ois.
874
875 \a smpi/os can consist of multiple sections; each section takes three values, for example:
876
877 \verbatim
878     1:3:2;10:5:1
879 \endverbatim
880
881 Here, the sections are divided by ";" (that is, this example contains two sections).
882 Furthermore, each section consists of three values.
883
884 1. The first value denotes the minimum size for this section to take effect;
885    read it as "if message size is greater than this value (and other section has a larger
886    first value that is also smaller than the message size), use this".
887    In the first section above, this value is "1".
888
889 2. The second value is the startup time; this is a constant value that will always
890    be charged, no matter what the size of the message. In the first section above,
891    this value is "3".
892
893 3. The third value is the \a per-byte cost. That is, it is charged for every
894    byte of the message (incurring cost messageSize*cost_per_byte)
895    and hence accounts also for larger messages. In the first
896    section of the example above, this value is "2".
897
898 Now, SMPI always checks which section it should take for a given message; that is,
899 if a message of size 11 is sent with the configuration of the example above, only
900 the second section will be used, not the first, as the first value of the second
901 section is closer to the message size. Hence, a message of size 11 incurs the
902 following cost inside MPI_Send:
903
904 \verbatim
905     5+11*1
906 \endverbatim
907
908 %As 5 is the startup cost and 1 is the cost per byte.
909
910 \note
911     The order of sections can be arbitrary; they will be ordered internally.
912
913 \subsection options_model_smpi_or smpi/or: Inject constant times for receive operations
914
915 This configuration option works exactly as \a smpi/os, see Section \ref options_model_smpi_os.
916 Of course, \a smpi/or is used to account for MPI_Recv instead of MPI_Send.
917
918 \subsection options_model_smpi_test smpi/test: Inject constant times for calls to MPI_Test
919
920 \b Default value: 0.0001
921
922 By setting this option, you can control the amount of time a process sleeps
923 when MPI_Test() is called; this is important, because SimGrid normally only
924 advances the time while communication is happening and thus,
925 MPI_Test will not add to the time, resulting in a deadlock if used as a
926 break-condition.
927
928 Here is an example:
929
930 \code{.unparsed}
931     while(!flag) {
932         MPI_Test(request, flag, status);
933         ...
934     }
935 \endcode
936
937 \note
938     Internally, in order to speed up execution, we use a counter to keep track
939     on how often we already checked if the handle is now valid or not. Hence, we
940     actually use counter*SLEEP_TIME, that is, the time MPI_Test() causes the process
941     to sleep increases linearly with the number of previously failed testk.
942
943
944 \subsection options_model_smpi_use_shared_malloc smpi/use_shared_malloc: Use shared memory
945
946 \b Default: 1
947
948 SMPI can use shared memory by calling shm_* functions; this might speed up the simulation.
949 This opens or creates a new POSIX shared memory object, kept in RAM, in /dev/shm.
950
951 If you want to disable this behavior, set the value to 0.
952
953 \subsection options_model_smpi_wtime smpi/wtime: Inject constant times for calls to MPI_Wtime
954
955 \b Default value: 0
956
957 By setting this option, you can control the amount of time a process sleeps
958 when MPI_Wtime() is called; this is important, because SimGrid normally only
959 advances the time while communication is happening and thus,
960 MPI_Wtime will not add to the time, resulting in a deadlock if used as a
961 break-condition.
962
963 Here is an example:
964
965 \code{.unparsed}
966     while(MPI_Wtime() < some_time_bound) {
967         ...
968     }
969 \endcode
970
971 If the time is never advanced, this loop will clearly never end as MPI_Wtime()
972 always returns the same value. Hence, pass a (small) value to the smpi/wtime
973 option to force a call to MPI_Wtime to advance the time as well.
974
975
976 \section options_generic Configuring other aspects of SimGrid
977
978 \subsection options_generic_clean_atexit Cleanup before termination
979
980 The C / C++ standard contains a function called \b [atexit](http://www.cplusplus.com/reference/cstdlib/atexit/).
981 atexit registers callbacks, which are called just before the program terminates.
982
983 By setting the configuration option clean_atexit to 1 (true), a callback
984 is registered and will clean up some variables and terminate/cleanup the tracing.
985
986 TODO: Add when this should be used.
987
988 \subsection options_generic_path XML file inclusion path
989
990 It is possible to specify a list of directories to search into for the
991 \<include\> tag in XML files by using the \b path configuration
992 item. To add several directory to the path, set the configuration
993 item several times, as in \verbatim
994 --cfg=path:toto --cfg=path:tutu
995 \endverbatim
996
997 \subsection options_generic_exit Behavior on Ctrl-C
998
999 By default, when Ctrl-C is pressed, the status of all existing
1000 simulated processes is displayed before exiting the simulation. This is very useful to debug your
1001 code, but it can reveal troublesome in some cases (such as when the
1002 amount of processes becomes really big). This behavior is disabled
1003 when \b verbose-exit is set to 0 (it is to 1 by default).
1004
1005 \subsection options_exception_cutpath Truncate local path from exception backtrace
1006
1007 <b>This configuration option is an internal option and should normally not be used
1008 by the user.</b> It is used to remove the path from the backtrace
1009 shown when an exception is thrown; if we didn't remove this part, the tests
1010 testing the exception parts of simgrid would fail on most machines, as we are
1011 currently comparing output. Clearly, the path used on different machines are almost
1012 guaranteed to be different and hence, the output would
1013 mismatch, causing the test to fail.
1014
1015 \section options_log Logging Configuration
1016
1017 It can be done by using XBT. Go to \ref XBT_log for more details.
1018
1019 \section options_perf Performance optimizations
1020
1021 \subsection options_perf_context Context factory
1022
1023 In order to achieve higher performance, you might want to use the raw
1024 context factory which avoids any system call when switching between
1025 tasks. If it is not possible you might use ucontext instead.
1026
1027 \subsection options_perf_guard_size Disabling stack guard pages
1028
1029 A stack guard page is usually used which prevents the stack from
1030 overflowing on other parts of the memory. However this might have a
1031 performance impact if a huge number of processes is created.  The
1032 option \b contexts:guard_size is the number of stack guard pages
1033 used. By setting it to 0, no guard pages will be used: in this case,
1034 you should avoid using small stacks (\b stack_size) as the stack will
1035 silently overflow on other parts of the memory.
1036
1037 \section options_index Index of all existing configuration options
1038
1039 \note
1040   Almost all options are defined in <i>src/simgrid/sg_config.c</i>. You may
1041   want to check this file, too, but this index should be somewhat complete
1042   for the moment (May 2015).
1043
1044 \note
1045   \b Please \b note: You can also pass the command-line option "--help" and
1046      "--help-cfg" to an executable that uses simgrid.
1047
1048 - \c clean_atexit: \ref options_generic_clean_atexit
1049
1050 - \c contexts/factory: \ref options_virt_factory
1051 - \c contexts/guard_size: \ref options_virt_parallel
1052 - \c contexts/nthreads: \ref options_virt_parallel
1053 - \c contexts/parallel_threshold: \ref options_virt_parallel
1054 - \c contexts/stack_size: \ref options_virt_stacksize
1055 - \c contexts/synchro: \ref options_virt_parallel
1056
1057 - \c cpu/maxmin_selective_update: \ref options_model_optim
1058 - \c cpu/model: \ref options_model_select
1059 - \c cpu/optim: \ref options_model_optim
1060
1061 - \c exception/cutpath: \ref options_exception_cutpath
1062
1063 - \c host/model: \ref options_model_select
1064
1065 - \c maxmin/precision: \ref options_model_precision
1066
1067 - \c msg/debug_multiple_use: \ref options_msg_debug_multiple_use
1068
1069 - \c model-check: \ref options_modelchecking
1070 - \c model-check/checkpoint: \ref options_modelchecking_steps
1071 - \c model-check/communications_determinism: \ref options_modelchecking_comm_determinism
1072 - \c model-check/send_determinism: \ref options_modelchecking_comm_determinism
1073 - \c model-check/dot_output: \ref options_modelchecking_dot_output
1074 - \c model-check/hash: \ref options_modelchecking_hash
1075 - \c model-check/property: \ref options_modelchecking_liveness
1076 - \c model-check/max_depth: \ref options_modelchecking_max_depth
1077 - \c model-check/record: \ref options_modelchecking_recordreplay
1078 - \c model-check/reduction: \ref options_modelchecking_reduction
1079 - \c model-check/replay: \ref options_modelchecking_recordreplay
1080 - \c model-check/send_determinism: \ref options_modelchecking_sparse_checkpoint
1081 - \c model-check/sparse-checkpoint: \ref options_modelchecking_sparse_checkpoint
1082 - \c model-check/termination: \ref options_modelchecking_termination
1083 - \c model-check/timeout: \ref options_modelchecking_timeout
1084 - \c model-check/visited: \ref options_modelchecking_visited
1085
1086 - \c network/bandwidth_factor: \ref options_model_network_coefs
1087 - \c network/coordinates: \ref options_model_network_coord
1088 - \c network/crosstraffic: \ref options_model_network_crosstraffic
1089 - \c network/latency_factor: \ref options_model_network_coefs
1090 - \c network/maxmin_selective_update: \ref options_model_optim
1091 - \c network/model: \ref options_model_select
1092 - \c network/optim: \ref options_model_optim
1093 - \c network/sender_gap: \ref options_model_network_sendergap
1094 - \c network/TCP_gamma: \ref options_model_network_gamma
1095 - \c network/weight_S: \ref options_model_network_coefs
1096
1097 - \c ns3/TcpModel: \ref options_pls
1098 - \c path: \ref options_generic_path
1099 - \c plugin: \ref options_generic_plugin
1100
1101 - \c surf/nthreads: \ref options_model_nthreads
1102 - \c surf/precision: \ref options_model_precision
1103
1104 - \c <b>For collective operations of SMPI, please refer to Section \ref options_index_smpi_coll</b>
1105 - \c smpi/async_small_thres: \ref options_model_network_asyncsend
1106 - \c smpi/bw_factor: \ref options_model_smpi_bw_factor
1107 - \c smpi/coll_selector: \ref options_model_smpi_collectives
1108 - \c smpi/cpu_threshold: \ref options_smpi_bench
1109 - \c smpi/display_timing: \ref options_smpi_timing
1110 - \c smpi/lat_factor: \ref options_model_smpi_lat_factor
1111 - \c smpi/IB_penalty_factors: \ref options_model_network_coefs
1112 - \c smpi/iprobe: \ref options_model_smpi_iprobe
1113 - \c smpi/ois: \ref options_model_smpi_ois
1114 - \c smpi/or: \ref options_model_smpi_or
1115 - \c smpi/os: \ref options_model_smpi_os
1116 - \c smpi/privatize_global_variables: \ref options_smpi_global
1117 - \c smpi/running_power: \ref options_smpi_bench
1118 - \c smpi/send_is_detached_thresh: \ref options_model_smpi_detached
1119 - \c smpi/simulation_computation: \ref options_smpi_bench
1120 - \c smpi/test: \ref options_model_smpi_test
1121 - \c smpi/use_shared_malloc: \ref options_model_smpi_use_shared_malloc
1122 - \c smpi/wtime: \ref options_model_smpi_wtime
1123
1124 - \c <b>Tracing configuration options can be found in Section \ref tracing_tracing_options</b>.
1125
1126 - \c storage/model: \ref options_storage_model
1127 - \c verbose-exit: \ref options_generic_exit
1128
1129 - \c vm/model: \ref options_vm_model
1130
1131 \subsection options_index_smpi_coll Index of SMPI collective algorithms options
1132
1133 TODO: All available collective algorithms will be made available via the ``smpirun --help-coll`` command.
1134
1135 */