X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a3d08dd00246eb26ced68c5b0e046096706bbe23..c6a73d1a81c7adda1795366a1d3d3c44b7008b8a:/examples/s4u/README.doc diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc index 6e14a5ed7f..f626d7ec70 100644 --- a/examples/s4u/README.doc +++ b/examples/s4u/README.doc @@ -21,63 +21,95 @@ documentation, but it should remain readable directly. @section s4u_ex_basics Basics of SimGrid simulation - - Creating actors: @ref examples/s4u/actor-create/s4u_actor-create.cpp and - @ref examples/s4u/actor-create/s4u_actor-create_d.xml \n + - Creating actors: @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. - - Ping Pong: @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). + - Ping Pong: @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). - - Token ring: @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n + - Token ring: @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. - - Master Workers: @ref examples/s4u/app-masterworker/s4u_app-masterworker.cpp \n + - Master Workers: @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 + + - Basic asynchronous communications. + @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(). - Waiting for all communications in a set. - @ref examples/s4u/async-waitall/s4u_async-waitall.cpp\n - The @ref S4U_comm_waitall function is useful when you want to block + @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. - Waiting for the first completed communication in a set. - @ref examples/s4u/async-waitany/s4u_async-waitany.cpp\n - The @ref S4U_comm_waitany function is useful when you want to block + @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 - Creating actors. - @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. + - Actors using CPU time. + @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. + - Daemonize actors - @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. - Suspend and Resume actors. - @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. + - Priority actors. + @ref examples/s4u/actor-priority/s4u-actor-priority.cpp \n + Actors can be launched according their priorities thanks to the @ref + execution method. + - Kill actors. - @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. + - Controling the actor life cycle from the XML. + @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. + - Migrating Actors. - @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. + - Yielding to other actor. + @ref examples/s4u/actor-yield/s4u-actor-yield.c\n + The @ref yield function interrupts the execution of the + current actor, leaving a chance to run to the other actor + that are ready to run at the exact same timestamp + @section s4u_ex_synchro Inter-Actor Synchronization - - Mutex: @ref examples/s4u/mutex/s4u_mutex.cpp \n + - Mutex: @ref examples/s4u/mutex/s4u-mutex.cpp \n Shows how to use simgrid::s4u::Mutex synchronization objects. @section s4u_ex_actions Following Workload Traces @@ -99,30 +131,33 @@ with, but the second is more efficient on very large traces. Check also the tesh files in the example directories for details. - Communication replay. - @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). - I/O replay. - @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). */ /** -@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/mutex/s4u-mutex.cpp */ \ No newline at end of file