Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix some borken links in doc
[simgrid.git] / docs / source / scenar_config.rst
1 .. _options:
2
3 Configuring SimGrid
4 ===================
5
6 .. raw:: html
7
8    <object id="TOC" data="graphical-toc.svg" width="100%" type="image/svg+xml"></object>
9    <script>
10    window.onload=function() { // Wait for the SVG to be loaded before changing it
11      var elem=document.querySelector("#TOC").contentDocument.getElementById("ConfigBox")
12      elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1";
13    }
14    </script>
15    <br/>
16    <br/>
17
18 A number of options can be given at runtime to change the default
19 SimGrid behavior. For a complete list of all configuration options
20 accepted by the SimGrid version used in your simulator, simply pass
21 the --help configuration flag to your program. If some of the options
22 are not documented on this page, this is a bug that you should please
23 report so that we can fix it. Note that some of the options presented
24 here may not be available in your simulators, depending on the
25 :ref:`compile-time options <install_src_config>` that you used.
26
27 Setting Configuration Items
28 ---------------------------
29
30 There is several way to pass configuration options to the simulators.
31 The most common way is to use the ``--cfg`` command line argument. For
32 example, to set the item ``Item`` to the value ``Value``, simply
33 type the following on the command-line:
34
35 .. code-block:: shell
36                 
37    my_simulator --cfg=Item:Value (other arguments)
38
39 Several ``--cfg`` command line arguments can naturally be used. If you
40 need to include spaces in the argument, don't forget to quote the
41 argument. You can even escape the included quotes (write @' for ' if
42 you have your argument between ').
43
44 Another solution is to use the ``<config>`` tag in the platform file. The
45 only restriction is that this tag must occure before the first
46 platform element (be it ``<zone>``, ``<cluster>``, ``<peer>`` or whatever).
47 The ``<config>`` tag takes an ``id`` attribute, but it is currently
48 ignored so you don't really need to pass it. The important part is that
49 within that tag, you can pass one or several ``<prop>`` tags to specify
50 the configuration to use. For example, setting ``Item`` to ``Value``
51 can be done by adding the following to the beginning of your platform
52 file:
53
54 .. code-block:: xml
55                 
56   <config>
57     <prop id="Item" value="Value"/>
58   </config>
59
60 A last solution is to pass your configuration directly in your program
61 with :cpp:func:`simgrid::s4u::Engine::set_config` or :cpp:func:`MSG_config`.
62
63 .. code-block:: cpp
64                 
65    #include <simgrid/s4u.hpp>
66
67    int main(int argc, char *argv[]) {
68      simgrid::s4u::Engine e(&argc, argv);
69      
70      e->set_config("Item:Value");
71      
72      // Rest of your code
73    }
74
75 Existing Configuration Items
76 ----------------------------
77
78 .. note::
79   The full list can be retrieved by passing ``--help`` and
80   ``--help-cfg`` to an executable that uses SimGrid.
81
82 - **clean-atexit:** :ref:`cfg=clean-atexit`
83
84 - **contexts/factory:** :ref:`cfg=contexts/factory`
85 - **contexts/guard-size:** :ref:`cfg=contexts/guard-size`
86 - **contexts/nthreads:** :ref:`cfg=contexts/nthreads`
87 - **contexts/parallel-threshold:** :ref:`cfg=contexts/parallel-threshold`
88 - **contexts/stack-size:** :ref:`cfg=contexts/stack-size`
89 - **contexts/synchro:** :ref:`cfg=contexts/synchro`
90
91 - **cpu/maxmin-selective-update:** :ref:`Cpu Optimization Level <options_model_optim>`
92 - **cpu/model:** :ref:`options_model_select`
93 - **cpu/optim:** :ref:`Cpu Optimization Level <options_model_optim>`
94
95 - **exception/cutpath:** :ref:`cfg=exception/cutpath`
96
97 - **host/model:** :ref:`options_model_select`
98
99 - **maxmin/precision:** :ref:`cfg=maxmin/precision`
100 - **maxmin/concurrency-limit:** :ref:`cfg=maxmin/concurrency-limit`
101
102 - **msg/debug-multiple-use:** :ref:`cfg=msg/debug-multiple-use`
103
104 - **model-check:** :ref:`options_modelchecking`
105 - **model-check/checkpoint:** :ref:`cfg=model-check/checkpoint`
106 - **model-check/communications-determinism:** :ref:`cfg=model-check/communications-determinism`
107 - **model-check/dot-output:** :ref:`cfg=model-check/dot-output`
108 - **model-check/hash:** :ref:`cfg=model-checker/hash`
109 - **model-check/max-depth:** :ref:`cfg=model-check/max-depth`
110 - **model-check/property:** :ref:`cfg=model-check/property`
111 - **model-check/record:** :ref:`cfg=model-check/record`
112 - **model-check/reduction:** :ref:`cfg=model-check/reduction`
113 - **model-check/replay:** :ref:`cfg=model-check/replay`
114 - **model-check/send-determinism:** :ref:`cfg=model-check/send-determinism`
115 - **model-check/sparse-checkpoint:** :ref:`cfg=model-check/sparse-checkpoint`
116 - **model-check/termination:** :ref:`cfg=model-check/termination`
117 - **model-check/timeout:** :ref:`cfg=model-check/timeout`
118 - **model-check/visited:** :ref:`cfg=model-check/visited`
119
120 - **network/bandwidth-factor:** :ref:`cfg=network/bandwidth-factor`
121 - **network/crosstraffic:** :ref:`cfg=network/crosstraffic`
122 - **network/latency-factor:** :ref:`cfg=network/latency-factor`
123 - **network/maxmin-selective-update:** :ref:`Network Optimization Level <options_model_optim>`
124 - **network/model:** :ref:`options_model_select`
125 - **network/optim:** :ref:`Network Optimization Level <options_model_optim>`
126 - **network/TCP-gamma:** :ref:`cfg=network/TCP-gamma`
127 - **network/weight-S:** :ref:`cfg=network/weight-S`
128
129 - **ns3/TcpModel:** :ref:`options_pls`
130 - **path:** :ref:`cfg=path`
131 - **plugin:** :ref:`cfg=plugin`
132
133 - **simix/breakpoint:** :ref:`cfg=simix/breakpoint`
134
135 - **storage/max_file_descriptors:** :ref:`cfg=storage/max_file_descriptors`
136
137 - **surf/precision:** :ref:`cfg=surf/precision`
138
139 - **For collective operations of SMPI,** please refer to Section :ref:`options_index_smpi_coll`
140 - **smpi/async-small-thresh:** :ref:`cfg=smpi/async-small-thresh`
141 - **smpi/bw-factor:** :ref:`cfg=smpi/bw-factor`
142 - **smpi/coll-selector:** :ref:`cfg=smpi/coll-selector`
143 - **smpi/comp-adjustment-file:** :ref:`cfg=smpi/comp-adjustment-file`
144 - **smpi/cpu-threshold:** :ref:`cfg=smpi/cpu-threshold`
145 - **smpi/display-timing:** :ref:`cfg=smpi/display-timing`
146 - **smpi/grow-injected-times:** :ref:`cfg=smpi/grow-injected-times`
147 - **smpi/host-speed:** :ref:`cfg=smpi/host-speed`
148 - **smpi/IB-penalty-factors:** :ref:`cfg=smpi/IB-penalty-factors`
149 - **smpi/iprobe:** :ref:`cfg=smpi/iprobe`
150 - **smpi/iprobe-cpu-usage:** :ref:`cfg=smpi/iprobe-cpu-usage`
151 - **smpi/init:** :ref:`cfg=smpi/init`
152 - **smpi/keep-temps:** :ref:`cfg=smpi/keep-temps`
153 - **smpi/lat-factor:** :ref:`cfg=smpi/lat-factor`
154 - **smpi/ois:** :ref:`cfg=smpi/ois`
155 - **smpi/or:** :ref:`cfg=smpi/or`
156 - **smpi/os:** :ref:`cfg=smpi/os`
157 - **smpi/papi-events:** :ref:`cfg=smpi/papi-events`
158 - **smpi/privatization:** :ref:`cfg=smpi/privatization`
159 - **smpi/privatize-libs:** :ref:`cfg=smpi/privatize-libs`
160 - **smpi/send-is-detached-thresh:** :ref:`cfg=smpi/send-is-detached-thresh`
161 - **smpi/shared-malloc:** :ref:`cfg=smpi/shared-malloc`
162 - **smpi/shared-malloc-hugepage:** :ref:`cfg=smpi/shared-malloc-hugepage`
163 - **smpi/simulate-computation:** :ref:`cfg=smpi/simulate-computation`
164 - **smpi/test:** :ref:`cfg=smpi/test`
165 - **smpi/wtime:** :ref:`cfg=smpi/wtime`
166
167 - **Tracing configuration options** can be found in Section :ref:`tracing_tracing_options`
168
169 - **storage/model:** :ref:`options_model_select`
170 - **verbose-exit:** :ref:`cfg=verbose-exit`
171
172 - **vm/model:** :ref:`options_model_select`
173
174 .. _options_index_smpi_coll:
175
176 Index of SMPI collective algorithms options
177
178 .. TODO:: All available collective algorithms will be made available
179           via the ``smpirun --help-coll`` command.
180
181 .. _options_model:
182
183 Configuring the Platform Models
184 -------------------------------
185
186 .. _options_model_select:
187
188 Choosing the Platform Models
189 ............................
190
191 SimGrid comes with several network, CPU and storage models built in,
192 and you can change the used model at runtime by changing the passed
193 configuration. The three main configuration items are given below.
194 For each of these items, passing the special ``help`` value gives you
195 a short description of all possible values (for example,
196 ``--cfg=network/model:help`` will present all provided network
197 models). Also, ``--help-models`` should provide information about all
198 models for all existing resources.
199
200 - ``network/model``: specify the used network model. Possible values:
201   
202   - **LV08 (default one):** Realistic network analytic model
203     (slow-start modeled by multiplying latency by 13.01, bandwidth by
204     .97; bottleneck sharing uses a payload of S=20537 for evaluating
205     RTT). Described in `Accuracy Study and Improvement of Network
206     Simulation in the SimGrid Framework
207     <http://mescal.imag.fr/membres/arnaud.legrand/articles/simutools09.pdf>`_.     
208   - **Constant:** Simplistic network model where all communication
209     take a constant time (one second). This model provides the lowest
210     realism, but is (marginally) faster.
211   - **SMPI:** Realistic network model specifically tailored for HPC
212     settings (accurate modeling of slow start with correction factors on
213     three intervals: < 1KiB, < 64 KiB, >= 64 KiB). This model can be
214     :ref:`further configured <options_model_network>`.
215   - **IB:** Realistic network model specifically tailored for HPC
216     settings with InfiniBand networks (accurate modeling contention
217     behavior, based on the model explained in `this PhD work
218     <http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf>`_.
219     This model can be :ref:`further configured <options_model_network>`.
220   - **CM02:** Legacy network analytic model. Very similar to LV08, but
221     without corrective factors. The timings of small messages are thus
222     poorly modeled. This model is described in `A Network Model for
223     Simulation of Grid Application
224     <ftp://ftp.ens-lyon.fr/pub/LIP/Rapports/RR/RR2002/RR2002-40.ps.gz>`_.
225   - **Reno/Reno2/Vegas:** Models from Steven H. Low using lagrange_solve instead of
226     lmm_solve (experts only; check the code for more info).
227   - **NS3** (only available if you compiled SimGrid accordingly): 
228     Use the packet-level network
229     simulators as network models (see :ref:`pls_ns3`).
230     This model can be :ref:`further configured <options_pls>`.
231     
232 - ``cpu/model``: specify the used CPU model.  We have only one model
233   for now:
234
235   - **Cas01:** Simplistic CPU model (time=size/power)
236
237 - ``host/model``: The host concept is the aggregation of a CPU with a
238   network card. Three models exists, but actually, only 2 of them are
239   interesting. The "compound" one is simply due to the way our
240   internal code is organized, and can easily be ignored. So at the
241   end, you have two host models: The default one allows to aggregate
242   an existing CPU model with an existing network model, but does not
243   allow parallel tasks because these beasts need some collaboration
244   between the network and CPU model. That is why, ptask_07 is used by
245   default when using SimDag.
246   
247   - **default:** Default host model. Currently, CPU:Cas01 and
248     network:LV08 (with cross traffic enabled)
249   - **compound:** Host model that is automatically chosen if
250     you change the network and CPU models
251   - **ptask_L07:** Host model somehow similar to Cas01+CM02 but
252     allowing "parallel tasks", that are intended to model the moldable
253     tasks of the grid scheduling literature.
254
255 - ``storage/model``: specify the used storage model. Only one model is
256   provided so far.
257 - ``vm/model``: specify the model for virtual machines. Only one model
258   is provided so far.
259
260 .. todo: make 'compound' the default host model.
261
262 .. _options_model_optim:
263
264 Optimization Level
265 ..................
266
267 The network and CPU models that are based on lmm_solve (that
268 is, all our analytical models) accept specific optimization
269 configurations.
270
271   - items ``network/optim`` and ``cpu/optim`` (both default to 'Lazy'):
272     
273     - **Lazy:** Lazy action management (partial invalidation in lmm +
274       heap in action remaining).
275     - **TI:** Trace integration. Highly optimized mode when using
276       availability traces (only available for the Cas01 CPU model for
277       now).
278     - **Full:** Full update of remaining and variables. Slow but may be
279       useful when debugging.
280       
281   - items ``network/maxmin-selective-update`` and
282     ``cpu/maxmin-selective-update``: configure whether the underlying
283     should be lazily updated or not. It should have no impact on the
284     computed timings, but should speed up the computation. |br| It is
285     still possible to disable this feature because it can reveal
286     counter-productive in very specific scenarios where the
287     interaction level is high. In particular, if all your
288     communication share a given backbone link, you should disable it:
289     without it, a simple regular loop is used to update each
290     communication. With it, each of them is still updated (because of
291     the dependency induced by the backbone), but through a complicated
292     and slow pattern that follows the actual dependencies.
293
294 .. _cfg=maxmin/precision:
295 .. _cfg=surf/precision:
296
297 Numerical Precision
298 ...................
299
300 **Option** ``maxmin/precision`` **Default:** 0.00001 (in flops or bytes) |br|
301 **Option** ``surf/precision`` **Default:** 0.00001 (in seconds)
302
303 The analytical models handle a lot of floating point values. It is
304 possible to change the epsilon used to update and compare them through
305 this configuration item. Changing it may speedup the simulation by
306 discarding very small actions, at the price of a reduced numerical
307 precision. You can modify separately the precision used to manipulate
308 timings (in seconds) and the one used to manipulate amounts of work
309 (in flops or bytes).
310
311 .. _cfg=maxmin/concurrency-limit:
312
313 Concurrency Limit
314 .................
315
316 **Option** ``maxmin/concurrency-limit`` **Default:** -1 (no limit)
317
318 The maximum number of variables per resource can be tuned through this
319 option. You can have as many simultaneous actions per resources as you
320 want. If your simulation presents a very high level of concurrency, it
321 may help to use e.g. 100 as a value here. It means that at most 100
322 actions can consume a resource at a given time. The extraneous actions
323 are queued and wait until the amount of concurrency of the considered
324 resource lowers under the given boundary.
325
326 Such limitations help both to the simulation speed and simulation accuracy
327 on highly constrained scenarios, but the simulation speed suffers of this
328 setting on regular (less constrained) scenarios so it is off by default.
329
330 .. _options_model_network:
331
332 Configuring the Network Model
333 .............................
334
335 .. _cfg=network/TCP-gamma:
336
337 Maximal TCP Window Size
338 ^^^^^^^^^^^^^^^^^^^^^^^
339
340 **Option** ``network/TCP-gamma`` **Default:** 4194304
341
342 The analytical models need to know the maximal TCP window size to take
343 the TCP congestion mechanism into account.  On Linux, this value can
344 be retrieved using the following commands. Both give a set of values,
345 and you should use the last one, which is the maximal size.
346
347 .. code-block:: shell
348                 
349    cat /proc/sys/net/ipv4/tcp_rmem # gives the sender window
350    cat /proc/sys/net/ipv4/tcp_wmem # gives the receiver window
351
352 .. _cfg=smpi/IB-penalty-factors:
353 .. _cfg=network/bandwidth-factor:
354 .. _cfg=network/latency-factor:
355 .. _cfg=network/weight-S:
356    
357 Correcting Important Network Parameters
358 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
359
360 SimGrid can take network irregularities such as a slow startup or
361 changing behavior depending on the message size into account.  You
362 should not change these values unless you really know what you're
363 doing.  The corresponding values were computed through data fitting
364 one the timings of packet-level simulators, as described in `Accuracy
365 Study and Improvement of Network Simulation in the SimGrid Framework
366 <http://mescal.imag.fr/membres/arnaud.legrand/articles/simutools09.pdf>`_.
367
368
369 If you are using the SMPI model, these correction coefficients are
370 themselves corrected by constant values depending on the size of the
371 exchange.  By default SMPI uses factors computed on the Stampede
372 Supercomputer at TACC, with optimal deployment of processes on
373 nodes. Again, only hardcore experts should bother about this fact.
374
375 InfiniBand network behavior can be modeled through 3 parameters
376 ``smpi/IB-penalty-factors:"βe;βs;γs"``, as explained in `this PhD
377 thesis
378 <http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf>`_.
379
380 .. todo:: This section should be rewritten, and actually explain the
381           options network/bandwidth-factor, network/latency-factor,
382           network/weight-S.
383
384 .. _cfg=network/crosstraffic:
385
386 Simulating Cross-Traffic
387 ^^^^^^^^^^^^^^^^^^^^^^^^
388
389 Since SimGrid v3.7, cross-traffic effects can be taken into account in
390 analytical simulations. It means that ongoing and incoming
391 communication flows are treated independently. In addition, the LV08
392 model adds 0.05 of usage on the opposite direction for each new
393 created flow. This can be useful to simulate some important TCP
394 phenomena such as ack compression.
395
396 For that to work, your platform must have two links for each
397 pair of interconnected hosts. An example of usable platform is
398 available in ``examples/platforms/crosstraffic.xml``.
399
400 This is activated through the ``network/crosstraffic`` item, that
401 can be set to 0 (disable this feature) or 1 (enable it).
402
403 Note that with the default host model this option is activated by default.
404
405 .. _cfg=smpi/async-small-thresh:
406
407 Simulating Asyncronous Send
408 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
409
410 (this configuration item is experimental and may change or disapear)
411
412 It is possible to specify that messages below a certain size will be
413 sent as soon as the call to MPI_Send is issued, without waiting for
414 the correspondant receive. This threshold can be configured through
415 the ``smpi/async-small-thresh`` item. The default value is 0. This
416 behavior can also be manually set for mailboxes, by setting the
417 receiving mode of the mailbox with a call to
418 :cpp:func:`MSG_mailbox_set_async`. After this, all messages sent to
419 this mailbox will have this behavior regardless of the message size.
420
421 This value needs to be smaller than or equals to the threshold set at
422 @ref options_model_smpi_detached , because asynchronous messages are
423 meant to be detached as well.
424
425 .. _options_pls:
426
427 Configuring NS3
428 ^^^^^^^^^^^^^^^
429
430 **Option** ``ns3/TcpModel`` **Default:** "default" (NS3 default)
431
432 When using NS3, there is an extra item ``ns3/TcpModel``, corresponding
433 to the ``ns3::TcpL4Protocol::SocketType`` configuration item in
434 NS3. The only valid values (enforced on the SimGrid side) are
435 'default' (no change to the NS3 configuration), 'NewReno' or 'Reno' or
436 'Tahoe'.
437
438 Configuring the Storage model
439 .............................
440
441 .. _cfg=storage/max_file_descriptors:
442
443 File Descriptor Cound per Host
444 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
445
446 **Option** ``storage/max_file_descriptors`` **Default:** 1024
447
448 Each host maintains a fixed-size array of its file descriptors. You
449 can change its size through this item to either enlarge it if your
450 application requires it or to reduce it to save memory space.
451
452 .. _cfg=plugin:
453
454 Activating Plugins
455 ------------------
456
457 SimGrid plugins allow to extend the framework without changing its
458 source code directly. Read the source code of the existing plugins to
459 learn how to do so (in ``src/plugins``), and ask your questions to the
460 usual channels (Stack Overflow, Mailing list, IRC). The basic idea is
461 that plugins usually register callbacks to some signals of interest.
462 If they need to store some information about a given object (Link, CPU
463 or Actor), they do so through the use of a dedicated object extension.
464
465 Some of the existing plugins can be activated from the command line,
466 meaning that you can activate them from the command line without any
467 modification to your simulation code. For example, you can activate
468 the host energy plugin by adding ``--cfg=plugin:host_energy`` to your
469 command line.
470
471 Here is the full list of plugins that can be activated this way:
472
473  - **host_energy:** keeps track of the energy dissipated by
474    computations. More details in @ref plugin_energy.
475  - **link_energy:** keeps track of the energy dissipated by
476    communications. More details in @ref SURF_plugin_energy.
477  - **host_load:** keeps track of the computational load. 
478    More details in @ref plugin_load.
479
480 .. _options_modelchecking:
481    
482 Configuring the Model-Checking
483 ------------------------------
484
485 To enable the SimGrid model-checking support the program should
486 be executed using the simgrid-mc wrapper:
487
488 .. code-block:: shell
489                 
490    simgrid-mc ./my_program
491
492 Safety properties are expressed as assertions using the function
493 :cpp:func:`void MC_assert(int prop)`.
494
495 .. _cfg=model-check/property:
496      
497 Specifying a liveness property
498 ..............................
499
500 **Option** ``model-check/property`` **Default:** unset
501
502 If you want to specify liveness properties, you have to pass them on
503 the command line, specifying the name of the file containing the
504 property, as formatted by the ltl2ba program.
505
506
507 .. code-block:: shell
508                 
509    simgrid-mc ./my_program --cfg=model-check/property:<filename>
510
511 .. _cfg=model-check/checkpoint:
512    
513 Going for Stateful Verification
514 ...............................
515
516 By default, the system is backtracked to its initial state to explore
517 another path instead of backtracking to the exact step before the fork
518 that we want to explore (this is called stateless verification). This
519 is done this way because saving intermediate states can rapidly
520 exhaust the available memory. If you want, you can change the value of
521 the ``model-check/checkpoint`` item. For example,
522 ``--cfg=model-check/checkpoint:1`` asks to take a checkpoint every
523 step.  Beware, this will certainly explode your memory. Larger values
524 are probably better, make sure to experiment a bit to find the right
525 setting for your specific system.
526
527 .. _cfg=model-check/reduction:
528
529 Specifying the kind of reduction
530 ................................
531
532 The main issue when using the model-checking is the state space
533 explosion. To counter that problem, you can chose a exploration
534 reduction techniques with
535 ``--cfg=model-check/reduction:<technique>``. For now, this
536 configuration variable can take 2 values:
537
538  - **none:** Do not apply any kind of reduction (mandatory for now for
539    liveness properties)
540  - **dpor:** Apply Dynamic Partial Ordering Reduction. Only valid if
541    you verify local safety properties (default value for safety
542    checks).
543
544 There is unfortunately no silver bullet here, and the most efficient
545 reduction techniques cannot be applied to any properties. In
546 particular, the DPOR method cannot be applied on liveness properties
547 since our implementation of DPOR may break some cycles, while cycles
548 are very important to the soundness of the exploration for liveness
549 properties.
550
551 .. _cfg=model-check/visited:
552
553 Size of Cycle Detection Set
554 ...........................
555
556 In order to detect cycles, the model-checker needs to check if a new
557 explored state is in fact the same state than a previous one. For
558 that, the model-checker can take a snapshot of each visited state:
559 this snapshot is then used to compare it with subsequent states in the
560 exploration graph.
561
562 The ``model-check/visited`` item is the maximum number of states which
563 are stored in memory. If the maximum number of snapshotted state is
564 reached, some states will be removed from the memory and some cycles
565 might be missed. Small values can lead to incorrect verifications, but
566 large value can exhaust your memory, so choose carefully.
567
568 By default, no state is snapshotted and cycles cannot be detected.
569
570 .. _cfg=model-check/termination:
571
572 Non-Termination Detection
573 .........................
574
575 The ``model-check/termination`` configuration item can be used to
576 report if a non-termination execution path has been found. This is a
577 path with a cycle which means that the program might never terminate.
578
579 This only works in safety mode, not in liveness mode.
580
581 This options is disabled by default.
582
583 .. _cfg=model-check/dot-output:
584
585 Dot Output
586 ..........
587
588 If set, the ``model-check/dot-output`` configuration item is the name
589 of a file in which to write a dot file of the path leading the found
590 property (safety or liveness violation) as well as the cycle for
591 liveness properties. This dot file can then fed to the graphviz dot
592 tool to generate an corresponding graphical representation.
593
594 .. _cfg=model-check/max-depth:
595
596 Exploration Depth Limit
597 .......................
598
599 The ``model-checker/max-depth`` can set the maximum depth of the
600 exploration graph of the model-checker. If this limit is reached, a
601 logging message is sent and the results might not be exact.
602
603 By default, there is not depth limit.
604
605 .. _cfg=model-check/timeout:
606
607 Handling of Timeouts
608 ....................
609
610 By default, the model-checker does not handle timeout conditions: the `wait`
611 operations never time out. With the ``model-check/timeout`` configuration item
612 set to **yes**, the model-checker will explore timeouts of `wait` operations.
613
614 .. _cfg=model-check/communications-determinism:
615 .. _cfg=model-check/send-determinism:
616
617 Communication Determinism
618 .........................
619
620 The ``model-check/communications-determinism`` and
621 ``model-check/send-determinism`` items can be used to select the
622 communication determinism mode of the model-checker which checks
623 determinism properties of the communications of an application.
624
625 .. _cfg=model-check/sparse-checkpoint:
626
627 Incremental Checkpoints
628 .......................
629
630 When the model-checker is configured to take a snapshot of each
631 explored state (with the ``model-checker/visited`` item), the memory
632 consumption can rapidly reach GiB ou Tib of memory. However, for many
633 workloads, the memory does not change much between different snapshots
634 and taking a complete copy of each snapshot is a waste of memory.
635
636 The ``model-check/sparse-checkpoint`` option item can be set to
637 **yes** to avoid making a complete copy of each snapshot. Instead,
638 each snapshot will be decomposed in blocks which will be stored
639 separately.  If multiple snapshots share the same block (or if the
640 same block is used in the same snapshot), the same copy of the block
641 will be shared leading to a reduction of the memory footprint.
642
643 For many applications, this option considerably reduces the memory
644 consumption.  In somes cases, the model-checker might be slightly
645 slower because of the time taken to manage the metadata about the
646 blocks. In other cases however, this snapshotting strategy will be
647 much faster by reducing the cache consumption.  When the memory
648 consumption is important, by avoiding to hit the swap or reducing the
649 swap usage, this option might be much faster than the basic
650 snapshotting strategy.
651
652 This option is currently disabled by default.
653
654 Verification Performance Considerations
655 .......................................
656
657 The size of the stacks can have a huge impact on the memory
658 consumption when using model-checking. By default, each snapshot will
659 save a copy of the whole stacks and not only of the part which is
660 really meaningful: you should expect the contribution of the memory
661 consumption of the snapshots to be @f$ @mbox{number of processes}
662 @times @mbox{stack size} @times @mbox{number of states} @f$.
663
664 The ``model-check/sparse-checkpoint`` can be used to reduce the memory
665 consumption by trying to share memory between the different snapshots.
666
667 When compiled against the model checker, the stacks are not
668 protected with guards: if the stack size is too small for your
669 application, the stack will silently overflow on other parts of the
670 memory (see :ref:`contexts/guard-size <cfg=contexts/guard-size>`).
671
672 .. _cfg=model-checker/hash:
673
674 State Hashing
675 .............
676
677 Usually most of the time of the model-checker is spent comparing states. This
678 process is complicated and consumes a lot of bandwidth and cache.
679 In order to speedup the state comparison, the experimental ``model-checker/hash``
680 configuration item enables the computation of a hash summarizing as much
681 information of the state as possible into a single value. This hash can be used
682 to avoid most of the comparisons: the costly comparison is then only used when
683 the hashes are identical.
684
685 Currently most of the state is not included in the hash because the
686 implementation was found to be buggy and this options is not as useful as
687 it could be. For this reason, it is currently disabled by default.
688
689 .. _cfg=model-check/record:
690 .. _cfg=model-check/replay:
691
692 Record/Replay of Verification
693 .............................
694
695 As the model-checker keeps jumping at different places in the execution graph,
696 it is difficult to understand what happens when trying to debug an application
697 under the model-checker. Event the output of the program is difficult to
698 interpret. Moreover, the model-checker does not behave nicely with advanced
699 debugging tools such as valgrind. For those reason, to identify a trajectory
700 in the execution graph with the model-checker and replay this trajcetory and
701 without the model-checker black-magic but with more standard tools
702 (such as a debugger, valgrind, etc.). For this reason, Simgrid implements an
703 experimental record/replay functionnality in order to record a trajectory with
704 the model-checker and replay it without the model-checker.
705
706 When the model-checker finds an interesting path in the application
707 execution graph (where a safety or liveness property is violated), it
708 can generate an identifier for this path. To enable this behavious the
709 ``model-check/record`` must be set to **yes**, which is not the case
710 by default.
711
712 Here is an example of output:
713
714 .. code-block:: shell
715
716    [  0.000000] (0:@) Check a safety property
717    [  0.000000] (0:@) **************************
718    [  0.000000] (0:@) *** PROPERTY NOT VALID ***
719    [  0.000000] (0:@) **************************
720    [  0.000000] (0:@) Counter-example execution trace:
721    [  0.000000] (0:@) Path = 1/3;1/4
722    [  0.000000] (0:@) [(1)Tremblay (app)] MC_RANDOM(3)
723    [  0.000000] (0:@) [(1)Tremblay (app)] MC_RANDOM(4)
724    [  0.000000] (0:@) Expanded states = 27
725    [  0.000000] (0:@) Visited states = 68
726    [  0.000000] (0:@) Executed transitions = 46
727
728 This path can then be replayed outside of the model-checker (and even
729 in non-MC build of simgrid) by setting the ``model-check/replay`` item
730 to the given path. The other options should be the same (but the
731 model-checker should be disabled).
732
733 The format and meaning of the path may change between different
734 releases so the same release of Simgrid should be used for the record
735 phase and the replay phase.
736
737 Configuring the User Code Virtualization
738 ----------------------------------------
739
740 .. _cfg=contexts/factory:
741
742 Selecting the Virtualization Factory
743 ....................................
744
745 **Option** contexts/factory **Default:** "raw"
746
747 In SimGrid, the user code is virtualized in a specific mechanism that
748 allows the simulation kernel to control its execution: when a user
749 process requires a blocking action (such as sending a message), it is
750 interrupted, and only gets released when the simulated clock reaches
751 the point where the blocking operation is done. This is explained
752 graphically in the `relevant tutorial, available online
753 <http://simgrid.gforge.inria.fr/tutorials/simgrid-simix-101.pdf>`_.
754
755 In SimGrid, the containers in which user processes are virtualized are
756 called contexts. Several context factory are provided, and you can
757 select the one you want to use with the ``contexts/factory``
758 configuration item. Some of the following may not exist on your
759 machine because of portability issues. In any case, the default one
760 should be the most effcient one (please report bugs if the
761 auto-detection fails for you). They are approximately sorted here from
762 the slowest to the most efficient:
763
764  - **thread:** very slow factory using full featured threads (either
765    pthreads or windows native threads). They are slow but very
766    standard. Some debuggers or profilers only work with this factory.
767  - **java:** Java applications are virtualized onto java threads (that
768    are regular pthreads registered to the JVM)
769  - **ucontext:** fast factory using System V contexts (Linux and FreeBSD only)
770  - **boost:** This uses the `context
771    implementation <http://www.boost.org/doc/libs/1_59_0/libs/context/doc/html/index.html>`_
772    of the boost library for a performance that is comparable to our
773    raw implementation.
774    |br| Install the relevant library (e.g. with the
775    libboost-contexts-dev package on Debian/Ubuntu) and recompile
776    SimGrid. 
777  - **raw:** amazingly fast factory using a context switching mechanism
778    of our own, directly implemented in assembly (only available for x86
779    and amd64 platforms for now) and without any unneeded system call.
780
781 The main reason to change this setting is when the debugging tools get
782 fooled by the optimized context factories. Threads are the most
783 debugging-friendly contextes, as they allow to set breakpoints
784 anywhere with gdb and visualize backtraces for all processes, in order
785 to debug concurrency issues. Valgrind is also more comfortable with
786 threads, but it should be usable with all factories (Exception: the
787 callgrind tool really dislikes raw and ucontext factories).
788
789 .. _cfg=contexts/stack-size:
790
791 Adapting the Stack Size
792 .......................
793
794 **Option** ``contexts/stack-size`` **Default:** 8192 KiB
795
796 Each virtualized used process is executed using a specific system
797 stack. The size of this stack has a huge impact on the simulation
798 scalability, but its default value is rather large. This is because
799 the error messages that you get when the stack size is too small are
800 rather disturbing: this leads to stack overflow (overwriting other
801 stacks), leading to segfaults with corrupted stack traces.
802
803 If you want to push the scalability limits of your code, you might
804 want to reduce the ``contexts/stack-size`` item. Its default value is
805 8192 (in KiB), while our Chord simulation works with stacks as small
806 as 16 KiB, for example. For the thread factory, the default value is
807 the one of the system but you can still change it with this parameter.
808
809 The operating system should only allocate memory for the pages of the
810 stack which are actually used and you might not need to use this in
811 most cases. However, this setting is very important when using the
812 model checker (see :ref:`options_mc_perf`).
813
814 .. _cfg=contexts/guard-size:
815
816 Disabling Stack Guard Pages
817 ...........................
818
819 **Option** ``contexts/guard-size`` **Default** 1 page in most case (0 pages on Windows or with MC)
820
821 A stack guard page is usually used which prevents the stack of a given
822 actor from overflowing on another stack. But the performance impact
823 may become prohibitive when the amount of actors increases.  The
824 option ``contexts/guard-size`` is the number of stack guard pages
825 used.  By setting it to 0, no guard pages will be used: in this case,
826 you should avoid using small stacks (with :ref:`contexts/stack-size
827 <cfg=contexts/stack-size>`) as the stack will silently overflow on
828 other parts of the memory.
829
830 When no stack guard page is created, stacks may then silently overflow
831 on other parts of the memory if their size is too small for the
832 application.
833
834 .. _cfg=contexts/nthreads:
835 .. _cfg=contexts/parallel-threshold:
836 .. _cfg=contexts/synchro:
837   
838 Running User Code in Parallel
839 .............................
840
841 Parallel execution of the user code is only considered stable in
842 SimGrid v3.7 and higher, and mostly for MSG simulations. SMPI
843 simulations may well fail in parallel mode. It is described in
844 `INRIA RR-7653 <http://hal.inria.fr/inria-00602216/>`_.
845
846 If you are using the **ucontext** or **raw** context factories, you can
847 request to execute the user code in parallel. Several threads are
848 launched, each of them handling as much user contexts at each run. To
849 actiave this, set the ``contexts/nthreads`` item to the amount of
850 cores that you have in your computer (or lower than 1 to have
851 the amount of cores auto-detected).
852
853 Even if you asked several worker threads using the previous option,
854 you can request to start the parallel execution (and pay the
855 associated synchronization costs) only if the potential parallelism is
856 large enough. For that, set the ``contexts/parallel-threshold``
857 item to the minimal amount of user contexts needed to start the
858 parallel execution. In any given simulation round, if that amount is
859 not reached, the contexts will be run sequentially directly by the
860 main thread (thus saving the synchronization costs). Note that this
861 option is mainly useful when the grain of the user code is very fine,
862 because our synchronization is now very efficient.
863
864 When parallel execution is activated, you can choose the
865 synchronization schema used with the ``contexts/synchro`` item,
866 which value is either:
867
868  - **futex:** ultra optimized synchronisation schema, based on futexes
869    (fast user-mode mutexes), and thus only available on Linux systems.
870    This is the default mode when available.
871  - **posix:** slow but portable synchronisation using only POSIX
872    primitives.
873  - **busy_wait:** not really a synchronisation: the worker threads
874    constantly request new contexts to execute. It should be the most
875    efficient synchronisation schema, but it loads all the cores of
876    your machine for no good reason. You probably prefer the other less
877    eager schemas.
878
879    
880 Configuring the Tracing
881 -----------------------
882
883 The :ref:`tracing subsystem <outcomes_vizu>` can be configured in
884 several different ways depending on the nature of the simulator (MSG,
885 SimDag, SMPI) and the kind of traces that need to be obtained. See the
886 :ref:`Tracing Configuration Options subsection
887 <tracing_tracing_options>` to get a detailed description of each
888 configuration option.
889
890 We detail here a simple way to get the traces working for you, even if
891 you never used the tracing API.
892
893
894 - Any SimGrid-based simulator (MSG, SimDag, SMPI, ...) and raw traces:
895
896   .. code-block:: shell
897
898      --cfg=tracing:yes --cfg=tracing/uncategorized:yes --cfg=triva/uncategorized:uncat.plist
899
900   The first parameter activates the tracing subsystem, the second
901   tells it to trace host and link utilization (without any
902   categorization) and the third creates a graph configuration file to
903   configure Triva when analysing the resulting trace file.
904
905 - MSG or SimDag-based simulator and categorized traces (you need to
906   declare categories and classify your tasks according to them) 
907
908   .. code-block:: shell
909
910      --cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=triva/categorized:cat.plist
911
912   The first parameter activates the tracing subsystem, the second
913   tells it to trace host and link categorized utilization and the
914   third creates a graph configuration file to configure Triva when
915   analysing the resulting trace file.
916
917 - SMPI simulator and traces for a space/time view:
918
919   .. code-block:: shell
920      
921      smpirun -trace ...
922
923   The `-trace` parameter for the smpirun script runs the simulation
924   with ``--cfg=tracing:yes --cfg=tracing/smpi:yes``. Check the
925   smpirun's `-help` parameter for additional tracing options.
926
927 Sometimes you might want to put additional information on the trace to
928 correctly identify them later, or to provide data that can be used to
929 reproduce an experiment. You have two ways to do that:
930
931 - Add a string on top of the trace file as comment:
932
933   .. code-block:: shell
934
935      --cfg=tracing/comment:my_simulation_identifier
936
937 - Add the contents of a textual file on top of the trace file as comment:
938
939   .. code-block:: shell
940                   
941      --cfg=tracing/comment-file:my_file_with_additional_information.txt
942
943 Please, use these two parameters (for comments) to make reproducible
944 simulations. For additional details about this and all tracing
945 options, check See the :ref:`tracing_tracing_options`.
946
947 Configuring MSG
948 ---------------
949
950 .. _cfg=msg/debug-multiple-use:
951
952 Debugging MSG Code
953 ..................
954
955 **Option** ``msg/debug-multiple-use`` **Default:** off
956
957 Sometimes your application may try to send a task that is still being
958 executed somewhere else, making it impossible to send this task. However,
959 for debugging purposes, one may want to know what the other host is/was
960 doing. This option shows a backtrace of the other process.
961
962 Configuring SMPI
963 ----------------
964
965 The SMPI interface provides several specific configuration items.
966 These are uneasy to see since the code is usually launched through the
967 ``smiprun`` script directly.
968
969 .. _cfg=smpi/host-speed:
970 .. _cfg=smpi/cpu-threshold:
971 .. _cfg=smpi/simulate-computation:
972
973 Automatic Benchmarking of SMPI Code
974 ...................................
975
976 In SMPI, the sequential code is automatically benchmarked, and these
977 computations are automatically reported to the simulator. That is to
978 say that if you have a large computation between a ``MPI_Recv()`` and
979 a ``MPI_Send()``, SMPI will automatically benchmark the duration of
980 this code, and create an execution task within the simulator to take
981 this into account. For that, the actual duration is measured on the
982 host machine and then scaled to the power of the corresponding
983 simulated machine. The variable ``smpi/host-speed`` allows to specify
984 the computational speed of the host machine (in flop/s) to use when
985 scaling the execution times. It defaults to 20000, but you really want
986 to update it to get accurate simulation results.
987
988 When the code is constituted of numerous consecutive MPI calls, the
989 previous mechanism feeds the simulation kernel with numerous tiny
990 computations. The ``smpi/cpu-threshold`` item becomes handy when this
991 impacts badly the simulation performance. It specifies a threshold (in
992 seconds) below which the execution chunks are not reported to the
993 simulation kernel (default value: 1e-6).
994
995 .. note:: The option ``smpi/cpu-threshold`` ignores any computation
996    time spent below this threshold. SMPI does not consider the
997    `amount` of these computations; there is no offset for this. Hence,
998    a value that is too small, may lead to unreliable simulation
999    results.
1000
1001 In some cases, however, one may wish to disable simulation of
1002 application computation. This is the case when SMPI is used not to
1003 simulate an MPI applications, but instead an MPI code that performs
1004 "live replay" of another MPI app (e.g., ScalaTrace's replay tool,
1005 various on-line simulators that run an app at scale). In this case the
1006 computation of the replay/simulation logic should not be simulated by
1007 SMPI. Instead, the replay tool or on-line simulator will issue
1008 "computation events", which correspond to the actual MPI simulation
1009 being replayed/simulated. At the moment, these computation events can
1010 be simulated using SMPI by calling internal smpi_execute*() functions.
1011
1012 To disable the benchmarking/simulation of computation in the simulated
1013 application, the variable ``smpi/simulate-computation`` should be set
1014 to no.  This option just ignores the timings in your simulation; it
1015 still executes the computations itself. If you want to stop SMPI from
1016 doing that, you should check the SMPI_SAMPLE macros, documented in 
1017 Section :ref:`SMPI_adapting_speed`.
1018
1019 +------------------------------------+-------------------------+-----------------------------+
1020 |  Solution                          | Computations executed?  | Computations simulated?     |
1021 +====================================+=========================+=============================+   
1022 | --cfg=smpi/simulate-computation:no | Yes                     | Never                       |
1023 +------------------------------------+-------------------------+-----------------------------+
1024 | --cfg=smpi/cpu-threshold:42        | Yes, in all cases       | If it lasts over 42 seconds |
1025 +------------------------------------+-------------------------+-----------------------------+
1026 | SMPI_SAMPLE() macro                | Only once per loop nest | Always                      |
1027 +------------------------------------+-------------------------+-----------------------------+
1028
1029 .. _cfg=smpi/comp-adjustment-file:
1030
1031 Slow-down or speed-up parts of your code
1032 ........................................
1033
1034 **Option** ``smpi/comp-adjustment-file:`` **Default:** unset
1035
1036 This option allows you to pass a file that contains two columns: The
1037 first column defines the section that will be subject to a speedup;
1038 the second column is the speedup. For instance:
1039
1040 .. code-block:: shell
1041
1042   "start:stop","ratio"
1043   "exchange_1.f:30:exchange_1.f:130",1.18244559422142
1044
1045 The first line is the header - you must include it.  The following
1046 line means that the code between two consecutive MPI calls on line 30
1047 in exchange_1.f and line 130 in exchange_1.f should receive a speedup
1048 of 1.18244559422142. The value for the second column is therefore a
1049 speedup, if it is larger than 1 and a slow-down if it is smaller
1050 than 1. Nothing will be changed if it is equal to 1.
1051
1052 Of course, you can set any arbitrary filenames you want (so the start
1053 and end don't have to be in the same file), but be aware that this
1054 mechanism only supports `consecutive calls!`
1055
1056 Please note that you must pass the ``-trace-call-location`` flag to
1057 smpicc or smpiff, respectively. This flag activates some internal
1058 macro definitions that help with obtaining the call location.
1059
1060 .. _cfg=smpi/bw-factor:
1061
1062 Bandwidth Factors
1063 .................
1064
1065 **Option** ``smpi/bw-factor``
1066 |br| **Default:** 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
1067
1068 The possible throughput of network links is often dependent on the
1069 message sizes, as protocols may adapt to different message sizes. With
1070 this option, a series of message sizes and factors are given, helping
1071 the simulation to be more realistic. For instance, the current default
1072 value means that messages with size 65472 and more will get a total of
1073 MAX_BANDWIDTH*0.940694, messages of size 15424 to 65471 will get
1074 MAX_BANDWIDTH*0.697866 and so on (where MAX_BANDWIDTH denotes the
1075 bandwidth of the link).
1076
1077 An experimental script to compute these factors is available online. See
1078 http://simgrid.gforge.inria.fr/contrib/smpi-calibration-doc.html
1079 http://simgrid.gforge.inria.fr/contrib/smpi-saturation-doc.html
1080
1081 .. _cfg=smpi/display-timing:
1082        
1083 Reporting Simulation Time
1084 .........................
1085
1086 **Option** ``smpi/display-timing`` **Default:** 0 (false)
1087
1088 Most of the time, you run MPI code with SMPI to compute the time it
1089 would take to run it on a platform. But since the code is run through
1090 the ``smpirun`` script, you don't have any control on the launcher
1091 code, making it difficult to report the simulated time when the
1092 simulation ends. If you enable the ``smpi/display-timing`` item,
1093 ``smpirun`` will display this information when the simulation
1094 ends.
1095
1096 .. _cfg=smpi/keep-temps:
1097
1098 Keeping temporary files after simulation
1099 ........................................
1100
1101 **Option** ``smpi/keep-temps`` **default:** 0 (false)
1102
1103 SMPI usually generates a lot of temporary files that are cleaned after
1104 use. This option request to preserve them, for example to debug or
1105 profile your code. Indeed, the binary files are removed very early
1106 under the dlopen privatization schema, which tend to fool the
1107 debuggers.
1108
1109 .. _cfg=smpi/lat-factor:
1110
1111 Latency factors
1112 ...............
1113
1114 **Option** ``smpi/lat-factor`` |br|
1115 **default:** 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
1116
1117 The motivation and syntax for this option is identical to the motivation/syntax
1118 of :ref:`cfg=smpi/bw-factor`.
1119
1120 There is an important difference, though: While smpi/bw-factor `reduces` the
1121 actual bandwidth (i.e., values between 0 and 1 are valid), latency factors
1122 increase the latency, i.e., values larger than or equal to 1 are valid here.
1123
1124 .. _cfg=smpi/papi-events:
1125        
1126 Trace hardware counters with PAPI
1127 .................................
1128
1129 **Option** ``smpi/papi-events`` **default:** unset
1130
1131 When the PAPI support was compiled in SimGrid, this option takes the
1132 names of PAPI counters and adds their respective values to the trace
1133 files (See Section :ref:`tracing_tracing_options`).
1134
1135 .. warning::
1136    
1137    This feature currently requires superuser privileges, as registers
1138    are queried.  Only use this feature with code you trust! Call
1139    smpirun for instance via ``smpirun -wrapper "sudo "
1140    <your-parameters>`` or run ``sudo sh -c "echo 0 >
1141    /proc/sys/kernel/perf_event_paranoid"`` In the later case, sudo
1142    will not be required.
1143
1144 It is planned to make this feature available on a per-process (or per-thread?) basis.
1145 The first draft, however, just implements a "global" (i.e., for all processes) set
1146 of counters, the "default" set.
1147
1148 .. code-block:: shell
1149
1150    --cfg=smpi/papi-events:"default:PAPI_L3_LDM:PAPI_L2_LDM"
1151
1152 .. _cfg=smpi/privatization:
1153
1154 Automatic Privatization of Global Variables
1155 ...........................................
1156
1157 **Option** ``smpi/privatization`` **default:** "dlopen" (when using smpirun)
1158
1159 MPI executables are usually meant to be executed in separated
1160 processes, but SMPI is executed in only one process. Global variables
1161 from executables will be placed in the same memory zone and shared
1162 between processes, causing intricate bugs.  Several options are
1163 possible to avoid this, as described in the main `SMPI publication
1164 <https://hal.inria.fr/hal-01415484>`_ and in the :ref:`SMPI
1165 documentation <SMPI_what_globals>`. SimGrid provides two ways of
1166 automatically privatizing the globals, and this option allows to
1167 choose between them.
1168
1169   - **no** (default when not using smpirun): Do not automatically
1170     privatize variables.  Pass ``-no-privatize`` to smpirun to disable
1171     this feature.
1172   - **dlopen** or **yes** (default when using smpirun): Link multiple
1173     times against the binary.
1174   - **mmap** (slower, but maybe somewhat more stable):
1175     Runtime automatic switching of the data segments.
1176
1177 .. warning::
1178    This configuration option cannot be set in your platform file. You can only
1179    pass it as an argument to smpirun.
1180
1181 .. _cfg=smpi/privatize-libs:
1182
1183 Automatic privatization of global variables inside external libraries
1184 .....................................................................
1185
1186 **Option** ``smpi/privatize-libs`` **default:** unset
1187
1188 **Linux/BSD only:** When using dlopen (default) privatization,
1189 privatize specific shared libraries with internal global variables, if
1190 they can't be linked statically.  For example libgfortran is usually
1191 used for Fortran I/O and indexes in files can be mixed up.
1192
1193 Multiple libraries can be given, semicolon separated.
1194
1195 This configuration option can only use either full paths to libraries,
1196 or full names.  Check with ldd the name of the library you want to
1197 use.  Example:
1198
1199 .. code-block:: shell
1200                   
1201    ldd allpairf90
1202       ...
1203       libgfortran.so.3 => /usr/lib/x86_64-linux-gnu/libgfortran.so.3 (0x00007fbb4d91b000)
1204       ...
1205
1206 Then you can use ``--cfg=smpi/privatize-libs:libgfortran.so.3``
1207 or ``--cfg=smpi/privatize-libs:/usr/lib/x86_64-linux-gnu/libgfortran.so.3``,
1208 but not ``libgfortran`` nor ``libgfortran.so``.
1209
1210 .. _cfg=smpi/send-is-detached-thresh:
1211
1212 Simulating MPI detached send
1213 ............................
1214
1215 **Option** ``smpi/send-is-detached-thresh`` **default:** 65536
1216
1217 This threshold specifies the size in bytes under which the send will
1218 return immediately. This is different from the threshold detailed in
1219 :ref:`options_model_network_asyncsend` because the message is not
1220 effectively sent when the send is posted. SMPI still waits for the
1221 correspondant receive to be posted to perform the communication
1222 operation.
1223
1224 .. _cfg=smpi/coll-selector:
1225
1226 Simulating MPI collective algorithms
1227 ....................................
1228
1229 **Option** ``smpi/coll-selector`` **Possible values:** naive (default), ompi, mpich
1230
1231 SMPI implements more than 100 different algorithms for MPI collective
1232 communication, to accurately simulate the behavior of most of the
1233 existing MPI libraries. The ``smpi/coll-selector`` item can be used to
1234 use the decision logic of either OpenMPI or MPICH libraries (by
1235 default SMPI uses naive version of collective operations).
1236
1237 Each collective operation can be manually selected with a
1238 ``smpi/collective_name:algo_name``. Available algorithms are listed in
1239 :ref:`SMPI_use_colls`.
1240
1241 .. _cfg=smpi/iprobe:
1242
1243 Inject constant times for MPI_Iprobe
1244 ....................................
1245
1246 **Option** ``smpi/iprobe`` **default:** 0.0001
1247
1248 The behavior and motivation for this configuration option is identical
1249 with :ref:`smpi/test <cfg=smpi/test>`, but for the function
1250 ``MPI_Iprobe()``
1251
1252 .. _cfg=smpi/iprobe-cpu-usage:
1253
1254 Reduce speed for iprobe calls
1255 .............................
1256
1257 **Option** ``smpi/iprobe-cpu-usage`` **default:** 1 (no change)
1258
1259 MPI_Iprobe calls can be heavily used in applications. To account
1260 correctly for the energy cores spend probing, it is necessary to
1261 reduce the load that these calls cause inside SimGrid.
1262
1263 For instance, we measured a max power consumption of 220 W for a
1264 particular application but only 180 W while this application was
1265 probing. Hence, the correct factor that should be passed to this
1266 option would be 180/220 = 0.81.
1267
1268 .. _cfg=smpi/init:
1269
1270 Inject constant times for MPI_Init
1271 ..................................
1272
1273 **Option** ``smpi/init`` **default:** 0
1274
1275 The behavior and motivation for this configuration option is identical
1276 with :ref:`smpi/test <cfg=smpi/test>`, but for the function ``MPI_Init()``.
1277
1278 .. _cfg=smpi/ois:
1279
1280 Inject constant times for MPI_Isend()
1281 .....................................
1282
1283 **Option** ``smpi/ois``
1284
1285 The behavior and motivation for this configuration option is identical
1286 with :ref:`smpi/os <cfg=smpi/os>`, but for the function ``MPI_Isend()``.
1287
1288 .. _cfg=smpi/os:
1289
1290 Inject constant times for MPI_send()
1291 ....................................
1292
1293 **Option** ``smpi/os``
1294
1295 In several network models such as LogP, send (MPI_Send, MPI_Isend) and
1296 receive (MPI_Recv) operations incur costs (i.e., they consume CPU
1297 time). SMPI can factor these costs in as well, but the user has to
1298 configure SMPI accordingly as these values may vary by machine.  This
1299 can be done by using ``smpi/os`` for MPI_Send operations; for MPI_Isend
1300 and MPI_Recv, use ``smpi/ois`` and ``smpi/or``, respectively. These work
1301 exactly as ``smpi/ois``.
1302
1303 This item can consist of multiple sections; each section takes three
1304 values, for example ``1:3:2;10:5:1``.  The sections are divided by ";"
1305 so this example contains two sections.  Furthermore, each section
1306 consists of three values.
1307
1308 1. The first value denotes the minimum size for this section to take effect;
1309    read it as "if message size is greater than this value (and other section has a larger
1310    first value that is also smaller than the message size), use this".
1311    In the first section above, this value is "1".
1312
1313 2. The second value is the startup time; this is a constant value that will always
1314    be charged, no matter what the size of the message. In the first section above,
1315    this value is "3".
1316
1317 3. The third value is the `per-byte` cost. That is, it is charged for every
1318    byte of the message (incurring cost messageSize*cost_per_byte)
1319    and hence accounts also for larger messages. In the first
1320    section of the example above, this value is "2".
1321
1322 Now, SMPI always checks which section it should take for a given
1323 message; that is, if a message of size 11 is sent with the
1324 configuration of the example above, only the second section will be
1325 used, not the first, as the first value of the second section is
1326 closer to the message size. Hence, when ``smpi/os=1:3:2;10:5:1``, a
1327 message of size 11 incurs the following cost inside MPI_Send:
1328 ``5+11*1`` because 5 is the startup cost and 1 is the cost per byte.
1329
1330 Note that the order of sections can be arbitrary; they will be ordered internally.
1331
1332 .. _cfg=smpi/or:
1333
1334 Inject constant times for MPI_Recv()
1335 ....................................
1336
1337 **Option** ``smpi/or``
1338
1339 The behavior and motivation for this configuration option is identical
1340 with :ref:`smpi/os <cfg=smpi/os>`, but for the function ``MPI_Recv()``.
1341
1342 .. _cfg=smpi/test:
1343 .. _cfg=smpi/grow-injected-times:
1344
1345 Inject constant times for MPI_Test
1346 ..................................
1347
1348 **Option** ``smpi/test`` **default:** 0.0001
1349
1350 By setting this option, you can control the amount of time a process
1351 sleeps when MPI_Test() is called; this is important, because SimGrid
1352 normally only advances the time while communication is happening and
1353 thus, MPI_Test will not add to the time, resulting in a deadlock if
1354 used as a break-condition as in the following example:
1355
1356 .. code-block:: cpp
1357
1358    while(!flag) {
1359        MPI_Test(request, flag, status);
1360        ...
1361    }
1362
1363 To speed up execution, we use a counter to keep track on how often we
1364 already checked if the handle is now valid or not. Hence, we actually
1365 use counter*SLEEP_TIME, that is, the time MPI_Test() causes the
1366 process to sleep increases linearly with the number of previously
1367 failed tests. This behavior can be disabled by setting
1368 ``smpi/grow-injected-times`` to **no**. This will also disable this
1369 behavior for MPI_Iprobe.
1370
1371 .. _cfg=smpi/shared-malloc:
1372 .. _cfg=smpi/shared-malloc-hugepage:
1373
1374 Factorize malloc()s
1375 ...................
1376
1377 **Option** ``smpi/shared-malloc`` **Possible values:** global (default), local
1378
1379 If your simulation consumes too much memory, you may want to modify
1380 your code so that the working areas are shared by all MPI ranks. For
1381 example, in a bloc-cyclic matrix multiplication, you will only
1382 allocate one set of blocs, and every processes will share them.
1383 Naturally, this will lead to very wrong results, but this will save a
1384 lot of memory so this is still desirable for some studies. For more on
1385 the motivation for that feature, please refer to the `relevant section
1386 <https://simgrid.github.io/SMPI_CourseWare/topic_understanding_performance/matrixmultiplication>`_
1387 of the SMPI CourseWare (see Activity #2.2 of the pointed
1388 assignment). In practice, change the call to malloc() and free() into
1389 SMPI_SHARED_MALLOC() and SMPI_SHARED_FREE().
1390
1391 SMPI provides two algorithms for this feature. The first one, called 
1392 ``local``, allocates one bloc per call to SMPI_SHARED_MALLOC() in your
1393 code (each call location gets its own bloc) and this bloc is shared
1394 amongst all MPI ranks.  This is implemented with the shm_* functions
1395 to create a new POSIX shared memory object (kept in RAM, in /dev/shm)
1396 for each shared bloc.
1397
1398 With the ``global`` algorithm, each call to SMPI_SHARED_MALLOC()
1399 returns a new adress, but it only points to a shadow bloc: its memory
1400 area is mapped on a 1MiB file on disk. If the returned bloc is of size
1401 N MiB, then the same file is mapped N times to cover the whole bloc.
1402 At the end, no matter how many SMPI_SHARED_MALLOC you do, this will
1403 only consume 1 MiB in memory.
1404
1405 You can disable this behavior and come back to regular mallocs (for
1406 example for debugging purposes) using @c "no" as a value.
1407
1408 If you want to keep private some parts of the buffer, for instance if these
1409 parts are used by the application logic and should not be corrupted, you
1410 can use SMPI_PARTIAL_SHARED_MALLOC(size, offsets, offsets_count). Example:
1411
1412 .. code-block:: cpp
1413
1414    mem = SMPI_PARTIAL_SHARED_MALLOC(500, {27,42 , 100,200}, 2);
1415
1416 This will allocate 500 bytes to mem, such that mem[27..41] and
1417 mem[100..199] are shared while other area remain private.
1418
1419 Then, it can be deallocated by calling SMPI_SHARED_FREE(mem).
1420
1421 When smpi/shared-malloc:global is used, the memory consumption problem
1422 is solved, but it may induce too much load on the kernel's pages table. 
1423 In this case, you should use huge pages so that we create only one
1424 entry per Mb of malloced data instead of one entry per 4k.
1425 To activate this, you must mount a hugetlbfs on your system and allocate
1426 at least one huge page:
1427
1428 .. code-block:: shell
1429                 
1430     mkdir /home/huge
1431     sudo mount none /home/huge -t hugetlbfs -o rw,mode=0777
1432     sudo sh -c 'echo 1 > /proc/sys/vm/nr_hugepages' # echo more if you need more
1433
1434 Then, you can pass the option
1435 ``--cfg=smpi/shared-malloc-hugepage:/home/huge`` to smpirun to
1436 actually activate the huge page support in shared mallocs.
1437
1438 .. _cfg=smpi/wtime:
1439
1440 Inject constant times for MPI_Wtime, gettimeofday and clock_gettime
1441 ...................................................................
1442
1443 **Option** ``smpi/wtime`` **default:** 10 ns
1444
1445 This option controls the amount of (simulated) time spent in calls to
1446 MPI_Wtime(), gettimeofday() and clock_gettime(). If you set this value
1447 to 0, the simulated clock is not advanced in these calls, which leads
1448 to issue if your application contains such a loop:
1449
1450 .. code-block:: cpp
1451                 
1452    while(MPI_Wtime() < some_time_bound) {
1453         /* some tests, with no communication nor computation */
1454    }
1455
1456 When the option smpi/wtime is set to 0, the time advances only on
1457 communications and computations, so the previous code results in an
1458 infinite loop: the current [simulated] time will never reach
1459 ``some_time_bound``.  This infinite loop is avoided when that option
1460 is set to a small amount, as it is by default since SimGrid v3.21.
1461
1462 Note that if your application does not contain any loop depending on
1463 the current time only, then setting this option to a non-zero value
1464 will slow down your simulations by a tiny bit: the simulation loop has
1465 to be broken and reset each time your code ask for the current time.
1466 If the simulation speed really matters to you, you can avoid this
1467 extra delay by setting smpi/wtime to 0.
1468
1469 Other Configurations
1470 --------------------
1471
1472 .. _cfg=clean-atexit:
1473
1474 Cleanup at Termination
1475 ......................
1476
1477 **Option** ``clean-atexit`` **default:** on
1478
1479 If your code is segfaulting during its finalization, it may help to
1480 disable this option to request SimGrid to not attempt any cleanups at
1481 the end of the simulation. Since the Unix process is ending anyway,
1482 the operating system will wipe it all.
1483
1484 .. _cfg=path:
1485
1486 Search Path
1487 ...........
1488
1489 **Option** ``path`` **default:** . (current dir)
1490
1491 It is possible to specify a list of directories to search into for the
1492 trace files (see :ref:`pf_trace`) by using this configuration
1493 item. To add several directory to the path, set the configuration
1494 item several times, as in ``--cfg=path:toto --cfg=path:tutu``
1495
1496 .. _cfg=simix/breakpoint:
1497
1498 Set a Breakpoint
1499 ................
1500
1501 **Option** ``simix/breakpoint`` **default:** unset
1502
1503 This configuration option sets a breakpoint: when the simulated clock
1504 reaches the given time, a SIGTRAP is raised.  This can be used to stop
1505 the execution and get a backtrace with a debugger.
1506
1507 It is also possible to set the breakpoint from inside the debugger, by
1508 writing in global variable simgrid::simix::breakpoint. For example,
1509 with gdb:
1510
1511 .. code-block:: shell
1512
1513    set variable simgrid::simix::breakpoint = 3.1416
1514
1515 .. _cfg=verbose-exit:
1516    
1517 Behavior on Ctrl-C
1518 ..................
1519
1520 **Option** ``verbose-exit`` **default:** on
1521
1522 By default, when Ctrl-C is pressed, the status of all existing actors
1523 is displayed before exiting the simulation. This is very useful to
1524 debug your code, but it can reveal troublesome if you have many
1525 actors. Set this configuration item to **off** to disable this
1526 feature.
1527
1528 .. _cfg=exception/cutpath:
1529
1530 Truncate local path from exception backtrace
1531 ............................................
1532
1533 **Option** ``exception/cutpath`` **default:** off
1534
1535 This configuration option is used to remove the path from the
1536 backtrace shown when an exception is thrown. This is mainly useful for
1537 the tests: the full file path makes the tests not reproducible because
1538 the path of source files depend of the build settings. That would
1539 break most of our tests as we keep comparing output.
1540
1541 Logging Configuration
1542 ---------------------
1543
1544 It can be done by using XBT. Go to :ref:`XBT_log` for more details.
1545
1546 .. |br| raw:: html
1547
1548    <br />