examples/s4u/README.doc

   1 S4U (Simgrid for you) is the next interface of SimGrid, expected to be released with SimGrid 4.0.
   2
   3 Even if it is not completely rock stable yet, it may well already fit
   4 your needs. You are welcome to try it and report any interface
   5 glitches that you see. Be however warned that the interface may change
   6 until its final release.  You will have to adapt your code on the way.
   7
   8 This file follows the Doxygen syntax to be included in the
   9 documentation, but it should remain readable directly.
  10
  11 /**
  12  @defgroup s4u_examples S4U examples
  13  @ingroup s4u_api
  14  @brief Find the S4U example fitting your needs in the archive.
  15
  16   - @ref s4u_ex_basics
  17   - @ref s4u_ex_async
  18   - @ref s4u_ex_actors
  19   - @ref s4u_ex_synchro
  20   - @ref s4u_ex_actions
  21
  22 @section s4u_ex_basics Basics of SimGrid simulation
  23
  24   - <b>Creating actors:</b> @ref examples/s4u/actor-create/s4u-actor-create.cpp and
  25     @ref examples/s4u/actor-create/s4u-actor-create_d.xml \n
  26     Shows how to start your actors to populate your simulation.
  27
  28   - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.c\n
  29    It's hard to think of a simpler example: it is just sending one message back and forth.
  30    The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
  31    the simulators (as detailed in Section \ref options).
  32
  33   - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp \n
  34     Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
  35     participant.
  36
  37   - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworker.cpp \n
  38     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
  39     processes.
  40
  41 @section msg_ex_async Asynchronous communications
  42
  43  - <b>Basic asynchronous communications</b>.
  44    @ref examples/s4u/async-wait/s4u-async-wait.cpp \n
  45    Illustrates how to have non-blocking communications, that are
  46    communications running in the background leaving the process free
  47    to do something else during their completion. The main functions
  48    involved are @ref simgrid::s4u::Comm::put_async and
  49    @ref simgrid::s4u::Comm::wait().
  50
  51  - <b>Waiting for all communications in a set</b>.
  52    @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n
  53    The @ref simgrid::s4u::Comm::wait_all() function is useful when you want to block
  54    until all activities in a given set have completed.
  55
  56  - <b>Waiting for the first completed communication in a set</b>.
  57    @ref examples/s4u/async-waitany/s4u-async-waitany.cpp\n
  58    The @ref simgrid::s4u::Comm::wait_any() function is useful when you want to block
  59    until one activity of the set completes, no matter which terminates
  60    first.
  61
  62 @section s4u_ex_actors Acting on Actors
  63
  64   - <b>Creating actors</b>.
  65     @ref examples/s4u/actor-create/s4u-actor-create.cpp \n
  66     Most actors are started from the deployment XML file, but they exist other methods.
  67
  68   - <b>Daemonize actors</b>
  69     @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n
  70     Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
  71     actor into a daemon that will be automatically killed once the simulation is over.
  72
  73   - <b>Suspend and Resume actors</b>.
  74     @ref examples/s4u/actor-suspend/s4u-actor-suspend.cpp \n
  75     Actors can be suspended and resumed during their executions
  76     thanks to the @ref suspend and @ref resume methods.
  77
  78   - <b>Kill actors</b>.
  79     @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
  80     Actors can forcefully stop other actors with the @ref kill method.
  81
  82   - <b>Migrating Actors</b>.
  83     @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
  84     Actors can move or be moved from a host to another with the @ref migrate method.
  85
  86   - <b>Yielding to other actor</b>.
  87     @ref examples/s4u/actor-yield/s4u-actor-yield.c\n
  88     The @ref yield function interrupts the execution of the
  89     current actor, leaving a chance to run to the other actor
  90     that are ready to run at the exact same timestamp
  91
  92 @section s4u_ex_synchro Inter-Actor Synchronization
  93
  94  - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n
  95    Shows how to use simgrid::s4u::Mutex synchronization objects.
  96
  97 @section s4u_ex_actions Following Workload Traces
  98
  99 This section details how to run trace-driven simulations. It is very
 100 handy when you want to test an algorithm or protocol that only react
 101 to external events. For example, many P2P protocols react to user
 102 requests, but do nothing if there is no such event.
 103
 104 In such situations, you should write your protocol in C++, and separate
 105 the workload that you want to play onto your protocol in a separate
 106 text file. Declare a function handling each type of the events in your
 107 trace, register them using @ref xbt_replay_action_register in your
 108 main, and then run the simulation.
 109
 110 Then, you can either have one trace file containing all your events,
 111 or a file per simulated process: the former may be easier to work
 112 with, but the second is more efficient on very large traces. Check
 113 also the tesh files in the example directories for details.
 114
 115   - <b>Communication replay</b>.
 116     @ref examples/s4u/actions-comm/s4u-actions-comm.cpp \n
 117     Presents a set of event handlers reproducing classical communication
 118     primitives (asynchronous send/receive at the moment).
 119
 120   - <b>I/O replay</b>.
 121     @ref examples/s4u/actions-storage/s4u-actions-storage.cpp \n
 122     Presents a set of event handlers reproducing classical I/O
 123     primitives (open, read, close).
 124
 125 */
 126
 127 /**
 128 @example examples/s4u/actions-comm/s4u-actions-comm.cpp
 129 @example examples/s4u/actions-storage/s4u-actions-storage.cpp
 130 @example examples/s4u/actor-create/s4u-actor-create.cpp
 131 @example examples/s4u/actor-create/s4u-actor-create_d.xml
 132 @example examples/s4u/actor-daemon/s4u-actor-daemon.cpp
 133 @example examples/s4u/actor-kill/s4u-actor-kill.cpp
 134 @example examples/s4u/actor-migration/s4u-actor-migration.cpp
 135 @example examples/s4u/actor-suspend/s4u-actor-suspend.cpp
 136 @example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
 137 @example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
 138 @example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
 139
 140 @example examples/s4u/mutex/s4u-mutex.cpp
 141
 142 */