X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b5c4dc09a3fe6f8c146beb7034d5054db3a71816..5fda94ac3d246037758dab959b3dfc9a071ccc26:/examples/README.rst diff --git a/examples/README.rst b/examples/README.rst index 3e6f6cefc5..0ae9e5065b 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -28,12 +28,12 @@ to simulate. Actors: the Active Entities =========================== -Starting and Stoping Actors +Starting and Stopping Actors --------------------------- - **Creating actors:** Most actors are started from the deployment XML file, because this - is a :ref:`better scientific habbit `, but you can + is a :ref:`better scientific habit `, but you can also create them directly from your code. .. tabs:: @@ -106,7 +106,7 @@ Starting and Stoping Actors See also :cpp:func:`sg_actor_kill`, :cpp:func:`sg_actor_kill_all`, :cpp:func:`sg_actor_exit`, :cpp:func:`sg_actor_on_exit`. - - **Controling the actor life cycle from the XML:** + - **Controlling the actor life cycle from the XML:** You can specify a start time and a kill time in the deployment file. .. tabs:: @@ -119,7 +119,11 @@ 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 + .. example-tab:: examples/python/actor-lifetime/actor-lifetime.py + + This file is not really interesting: the important matter is in the XML file. + + .. example-tab:: examples/c/actor-lifetime/actor-lifetime.c This file is not really interesting: the important matter is in the XML file. @@ -141,6 +145,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 ------------------------- @@ -376,7 +391,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. @@ -391,6 +416,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 @@ -522,6 +551,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:** @@ -557,6 +593,8 @@ Interacting with the Platform .. example-tab:: examples/s4u/platform-failures/s4u-platform-failures.cpp + .. example-tab:: examples/c/platform-failures/platform-failures.c + .. group-tab:: XML .. showfile:: examples/platforms/small_platform_failures.xml @@ -641,7 +679,7 @@ options to see the task executions: - **Platform Tracing:** This program is a toy example just loading the platform, so that - you can play with the platform visualization. Recommanded options: + you can play with the platform visualization. Recommended options: ``--cfg=tracing:yes --cfg=tracing/categorized:yes`` .. tabs:: @@ -695,6 +733,11 @@ than the previous examples. .. showfile:: examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp :language: cpp + + .. group-tab:: C + + .. showfile:: examples/c/app-masterworker/app-masterworker.c + :language: cpp Data diffusion -------------- @@ -715,6 +758,17 @@ Data diffusion .. showfile:: examples/s4u/app-bittorrent/s4u-tracker.cpp :language: cpp + .. group-tab:: C + + .. showfile:: examples/c/app-bittorrent/app-bittorrent.c + :language: cpp + + .. showfile:: examples/c/app-bittorrent/bittorrent-peer.c + :language: cpp + + .. showfile:: examples/c/app-bittorrent/tracker.c + :language: cpp + - **Chained Send:** Data broadcast over a ring of processes. @@ -768,6 +822,23 @@ Distributed Hash Tables (DHT) .. showfile:: examples/s4u/dht-kademlia/node.cpp :language: cpp + .. group-tab:: C + + .. showfile:: examples/c/dht-kademlia/dht-kademlia.c + :language: cpp + + .. showfile:: examples/c/dht-kademlia/routing_table.c + :language: cpp + + .. showfile:: examples/c/dht-kademlia/answer.c + :language: cpp + + .. showfile:: examples/c/dht-kademlia/message.c + :language: cpp + + .. showfile:: examples/c/dht-kademlia/node.c + :language: cpp + .. _s4u_ex_clouds: Simulating Clouds @@ -792,6 +863,29 @@ Simulating Clouds .. example-tab:: examples/c/cloud-migration/cloud-migration.c +======================= +Model-Related Examples +======================= + + - **ns-3 as a SimGrid Network Model** + This simple ping-pong example demonstrates how to use the bindings to the Network + Simulator. The most interesting is probably not the C++ files since + they are unchanged from the other simulations, but the associated files, + such as the platform file to see how to declare a platform to be used + with the ns-3 bindings of SimGrid and the tesh file to see how to actually + start a simulation in these settings. + + .. tabs:: + + .. example-tab:: examples/s4u/network-ns3/s4u-network-ns3.cpp + + .. group-tab:: XML + + **Platform files:** + + .. showfile:: examples/platforms/small_platform_one_link_routes.xml + :language: xml + ======================= Model-Checking Examples =======================