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 SimGrid comes with an extensive set of examples, documented on this
  17 page. Most of them only demonstrate one single feature, with some
  18 larger examplars listed below.
  19
  20 Each of these examples can be found in a subdirectory under
  21 examples/s4u in the archive. It contains the source code (also listed
  22 from this page), and the so-called tesh file containing how to call
  23 the binary obtained by compiling this example and also the expected
  24 output. Tesh files are used to turn each of our examples into an
  25 integration test. Some examples also contain other files, on need.
  26
  27 A good way to bootstrap your own project is to copy and combine some
  28 of the provided examples to constitute the skeleton of what you plan
  29 to simulate.
  30
  31   - @ref s4u_ex_actors
  32     - @ref s4u_ex_actors_start
  33     - @ref s4u_ex_actors_synchro
  34     - @ref s4u_ex_actors_replay
  35   - @ref s4u_ex_activities
  36     - @ref s4u_ex_activity_comm
  37     - @ref s4u_ex_activity_exec
  38     - @ref s4u_ex_activity_io
  39     - @ref s4u_ex_activity_synchro
  40   - @ref s4u_ex_platf
  41   - @ref s4u_ex_energy
  42   - @ref s4u_ex_tracing
  43   - @ref s4u_ex_app
  44     - @ref s4u_ex_app_data
  45     - @ref s4u_ex_app_dht
  46
  47 TODO: document here the examples about plugins
  48
  49 @section s4u_ex_actors Actors: the active entities
  50
  51 @subsection s4u_ex_actors_start Starting and stoping actors
  52
  53   - <b>Creating actors</b>.
  54     @ref examples/s4u/actor-create/s4u-actor-create.cpp \n
  55     Most actors are started from the deployment XML file, but there is other methods.
  56     This example show them all.
  57
  58   - <b>Kill actors</b>.
  59     @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
  60     Actors can forcefully stop other actors with the @ref
  61     simgrid::s4u::Actor::kill() method.
  62
  63   - <b>Controling the actor life cycle from the XML</b>.
  64     @ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
  65     @ref examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
  66     \n
  67     You can specify a start time and a kill time in the deployment file.
  68
  69   - <b>Daemonize actors</b>
  70     @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n
  71     Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
  72     actor into a daemon that will be automatically killed once the simulation is over.
  73
  74 @subsection s4u_ex_actors_synchro Inter-actors interactions
  75
  76   - <b>Suspend and Resume actors</b>.
  77     @ref examples/s4u/actor-suspend/s4u-actor-suspend.cpp \n
  78     Actors can be suspended and resumed during their executions
  79     thanks to the @ref simgrid::s4u::Actor::suspend and @ref simgrid::s4u::Actor::resume methods.
  80
  81   - <b>Migrating Actors</b>.
  82     @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
  83     Actors can move or be moved from a host to another with the @ref
  84     simgrid::s4u::this_actor::migrate() method.
  85
  86   - <b>Waiting for the termination of an actor</b> (joining on it)
  87     @ref examples/s4u/actor-join/s4u-actor-join.cpp \n
  88     The simgrid::s4u::Actor::join() method allows to block the current
  89     actor until the end of the receiving actor.
  90
  91   - <b>Yielding to other actor</b>.
  92     @ref examples/s4u/actor-yield/s4u-actor-yield.cpp\n
  93     The simgrid::s4u::this_actor::yield() function interrupts the
  94     execution of the current actor, leaving a chance to the other actors
  95     that are ready to run at this timestamp.
  96
  97 @subsection s4u_ex_actors_replay Traces Replay as a Workload
  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/replay-comm/s4u-replay-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/replay-storage/s4u-replay-storage.cpp \n
 122     Presents a set of event handlers reproducing classical I/O
 123     primitives (open, read, close).
 124
 125 @section s4u_ex_activities Activities: the things that Actors do
 126
 127 @subsection s4u_ex_activity_comm Communications on the network
 128
 129  - <b>Basic asynchronous communications</b>.
 130    @ref examples/s4u/async-wait/s4u-async-wait.cpp \n
 131    Illustrates how to have non-blocking communications, that are
 132    communications running in the background leaving the process free
 133    to do something else during their completion. The main functions
 134    involved are @ref simgrid::s4u::Mailbox::put_async and
 135    @ref simgrid::s4u::Comm::wait().
 136
 137  - <b>Waiting for all communications in a set</b>.
 138    @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n
 139    The @ref simgrid::s4u::Comm::wait_all() function is useful when you want to block
 140    until all activities in a given set have completed.
 141
 142  - <b>Waiting for the first completed communication in a set</b>.
 143    @ref examples/s4u/async-waitany/s4u-async-waitany.cpp\n
 144    The @ref simgrid::s4u::Comm::wait_any() function is useful when you want to block
 145    until one activity of the set completes, no matter which terminates
 146    first.
 147
 148 @subsection s4u_ex_activity_exec Executions on the CPU
 149
 150   - <b>Basic execution</b>.
 151     @ref examples/s4u/exec-basic/s4u-exec-basic.cpp \n
 152     The computations done in your program are not reported to the
 153     simulated world, unless you explicitely request the simulator to pause
 154     the actor until a given amount of flops gets computed on its simulated
 155     host. Some executions can be given an higher priority so that they
 156     get more resources.
 157
 158   - <b>Asynchronous execution</b>.
 159     @ref examples/s4u/exec-async/s4u-exec-async.cpp \n
 160     You can start asynchronous executions, just like you would fire
 161     background threads.
 162
 163   - <b>Monitoring asynchronous executions</b>.
 164     @ref examples/s4u/exec-monitor/s4u-exec-monitor.cpp \n
 165     This example shows how to start an asynchronous execution, and
 166     monitor its status.
 167
 168   - <b>Remote execution</b>.
 169     @ref examples/s4u/exec-remote/s4u-exec-remote.cpp \n
 170     Before its start, you can change the host on which a given execution will occur.
 171
 172   - <b>Using Pstates on a host</b>
 173     @ref examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp and
 174     @ref examples/platforms/energy_platform.xml \n
 175     Show how define a set of pstatesfor a host in the XML, and how the current
 176     pstate can be accessed/changed with @ref simgrid::s4u::Host::getPstateSpeed and @ref simgrid::s4u::Host::setPstate.
 177
 178   TODO: add an example about parallel executions.
 179
 180 @subsection s4u_ex_activity_io I/O on disks and files
 181
 182 SimGrid provides two levels of abstraction to interact with the
 183 simulated storages. At the simplest level, you simply create read and
 184 write actions on the storage resources.
 185
 186   - <b>Access to raw storage devices</b>.
 187     @ref examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp \n
 188     This example illustrates how to simply read and write data on a
 189     simulated storage resource.
 190
 191 The FileSystem plugin provides a more detailed view, with the
 192 classical operations over files: open, move, unlink, and of course
 193 read and write. The file and disk sizes are also dealt with and can
 194 result in short reads and short write, as in reality.
 195
 196   - <b>File Management</b>. @ref examples/s4u/io-file-system/s4u-io-file-system.cpp \n
 197     This example illustrates the use of operations on files
 198     (read, write, seek, tell, unlink, ...).
 199
 200   - <b>Remote I/O</b>.
 201     @ref examples/s4u/io-file-remote/s4u-io-file-remote.cpp \n
 202     I/O operations on files can also be done in a remote fashion,
 203     i.e. when the accessed disk is not mounted on the caller's host.
 204
 205 @subsection s4u_ex_activity_synchro Classical synchronization objects
 206
 207  - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n
 208    Shows how to use simgrid::s4u::Mutex synchronization objects.
 209
 210 @section s4u_ex_platf Interacting with the platform
 211
 212  - <b>User-defined properties</b>.
 213    @ref examples/s4u/platform-properties/s4u-platform-properties.cpp and
 214    @ref examples/s4u/platform-properties/s4u-platform-properties_d.xml and
 215    @ref examples/platforms/prop.xml \n
 216    You can attach arbitrary information to most platform elements from
 217    the XML file, and then interact with these values from your
 218    program. Note that the changes are not written into the XML file: they
 219    will only last until the end of your simulation.
 220    - simgrid::s4u::Actor::getProperty() and simgrid::s4u::Actor::setProperty()
 221    - simgrid::s4u::Host::getProperty() and simgrid::s4u::Host::setProperty()
 222    - simgrid::s4u::Link::getProperty() and simgrid::s4u::Link::setProperty()
 223    - simgrid::s4u::NetZone::getProperty() and simgrid::s4u::NetZone::setProperty()
 224
 225 @section s4u_ex_energy Simulating the energy consumption
 226
 227   - <b>Consumption due to the CPU</b>
 228     @ref examples/s4u/energy-exec/s4u-energy-exec.cpp \n
 229     This example shows how to retrieve the amount of energy consumed
 230     by the CPU during computations, and the impact of the pstate.
 231
 232 @section s4u_ex_tracing Tracing and visualization features
 233
 234 Tracing can be activated by various configuration options which
 235 are illustrated in these example. See also the
 236 @ref tracing_tracing_options "full list of options related to tracing".
 237
 238 It is interesting to run the process-create example with the following
 239 options to see the task executions:
 240
 241   - <b>Platform tracing</b>.
 242     @ref examples/s4u/trace-platform/s4u-trace-platform.cpp \n
 243     This program is a toy example just loading the platform, so that
 244     you can play with the platform visualization. Recommanded options:
 245     @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes
 246     @endverbatim
 247
 248 @section s4u_ex_app Larger SimGrid examplars
 249
 250 This section contains application examples that are somewhat larger
 251 than the previous examples.
 252
 253   - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.cpp\n
 254     This simple example just sends one message back and forth.
 255     The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
 256     the simulators (as detailed in Section \ref options).
 257
 258   - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp \n
 259     Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
 260     participant.
 261
 262   - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworker.cpp \n
 263     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
 264     processes.
 265
 266 @subsection s4u_ex_app_data Data diffusion
 267
 268   - <b>Bit Torrent</b>
 269     @ref examples/s4u/app-bittorrent/s4u-app-bittorrent.cpp\n
 270     Classical protocol for Peer-to-Peer data diffusion.
 271
 272   - <b>Chained send</b>
 273     @ref examples/s4u/app-chainsend/s4u-app-chainsend.cpp\n
 274     Data broadcast over a ring of processes.
 275
 276 @subsection s4u_ex_app_dht Distributed Hash Tables (DHT)
 277
 278   - <b>Chord Protocol</b>
 279     @ref examples/s4u/app-chord/s4u-app-chord.cpp\n
 280     One of the most famous DHT protocol.
 281
 282 */
 283
 284 /**
 285 @example examples/s4u/actor-create/s4u-actor-create.cpp
 286 @example examples/s4u/actor-create/s4u-actor-create_d.xml
 287 @example examples/s4u/actor-daemon/s4u-actor-daemon.cpp
 288 @example examples/s4u/actor-join/s4u-actor-join.cpp
 289 @example examples/s4u/actor-kill/s4u-actor-kill.cpp
 290 @example examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
 291 @example examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
 292 @example examples/s4u/actor-migration/s4u-actor-migration.cpp
 293 @example examples/s4u/actor-suspend/s4u-actor-suspend.cpp
 294 @example examples/s4u/actor-yield/s4u-actor-yield.cpp
 295 @example examples/s4u/async-wait/s4u-async-wait.cpp
 296 @example examples/s4u/async-waitall/s4u-async-waitall.cpp
 297 @example examples/s4u/async-waitany/s4u-async-waitany.cpp
 298 @example examples/s4u/exec-basic/s4u-exec-basic.cpp
 299 @example examples/s4u/exec-async/s4u-exec-async.cpp
 300 @example examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
 301 @example examples/s4u/exec-monitor/s4u-exec-monitor.cpp
 302 @example examples/s4u/exec-remote/s4u-exec-remote.cpp
 303 @example examples/s4u/app-bittorrent/s4u-app-bittorrent.cpp
 304 @example examples/s4u/app-chainsend/s4u-app-chainsend.cpp
 305 @example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
 306 @example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
 307 @example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
 308 @example examples/s4u/energy-exec/s4u-energy-exec.cpp
 309 @example examples/s4u/io-file-system/s4u-io-file-system.cpp
 310 @example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
 311 @example examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp
 312 @example examples/s4u/mutex/s4u-mutex.cpp
 313 @example examples/s4u/platform-properties/s4u-platform-properties.cpp
 314 @example examples/s4u/platform-properties/s4u-platform-properties_d.xml
 315 @example examples/s4u/replay-comm/s4u-replay-comm.cpp
 316 @example examples/s4u/replay-storage/s4u-replay-storage.cpp
 317 @example examples/s4u/trace-platform/s4u-trace-platform.cpp
 318 @example examples/platforms/energy_platform.xml
 319 @example examples/platforms/prop.xml
 320
 321 */