X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7934c813955d740eba16fc20f0c3f6505e9d4776..ba5400c9278f4f61cf8319210a5edda78e0c5bd8:/doc/doxygen/options.doc diff --git a/doc/doxygen/options.doc b/doc/doxygen/options.doc index 9b566d7d19..89af6768d3 100644 --- a/doc/doxygen/options.doc +++ b/doc/doxygen/options.doc @@ -65,7 +65,7 @@ int main(int argc, char *argv[]) { \section options_model Configuring the platform models \anchor options_storage_model -\anchor options_vm_workstation_model +\anchor options_vm_model \subsection options_model_select Selecting the platform models SimGrid comes with several network, CPU and storage models built in, and you @@ -76,9 +76,9 @@ you a short description of all possible values. Also, \c --help-models should provide information about all models for all existing resources. - \b network/model: specify the used network model - \b cpu/model: specify the used CPU model - - \b workstation/model: specify the used workstation model + - \b host/model: specify the used host model - \b storage/model: specify the used storage model (there is currently only one such model - this option is hence only useful for future releases) - - \b vm_workstation/model: specify the workstation model for virtual machines (there is currently only one such model - this option is hence only useful for future releases) + - \b vm/model: specify the model for virtual machines (there is currently only one such model - this option is hence only useful for future releases) %As of writing, the following network models are accepted. Over the time new models can be added, and some experimental models can be @@ -118,28 +118,26 @@ If you compiled SimGrid accordingly, you can use packet-level network simulators as network models (see \ref pls). In that case, you have two extra models, described below, and some \ref options_pls "specific additional configuration flags". - - \b GTNets: Network pseudo-model using the GTNets simulator instead - of an analytic model - \b NS3: Network pseudo-model using the NS3 tcp model instead of an analytic model Concerning the CPU, we have only one model for now: - \b Cas01: Simplistic CPU model (time=size/power) -The workstation concept is the aggregation of a CPU with a network +The host concept is the aggregation of a CPU with a network card. Three models exists, but actually, only 2 of them are interesting. The "compound" one is simply due to the way our internal code is organized, and can easily be ignored. So at the end, you have -two workstation models: The default one allows to aggregate an +two host models: The default one allows to aggregate an existing CPU model with an existing network model, but does not allow parallel tasks because these beasts need some collaboration between the network and CPU model. That is why, ptask_07 is used by default when using SimDag. - - \b default: Default workstation model. Currently, CPU:Cas01 and + - \b default: Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled) - - \b compound: Workstation model that is automatically chosen if + - \b compound: Host model that is automatically chosen if you change the network and CPU models - - \b ptask_L07: Workstation model somehow similar to Cas01+CM02 but + - \b ptask_L07: Host model somehow similar to Cas01+CM02 but allowing parallel tasks \subsection options_generic_plugin Plugins @@ -254,7 +252,7 @@ deployment of processes on nodes. \subsubsection options_model_network_crosstraffic Simulating cross-traffic -%As of SimGrid v3.7, cross-traffic effects can be taken into account in +As of SimGrid v3.7, cross-traffic effects can be taken into account in analytical simulations. It means that ongoing and incoming communication flows are treated independently. In addition, the LV08 model adds 0.05 of usage on the opposite direction for each new @@ -263,12 +261,12 @@ phenomena such as ack compression. For that to work, your platform must have two links for each pair of interconnected hosts. An example of usable platform is -available in examples/msg/gtnets/crosstraffic-p.xml. +available in examples/platforms/crosstraffic.xml. This is activated through the \b network/crosstraffic item, that can be set to 0 (disable this feature) or 1 (enable it). -Note that with the default workstation model this option is activated by default. +Note that with the default host model this option is activated by default. \subsubsection options_model_network_coord Coordinated-based network models @@ -316,19 +314,12 @@ corresponding to the ns3::TcpL4Protocol::SocketType configuration item in NS3. The only valid values (enforced on the SimGrid side) are 'NewReno' or 'Reno' or 'Tahoe'. -When using GTNeTS, two items exist: - - \b gtnets/jitter, that is a double value to oscillate - the link latency, uniformly in random interval - [-latency*gtnets_jitter,latency*gtnets_jitter). It defaults to 0. - - \b gtnets/jitter_seed, the positive seed used to reproduce jitted - results. Its value must be in [1,1e8] and defaults to 10. - \section options_modelchecking Configuring the Model-Checking -To enable the experimental SimGrid model-checking support the program should -be executed with the command line argument +To enable the SimGrid model-checking support the program should +be executed using the simgrid-mc wrapper: \verbatim ---cfg=model-check:1 +simgrid-mc ./my_program \endverbatim Safety properties are expressed as assertions using the function @@ -347,10 +338,6 @@ ltl2ba program. --cfg=model-check/property: \endverbatim -Of course, specifying a liveness property enables the model-checking -so that you don't have to give --cfg=model-check:1 in -addition. - \subsection options_modelchecking_steps Going for stateful verification By default, the system is backtracked to its initial state to explore @@ -368,9 +355,6 @@ setting for your specific system. --cfg=model-check/checkpoint:1 \endverbatim -Of course, specifying this option enables the model-checking so that -you don't have to give --cfg=model-check:1 in addition. - \subsection options_modelchecking_reduction Specifying the kind of reduction The main issue when using the model-checking is the state space @@ -391,10 +375,6 @@ For now, this configuration variable can take 2 values: * dpor: Apply Dynamic Partial Ordering Reduction. Only valid if you verify local safety properties. -Of course, specifying a reduction technique enables the model-checking -so that you don't have to give --cfg=model-check:1 in -addition. - \subsection options_modelchecking_visited model-check/visited, Cycle detection In order to detect cycles, the model-checker needs to check if a new explored @@ -1079,8 +1059,7 @@ silently overflow on other parts of the memory. - \c exception/cutpath: \ref options_exception_cutpath -- \c gtnets/jitter: \ref options_pls -- \c gtnets/jitter_seed: \ref options_pls +- \c host/model: \ref options_model_select - \c maxmin/precision: \ref options_model_precision @@ -1146,8 +1125,7 @@ silently overflow on other parts of the memory. - \c storage/model: \ref options_storage_model - \c verbose-exit: \ref options_generic_exit -- \c vm_workstation/model: \ref options_vm_workstation_model -- \c workstation/model: \ref options_model_select +- \c vm/model: \ref options_vm_model \subsection options_index_smpi_coll Index of SMPI collective algorithms options