X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f36ac042c3394375a24b20517a96cdf4885da31e..e3560cbe27d64b283e070ca750eb88471fa7f0bb:/examples/README.rst diff --git a/examples/README.rst b/examples/README.rst index 9348665e59..57925db8fd 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -119,6 +119,10 @@ Starting and Stoping Actors This demonstrates the ``start_time`` and ``kill_time`` attribute of the :ref:`pf_tag_actor` tag. + .. example-tab:: examples/c/actor-lifetime/actor-lifetime.c + + This file is not really interesting: the important matter is in the XML file. + - **Daemonize actors:** Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular actor into a daemon that will be automatically killed once the simulation is over. @@ -137,6 +141,17 @@ Starting and Stoping Actors See also :cpp:func:`sg_actor_daemonize` and :cpp:func:`sg_actor_is_daemon`. + - **Specify the stack size to use** + The stack size can be specified by default on the command line, + globally by changing the configuration with :cpp:func:`simgrid::s4u::Engine::set_config(std::string)`, + or for a specific actor using :cpp:func:`simgrid::s4u::Actor::set_stacksize` before its start. + + .. tabs:: + + .. example-tab:: examples/s4u/actor-stacksize/s4u-actor-stacksize.cpp + + .. example-tab:: examples/c/actor-stacksize/actor-stacksize.c + Inter-Actors Interactions ------------------------- @@ -278,6 +293,10 @@ Communications on the Network See also :py:func:`simgrid.Mailbox.put_async()` and :py:func:`simgrid.Comm.wait()`. + .. example-tab:: examples/c/async-wait/async-wait.c + + See also :cpp:func:`sg_mailbox_put_async()` and :cpp:func:`sg_comm__wait()`. + - **Waiting for all communications in a set:** The ``wait_all()`` function is useful when you want to block until all activities in a given set have completed. @@ -292,6 +311,10 @@ Communications on the Network See also :py:func:`simgrid.Comm.wait_all()`. + .. example-tab:: examples/c/async-waitall/async-waitall.c + + See also :cpp:func:`sg_comm_wait_all()`. + - **Waiting for the first completed communication in a set:** The ``wait_any()`` function is useful when you want to block until one activity of the set completes, no @@ -334,6 +357,11 @@ Executions on the CPU See also :py:func:`simgrid.this_actor.execute()`. + .. example-tab:: examples/c/exec-basic/exec-basic.c + + See also :cpp:func:`void sg_actor_execute(double)` + and :cpp:func:`void sg_actor_execute_with_priority(double, double)`. + - **Asynchronous execution:** You can start asynchronous executions, just like you would fire background threads. @@ -359,7 +387,17 @@ Executions on the CPU :py:func:`simgrid.Exec.get_remaining_ratio()`, :py:func:`simgrid.this_actor.exec_async()` and :py:func:`simgrid.Activity.cancel()`. - + + .. example-tab:: examples/c/exec-async/exec-async.c + + See also :cpp:func:`sg_actor_exec_init()`, + :cpp:func:`sg_exec_start()`, + :cpp:func:`sg_exec_wait()`, + :cpp:func:`sg_exec_get_remaining()`, + :cpp:func:`sg_exec_get_remaining_ratio()`, + :cpp:func:`sg_actor_exec_async()` and + :cpp:func:`sg_exec_cancel()`, + - **Remote execution:** You can start executions on remote hosts, or even change the host on which they occur during their execution. @@ -374,6 +412,10 @@ Executions on the CPU See also :py:func:`simgrid.Exec.set_host()`. + .. example-tab:: examples/c/exec-remote/exec-remote.c + + See also :cpp:func:`sg_exec_set_host()`. + - **Parallel executions:** These objects are convenient abstractions of parallel computational kernels that span over several machines, such as a @@ -396,6 +438,10 @@ Executions on the CPU See also :cpp:func:`simgrid::s4u::Host::get_pstate_speed` and :cpp:func:`simgrid::s4u::Host::set_pstate`. + .. example-tab:: examples/c/exec-dvfs/exec-dvfs.c + + See also :cpp:func:`sg_host_get_pstate_speed` and :cpp:func:`sg_host_set_pstate`. + .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py See also :py:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`. @@ -446,6 +492,8 @@ result in short reads and short write, as in reality. .. example-tab:: examples/s4u/io-file-remote/s4u-io-file-remote.cpp + .. example-tab:: examples/c/io-file-remote/io-file-remote.c + .. _s4u_ex_IPC: Classical synchronization objects @@ -499,6 +547,13 @@ Interacting with the Platform - :cpp:func:`simgrid::s4u::Link::get_property()` and :cpp:func:`simgrid::s4u::Link::set_property()` - :cpp:func:`simgrid::s4u::NetZone::get_property()` and :cpp:func:`simgrid::s4u::NetZone::set_property()` + .. example-tab:: examples/c/platform-properties/platform-properties.c + + - :cpp:func:`sg_actor_get_property()` and :cpp:func:`sg_actor_set_property()` + - :cpp:func:`sg_host_get_property()` and :cpp:func:sg_host_set_property()` + - :cpp:func:`sg_link_get_property()` and :cpp:func:`sg_link_set_property()` + - :cpp:func:`sg_link_get_property()` and :cpp:func:`sg_link_set_property()` + .. group-tab:: XML **Deployment file:** @@ -699,6 +754,17 @@ Data diffusion .. example-tab:: examples/s4u/app-chainsend/s4u-app-chainsend.cpp + .. group-tab:: C + + .. showfile:: examples/c/app-chainsend/chainsend.c + :language: c + + .. showfile:: examples/c/app-chainsend/broadcaster.c + :language: c + + .. showfile:: examples/c/app-chainsend/peer.c + :language: c + Distributed Hash Tables (DHT) ----------------------------- @@ -747,6 +813,8 @@ Simulating Clouds .. example-tab:: examples/s4u/cloud-simple/s4u-cloud-simple.cpp + .. example-tab:: examples/c/cloud-simple/cloud-simple.c + - **Migrating VMs** This example shows how to migrate VMs between PMs. @@ -754,6 +822,8 @@ Simulating Clouds .. example-tab:: examples/s4u/cloud-migration/s4u-cloud-migration.cpp + .. example-tab:: examples/c/cloud-migration/cloud-migration.c + ======================= Model-Checking Examples =======================