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 the 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_activities
  18     - @ref s4u_ex_activity_comm
  19     - @ref s4u_ex_activity_exec
  20     - @ref s4u_ex_activity_io
  21   - @ref s4u_ex_actors
  22     - @ref s4u_ex_actors_start
  23     - @ref s4u_ex_actors_synchro
  24     - @ref s4u_ex_actors_replay
  25   - @ref s4u_ex_synchro
  26   - @ref s4u_ex_platf
  27   - @ref s4u_ex_energy
  28
  29 TODO: document here the examples about plugins
  30
  31 @section s4u_ex_basics Basics of SimGrid simulation
  32
  33   - <b>Creating actors:</b> @ref examples/s4u/actor-create/s4u-actor-create.cpp and
  34     @ref examples/s4u/actor-create/s4u-actor-create_d.xml \n
  35     Shows how to start your actors to populate your simulation.
  36
  37   - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.cpp\n
  38     This simple example just sends one message back and forth.
  39     The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
  40     the simulators (as detailed in Section \ref options).
  41
  42   - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp \n
  43     Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
  44     participant.
  45
  46   - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworker.cpp \n
  47     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
  48     processes.
  49
  50 @section s4u_ex_activities Activities that consume Resources (communications, executions and disks)
  51
  52 @subsection s4u_ex_activity_comm Communications (using the network)
  53
  54  - <b>Basic asynchronous communications</b>.
  55    @ref examples/s4u/async-wait/s4u-async-wait.cpp \n
  56    Illustrates how to have non-blocking communications, that are
  57    communications running in the background leaving the process free
  58    to do something else during their completion. The main functions
  59    involved are @ref simgrid::s4u::Mailbox::put_async and
  60    @ref simgrid::s4u::Comm::wait().
  61
  62  - <b>Waiting for all communications in a set</b>.
  63    @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n
  64    The @ref simgrid::s4u::Comm::wait_all() function is useful when you want to block
  65    until all activities in a given set have completed.
  66
  67  - <b>Waiting for the first completed communication in a set</b>.
  68    @ref examples/s4u/async-waitany/s4u-async-waitany.cpp\n
  69    The @ref simgrid::s4u::Comm::wait_any() function is useful when you want to block
  70    until one activity of the set completes, no matter which terminates
  71    first.
  72
  73 @subsection s4u_ex_activity_exec Executions (using the CPU)
  74
  75   - <b>Basic execution</b>.
  76     @ref examples/s4u/exec-basic/s4u-exec-basic.cpp \n
  77     The computations done in your program are not reported to the
  78     simulated world, unless you explicitely request the simulator to pause
  79     the actor until a given amount of flops gets computed on its simulated
  80     host. Some executions can be given an higher priority so that they
  81     get more resources.
  82
  83   - <b>Asynchronous execution</b>.
  84     @ref examples/s4u/exec-async/s4u-exec-async.cpp \n
  85     You can start asynchronous executions, just like you would fire
  86     background threads.
  87
  88   - <b>Monitoring asynchronous executions</b>.
  89     @ref examples/s4u/exec-monitor/s4u-exec-monitor.cpp \n
  90     This example shows how to start an asynchronous execution, and
  91     monitor its status.
  92
  93   - <b>Remote execution</b>.
  94     @ref examples/s4u/exec-remote/s4u-exec-remote.cpp \n
  95     Before its start, you can change the host on which a given execution will occur.
  96
  97   - <b>Using Pstates on a host</b>
  98     @ref examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp and
  99     @ref examples/platforms/energy_platform.xml \n
 100     Show how define a set of pstatesfor a host in the XML, and how the current
 101     pstate can be accessed/changed with @ref simgrid::s4u::Host::getPstateSpeed and @ref simgrid::s4u::Host::setPstate.
 102
 103   TODO: add an example about parallel executions.
 104
 105 @subsection s4u_ex_activity_io I/O (using disks and files)
 106
 107 SimGrid provides two levels of abstraction to interact with the
 108 simulated storages. At the simplest level, you simply create read and
 109 write actions on the storage resources.
 110
 111   - <b>Access to raw storage devices</b>.
 112     @ref examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp \n
 113     This example illustrates how to simply read and write data on a
 114     simulated storage resource.
 115
 116 The FileSystem plugin provides a more detailed view, with the
 117 classical operations over files: open, move, unlink, and of course
 118 read and write. The file and disk sizes are also dealt with and can
 119 result in short reads and short write, as in reality.
 120
 121   - <b>File Management</b>. @ref examples/s4u/io-file-system/s4u-io-file-system.cpp \n
 122     This example illustrates the use of operations on files
 123     (read, write, seek, tell, unlink, ...).
 124
 125   - <b>Remote I/O</b>.
 126     @ref examples/s4u/io-file-remote/s4u-io-file-remote.cpp \n
 127     I/O operations on files can also be done in a remote fashion,
 128     i.e. when the accessed disk is not mounted on the caller's host.
 129
 130 @section s4u_ex_actors Acting on Actors
 131
 132 @subsection s4u_ex_actors_start Starting and stoping actors
 133
 134   - <b>Creating actors</b>.
 135     @ref examples/s4u/actor-create/s4u-actor-create.cpp \n
 136     Most actors are started from the deployment XML file, but there is other methods.
 137     This example show them all.
 138
 139   - <b>Kill actors</b>.
 140     @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
 141     Actors can forcefully stop other actors with the @ref
 142     simgrid::s4u::Actor::kill() method.
 143
 144   - <b>Controling the actor life cycle from the XML</b>.
 145     @ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
 146     @ref examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
 147     \n
 148     You can specify a start time and a kill time in the deployment file.
 149
 150   - <b>Daemonize actors</b>
 151     @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n
 152     Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
 153     actor into a daemon that will be automatically killed once the simulation is over.
 154
 155 @subsection s4u_ex_actors_synchro Inter-actors interactions
 156
 157   - <b>Suspend and Resume actors</b>.
 158     @ref examples/s4u/actor-suspend/s4u-actor-suspend.cpp \n
 159     Actors can be suspended and resumed during their executions
 160     thanks to the @ref simgrid::s4u::Actor::suspend and @ref simgrid::s4u::Actor::resume methods.
 161
 162   - <b>Migrating Actors</b>.
 163     @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
 164     Actors can move or be moved from a host to another with the @ref
 165     simgrid::s4u::this_actor::migrate() method.
 166
 167   - <b>Waiting for the termination of an actor</b> (joining on it)
 168     @ref examples/s4u/actor-join/s4u-actor-join.cpp \n
 169     The simgrid::s4u::Actor::join() method allows to block the current
 170     actor until the end of the receiving actor.
 171
 172   - <b>Yielding to other actor</b>.
 173     @ref examples/s4u/actor-yield/s4u-actor-yield.cpp\n
 174     The simgrid::s4u::this_actor::yield() function interrupts the
 175     execution of the current actor, leaving a chance to the other actors
 176     that are ready to run at this timestamp.
 177
 178 @subsection s4u_ex_actors_replay Traces Replay as a Workload
 179
 180 This section details how to run trace-driven simulations. It is very
 181 handy when you want to test an algorithm or protocol that only react
 182 to external events. For example, many P2P protocols react to user
 183 requests, but do nothing if there is no such event.
 184
 185 In such situations, you should write your protocol in C++, and separate
 186 the workload that you want to play onto your protocol in a separate
 187 text file. Declare a function handling each type of the events in your
 188 trace, register them using @ref xbt_replay_action_register in your
 189 main, and then run the simulation.
 190
 191 Then, you can either have one trace file containing all your events,
 192 or a file per simulated process: the former may be easier to work
 193 with, but the second is more efficient on very large traces. Check
 194 also the tesh files in the example directories for details.
 195
 196   - <b>Communication replay</b>.
 197     @ref examples/s4u/actions-comm/s4u-actions-comm.cpp \n
 198     Presents a set of event handlers reproducing classical communication
 199     primitives (asynchronous send/receive at the moment).
 200
 201   - <b>I/O replay</b>.
 202     @ref examples/s4u/actions-storage/s4u-actions-storage.cpp \n
 203     Presents a set of event handlers reproducing classical I/O
 204     primitives (open, read, close).
 205
 206 @section s4u_ex_synchro Classical synchronization objects
 207
 208  - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n
 209    Shows how to use simgrid::s4u::Mutex synchronization objects.
 210
 211 @section s4u_ex_platf Interacting with the platform
 212
 213  - <b>User-defined properties</b>.
 214    @ref examples/s4u/platform-properties/s4u-platform-properties.cpp and
 215    @ref examples/s4u/platform-properties/s4u-platform-properties_d.xml and
 216    @ref examples/platforms/prop.xml \n
 217    You can attach arbitrary information to most platform elements from
 218    the XML file, and then interact with these values from your
 219    program. Note that the changes are not written into the XML file: they
 220    will only last until the end of your simulation.
 221    - simgrid::s4u::Actor::getProperty() and simgrid::s4u::Actor::setProperty()
 222    - simgrid::s4u::Host::getProperty() and simgrid::s4u::Host::setProperty()
 223    - simgrid::s4u::Link::getProperty() and simgrid::s4u::Link::setProperty()
 224    - simgrid::s4u::NetZone::getProperty() and simgrid::s4u::NetZone::setProperty()
 225
 226
 227 @section s4u_ex_energy Simulating the energy consumption
 228
 229   - <b>Consumption due to the CPU</b>
 230     @ref examples/s4u/energy-exec/s4u-energy-exec.cpp \n
 231     This example shows how to retrieve the amount of energy consumed
 232     by the CPU during computations, and the impact of the pstate.
 233
 234 */
 235
 236 /**
 237 @example examples/s4u/actions-comm/s4u-actions-comm.cpp
 238 @example examples/s4u/actions-storage/s4u-actions-storage.cpp
 239 @example examples/s4u/actor-create/s4u-actor-create.cpp
 240 @example examples/s4u/actor-create/s4u-actor-create_d.xml
 241 @example examples/s4u/actor-daemon/s4u-actor-daemon.cpp
 242 @example examples/s4u/actor-join/s4u-actor-join.cpp
 243 @example examples/s4u/actor-kill/s4u-actor-kill.cpp
 244 @example examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
 245 @example examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
 246 @example examples/s4u/actor-migration/s4u-actor-migration.cpp
 247 @example examples/s4u/actor-suspend/s4u-actor-suspend.cpp
 248 @example examples/s4u/actor-yield/s4u-actor-yield.cpp
 249 @example examples/s4u/async-wait/s4u-async-wait.cpp
 250 @example examples/s4u/async-waitall/s4u-async-waitall.cpp
 251 @example examples/s4u/async-waitany/s4u-async-waitany.cpp
 252 @example examples/s4u/exec-basic/s4u-exec-basic.cpp
 253 @example examples/s4u/exec-async/s4u-exec-async.cpp
 254 @example examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
 255 @example examples/s4u/exec-monitor/s4u-exec-monitor.cpp
 256 @example examples/s4u/exec-remote/s4u-exec-remote.cpp
 257 @example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
 258 @example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
 259 @example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
 260 @example examples/s4u/energy-exec/s4u-energy-exec.cpp
 261 @example examples/s4u/io-file-system/s4u-io-file-system.cpp
 262 @example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
 263 @example examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp
 264 @example examples/s4u/mutex/s4u-mutex.cpp
 265 @example examples/s4u/platform-properties/s4u-platform-properties.cpp
 266 @example examples/s4u/platform-properties/s4u-platform-properties_d.xml
 267 @example examples/platforms/energy_platform.xml
 268 @example examples/platforms/prop.xml
 269
 270 */