@section s4u_ex_basics Basics of SimGrid simulation
- - <b>Creating actors:</b> @ref examples/s4u/actor-create/s4u_actor-create.cpp and
- @ref examples/s4u/actor-create/s4u_actor-create_d.xml \n
+ - <b>Creating actors:</b> @ref examples/s4u/actor-create/s4u-actor-create.cpp and
+ @ref examples/s4u/actor-create/s4u-actor-create_d.xml \n
Shows how to start your actors to populate your simulation.
- - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u_app-pingpong.c\n
- It's hard to think of a simpler example: it is just sending one message back and forth.
- The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
- the simulators (as detailed in Section \ref options).
+ - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.cpp\n
+ This simple example just sends one message back and forth.
+ The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
+ the simulators (as detailed in Section \ref options).
- - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n
+ - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp \n
Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
participant.
- - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u_app-masterworker.cpp \n
+ - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworker.cpp \n
Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
processes.
-@section msg_ex_async Asynchronous communications
+@section s4u_ex_async Asynchronous communications
+
+ - <b>Basic asynchronous communications</b>.
+ @ref examples/s4u/async-wait/s4u-async-wait.cpp \n
+ Illustrates how to have non-blocking communications, that are
+ communications running in the background leaving the process free
+ to do something else during their completion. The main functions
+ involved are @ref simgrid::s4u::Comm::put_async and
+ @ref simgrid::s4u::Comm::wait().
- <b>Waiting for all communications in a set</b>.
- @ref examples/s4u/async-waitall/s4u_async-waitall.cpp\n
+ @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n
The @ref simgrid::s4u::Comm::wait_all() function is useful when you want to block
until all activities in a given set have completed.
- <b>Waiting for the first completed communication in a set</b>.
- @ref examples/s4u/async-waitany/s4u_async-waitany.cpp\n
+ @ref examples/s4u/async-waitany/s4u-async-waitany.cpp\n
The @ref simgrid::s4u::Comm::wait_any() function is useful when you want to block
until one activity of the set completes, no matter which terminates
- first.
+ first.
@section s4u_ex_actors Acting on Actors
- <b>Creating actors</b>.
- @ref examples/s4u/actor-create/s4u_actor-create.cpp \n
+ @ref examples/s4u/actor-create/s4u-actor-create.cpp \n
Most actors are started from the deployment XML file, but they exist other methods.
+ - <b>Actors using CPU time</b>.
+ @ref examples/s4u/actor-execute/s4u-actor-execute.cpp \n
+ The computations done in your program are not reported to the
+ simulated world, unless you explicitely request the simulator to pause
+ the actor until a given amount of flops gets computed on its simulated
+ host.
+
- <b>Daemonize actors</b>
- @ref examples/s4u/actor-daemon/s4u_actor-daemon.cpp \n
+ @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n
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.
- <b>Suspend and Resume actors</b>.
- @ref examples/s4u/actor-suspend/s4u_actor-suspend.cpp \n
+ @ref examples/s4u/actor-suspend/s4u-actor-suspend.cpp \n
Actors can be suspended and resumed during their executions
thanks to the @ref suspend and @ref resume methods.
+ - <b>Priority actors</b>.
+ @ref examples/s4u/actor-priority/s4u-actor-priority.cpp \n
+ Actors can be launched according their priorities thanks to the @ref
+ execution method.
+
- <b>Kill actors</b>.
- @ref examples/s4u/actor-kill/s4u_actor-kill.cpp \n
+ @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
Actors can forcefully stop other actors with the @ref kill method.
+ - <b>Controling the actor life cycle from the XML</b>.
+ @ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
+ @ref examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
+ \n
+ You can specify a start time and a kill time in the deployment file.
+
- <b>Migrating Actors</b>.
- @ref examples/s4u/actor-migration/s4u_actor-migration.cpp \n
+ @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
Actors can move or be moved from a host to another with the @ref migrate method.
+ - <b>Yielding to other actor</b>.
+ @ref examples/s4u/actor-yield/s4u-actor-yield.c\n
+ The simgrid::s4u::this_actor::yield() function interrupts the
+ execution of the current actor, leaving a chance to the other actors
+ that are ready to run at this timestamp.
+
@section s4u_ex_synchro Inter-Actor Synchronization
- - <b>Mutex: </b> @ref examples/s4u/mutex/s4u_mutex.cpp \n
+ - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n
Shows how to use simgrid::s4u::Mutex synchronization objects.
@section s4u_ex_actions Following Workload Traces
also the tesh files in the example directories for details.
- <b>Communication replay</b>.
- @ref examples/s4u/actions-comm/s4u_actions-comm.cpp \n
+ @ref examples/s4u/actions-comm/s4u-actions-comm.cpp \n
Presents a set of event handlers reproducing classical communication
primitives (asynchronous send/receive at the moment).
- <b>I/O replay</b>.
- @ref examples/s4u/actions-storage/s4u_actions-storage.cpp \n
+ @ref examples/s4u/actions-storage/s4u-actions-storage.cpp \n
Presents a set of event handlers reproducing classical I/O
primitives (open, read, close).
+@subsection s4u_ex_io Simulating disks and files
+
+The examples of this section demonstrate how to interact with the
+simulated storages.
+
+ - <b>Access to raw storage devices </b>.
+ @ref examples/s4u/io-raw-storage/s4u-io-raw-storage.cpp \n
+ This example illustrates how to simply read and write data on a
+ simulated storage resource.
+
+ - <b>Remote I/O</b>.
+ @ref examples/s4u/io-file-remote/s4u-io-file-remote.cpp \n
+ I/O operations on files can also be done in a remote fashion,
+ i.e. when the accessed disk is not mounted on the caller's host.
+
*/
/**
-@example examples/s4u/actions-comm/s4u_actions-comm.cpp
-@example examples/s4u/actions-storage/s4u_actions-storage.cpp
-@example examples/s4u/actor-create/s4u_actor-create.cpp
-@example examples/s4u/actor-create/s4u_actor-create_d.xml
-@example examples/s4u/actor-daemon/s4u_actor-daemon.cpp
-@example examples/s4u/actor-kill/s4u_actor-kill.cpp
-@example examples/s4u/actor-migration/s4u_actor-migration.cpp
-@example examples/s4u/actor-suspend/s4u_actor-suspend.cpp
-@example examples/s4u/app-token-ring/s4u_app-token-ring.cpp
-@example examples/s4u/app-masterworker/s4u_app-masterworker.cpp
-@example examples/s4u/app-pingpong/s4u_app-pingpong.cpp
-
-@example examples/s4u/mutex/s4u_mutex.cpp
+@example examples/s4u/actions-comm/s4u-actions-comm.cpp
+@example examples/s4u/actions-storage/s4u-actions-storage.cpp
+@example examples/s4u/actor-create/s4u-actor-create.cpp
+@example examples/s4u/actor-create/s4u-actor-create_d.xml
+@example examples/s4u/actor-daemon/s4u-actor-daemon.cpp
+@example examples/s4u/actor-execute/s4u-actor-execute.cpp
+@example examples/s4u/actor-kill/s4u-actor-kill.cpp
+@example examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
+@example examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
+@example examples/s4u/actor-migration/s4u-actor-migration.cpp
+@example examples/s4u/actor-suspend/s4u-actor-suspend.cpp
+@example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
+@example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
+@example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
+@example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
+@example examples/s4u/io-raw-storage/s4u-io-raw-storage.cpp
+@example examples/s4u/mutex/s4u-mutex.cpp
*/
\ No newline at end of file
