X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a33903f0993a2bd3e7a426314de93fb20b0a6172..808e3788e31d306aa2d3f8c96122aa82346fbe0b:/examples/s4u/README.rst diff --git a/examples/s4u/README.rst b/examples/s4u/README.rst index 350d07361c..f11fc88fc1 100644 --- a/examples/s4u/README.rst +++ b/examples/s4u/README.rst @@ -80,6 +80,10 @@ Starting and Stoping Actors Inter-Actors Interactions ------------------------- +See also the examples on :ref:`inter-actors communications +` and the ones on :ref:`classical +synchronization objects `. + - **Suspend and Resume actors:** Actors can be suspended and resumed during their executions. @@ -149,6 +153,8 @@ also the tesh files in the example directories for details. Activities: what Actors do ========================== +.. _s4u_ex_communication: + Communications on the Network ----------------------------- @@ -216,14 +222,18 @@ Executions on the CPU These objects are convenient abstractions of parallel computational kernels that span over several machines, such as a PDGEM and the other ScaLAPACK routines. Note that this only works - with the "ptask_L07" host model (`--cfg=host/model:ptask_L07`). + with the "ptask_L07" host model (``--cfg=host/model:ptask_L07``). |br| `examples/s4u/exec-ptask/s4u-exec-ptask.cpp `_ - **Using Pstates on a host:** - Shows how define a set of pstatesfor a host in the XML, and how the current - pstate can be accessed/changed with :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`. - |br| `examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp `_ - |br| `examples/platforms/energy_platform.xml `_ + `examples/platforms/energy_platform.xml `_ + shows how define a set of pstates in the XML. The current pstate + of an host can then be accessed and changed from the program. + + - |cpp| `examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp `_ + :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`. + - |py| `examples/python/exec-dvfs/exec-dvfs.py `_ + :py:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`. I/O on Disks and Files ---------------------- @@ -252,6 +262,8 @@ result in short reads and short write, as in reality. i.e. when the accessed disk is not mounted on the caller's host. |br| `examples/s4u/io-file-remote/s4u-io-file-remote.cpp `_ +.. _s4u_ex_IPC: + Classical synchronization objects --------------------------------- @@ -295,7 +307,7 @@ Interacting with the Platform resources must be turned off and on again, and how to react to such failures in your code. - |br| `examples/platforms/small_platform_with_failure.xml `_ + |br| `examples/platforms/small_platform_failures.xml `_ |br| The state profiles in `examples/platforms/profiles `_ - **Specifying speed profiles:** shows how to specify an external @@ -394,7 +406,34 @@ Distributed Hash Tables (DHT) One of the most famous DHT protocol. |br| `examples/s4u/dht-chord/s4u-dht-chord.cpp `_ -.. TODO:: document here the examples about plugins +.. _s4u_ex_clouds: + +Simulating Clouds +----------------- + + - **Cloud basics** + This example starts some computations both on PMs and VMs, and + migrates some VMs around. + |br| `examples/s4u/cloud-simple/s4u-cloud-simple.cpp `_ + +.. TODO:: document here the examples about clouds and plugins + +======================= +Model-Checking Examples +======================= + +The model-checker can be used to exhaustively search for issues in the +tested application. It must be activated at compile time, but this +mode is rather experimental in SimGrid (as of v3.22). You should not +enable it unless you really want to formally verify your applications: +SimGrid is slower and maybe less robust when MC is enabled. + + - **Failing assert** + In this example, two actors send some data to a central server, + which asserts that the messages are always received in the same order. + This is obviously wrong, and the model-checker correctly finds a + counter-example to that assertion. + |br| `examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp `_ .. |br| raw:: html